Module::getCurrentRouteName() - Code Metrics - Inspection of "Add console commands for the Routing component" - noiselabs/zf-debug-utils - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2820f4...076502 )

by Vítor

created 2016-07-22 17:15 UTC

Module::getCurrentRouteName() A

↳ Parent: Module

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	11
ccs	5
cts	5
cp	1
rs	9.4285
cc	2
eloc	5
nc	2
nop	1
crap	2

<?php
/**
 * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
 *
 * @license http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright 2016 Vítor Brandão <[email protected]>
 */

namespace Noiselabs\ZfDebugModule;

use Zend\Console\Adapter\AdapterInterface as Console;
use Zend\EventManager\EventInterface;
use Zend\ModuleManager\Feature\BootstrapListenerInterface;
use Zend\ModuleManager\Feature\ConfigProviderInterface;
use Zend\ModuleManager\Feature\ConsoleBannerProviderInterface;
use Zend\ModuleManager\Feature\ConsoleUsageProviderInterface;
use Zend\ModuleManager\Feature\InitProviderInterface;
use Zend\ModuleManager\ModuleManagerInterface;
use Zend\Mvc\MvcEvent;
use Zend\Mvc\Router\RouteInterface;
use Zend\Mvc\Router\RouteMatch;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\Stdlib\RequestInterface;

/**
 * ZfDebug Module.
 *
 * @author Vítor Brandão <[email protected]>
 */
class Module implements BootstrapListenerInterface, ConfigProviderInterface, ConsoleBannerProviderInterface,

    ConsoleUsageProviderInterface, InitProviderInterface

{
    const DEFAULT_LAYOUT = 'noiselabs/zf-debug-utils/layout';

    /**
     * {@inheritdoc}
     */
    public function init(ModuleManagerInterface $manager)
    {
        $manager->loadModule('AssetManager');
    }

    /**
     * {@inheritdoc}
     */
    public function getConfig()
    {
        return require __DIR__ . '/Resources/config/module.config.php';
    }

    /**
     * Listen to the bootstrap event.
     *
     * @param EventInterface|MvcEvent $e
     *
     * @return array|void
     */
    public function onBootstrap(EventInterface $e)
    {
        if (!$e instanceof MvcEvent) {
            return;
        }

        $currentRouteName = $this->getCurrentRouteName($e->getApplication()->getServiceManager());
        $e->getViewModel()->setVariables(['__currentRouteName' => $currentRouteName]);
    }

    /**
     * {@inheritdoc}
     *
     * @param Console $console
     *
     * @return string
     */
    public function getConsoleBanner(Console $console)
    {
        return sprintf('%s v%s', Package::NAME, Package::VERSION);
    }

    /**
     * @param Console $console
     *
     * @return array
     */
    public function getConsoleUsage(Console $console)
    {
        return [
            '[ Routing ]',
            '',
            'zfdebug routes export' => 'Exports all routes in CSV format',
            'zfdebug routes list' => 'Lists all routes',
            'zfdebug routes match [METHOD] [URL]' => 'Matches a URL to a Route',
            ['Examples:'],
            ['$ zfdebug routes export', ''],
            ['$ zfdebug routes list', ''],
            ['$ zfdebug routes match GET /users/123', ''],
            ['$ zfdebug routes match POST /login', ''],
        ];
    }

    /**
     * @param ServiceLocatorInterface $serviceLocator
     *
     * @return null|string
     */
    private function getCurrentRouteName(ServiceLocatorInterface $serviceLocator)
    {
        /** @var RouteInterface $router */
        $router = $serviceLocator->get('router');
        /** @var RequestInterface $request */
        $request = $serviceLocator->get('request');
        /** @var RouteMatch|null $matchedRoute */
        $matchedRoute = $router->match($request);

        return ($matchedRoute instanceof RouteMatch) ? $matchedRoute->getMatchedRouteName() : null;
    }
}


1		<?php
2		/**
3		* ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
4		*
5		* @license http://www.opensource.org/licenses/mit-license.html MIT License
6		* @copyright 2016 Vítor Brandão <[email protected]>
7		*/
8
9		namespace Noiselabs\ZfDebugModule;
10
11		use Zend\Console\Adapter\AdapterInterface as Console;
12		use Zend\EventManager\EventInterface;
13		use Zend\ModuleManager\Feature\BootstrapListenerInterface;
14		use Zend\ModuleManager\Feature\ConfigProviderInterface;
15		use Zend\ModuleManager\Feature\ConsoleBannerProviderInterface;
16		use Zend\ModuleManager\Feature\ConsoleUsageProviderInterface;
17		use Zend\ModuleManager\Feature\InitProviderInterface;
18		use Zend\ModuleManager\ModuleManagerInterface;
19		use Zend\Mvc\MvcEvent;
20		use Zend\Mvc\Router\RouteInterface;
21		use Zend\Mvc\Router\RouteMatch;
22		use Zend\ServiceManager\ServiceLocatorInterface;
23		use Zend\Stdlib\RequestInterface;
24
25		/**
26		* ZfDebug Module.
27		*
28		* @author Vítor Brandão <[email protected]>
29		*/
30		class Module implements BootstrapListenerInterface, ConfigProviderInterface, ConsoleBannerProviderInterface,
		0 ignored issues – show Coding Style introduced 2016-07-22 17:32 UTC by Report Bug Copy Issue Report The first item in a multi-line implements list must be on the line following the implements keyword Loading history... Coding Style introduced 2016-07-22 17:32 UTC by Report Bug Copy Issue Report Only one interface may be specified per line in a multi-line implements declaration Loading history...
31		ConsoleUsageProviderInterface, InitProviderInterface
		0 ignored issues – show Coding Style introduced 2016-07-22 17:32 UTC by Report Bug Copy Issue Report Only one interface may be specified per line in a multi-line implements declaration Loading history...
32		{
33		const DEFAULT_LAYOUT = 'noiselabs/zf-debug-utils/layout';
34
35		/**
36		* {@inheritdoc}
37		*/
38	10	public function init(ModuleManagerInterface $manager)
39		{
40	10	$manager->loadModule('AssetManager');
41	10	}
42
43		/**
44		* {@inheritdoc}
45		*/
46	11	public function getConfig()
47		{
48	11	return require __DIR__ . '/Resources/config/module.config.php';
49		}
50
51		/**
52		* Listen to the bootstrap event.
53		*
54		* @param EventInterface\|MvcEvent $e
55		*
56		* @return array\|void
57		*/
58	11	public function onBootstrap(EventInterface $e)
59		{
60	11	if (!$e instanceof MvcEvent) {
61	1	return;
62		}
63
64	10	$currentRouteName = $this->getCurrentRouteName($e->getApplication()->getServiceManager());
65	10	$e->getViewModel()->setVariables(['__currentRouteName' => $currentRouteName]);
66	10	}
67
68		/**
69		* {@inheritdoc}
70		*
71		* @param Console $console
72		*
73		* @return string
74		*/
75	1	public function getConsoleBanner(Console $console)
76		{
77	1	return sprintf('%s v%s', Package::NAME, Package::VERSION);
78		}
79
80		/**
81		* @param Console $console
82		*
83		* @return array
84		*/
85	1	public function getConsoleUsage(Console $console)
86		{
87		return [
88	1	'[ Routing ]',
89	1	'',
90	1	'zfdebug routes export' => 'Exports all routes in CSV format',
91	1	'zfdebug routes list' => 'Lists all routes',
92	1	'zfdebug routes match [METHOD] [URL]' => 'Matches a URL to a Route',
93	1	['Examples:'],
94	1	['$ zfdebug routes export', ''],
95	1	['$ zfdebug routes list', ''],
96	1	['$ zfdebug routes match GET /users/123', ''],
97	1	['$ zfdebug routes match POST /login', ''],
98	1	];
99		}
100
101		/**
102		* @param ServiceLocatorInterface $serviceLocator
103		*
104		* @return null\|string
105		*/
106	10	private function getCurrentRouteName(ServiceLocatorInterface $serviceLocator)
107		{
108		/** @var RouteInterface $router */
109	10	$router = $serviceLocator->get('router');
110		/** @var RequestInterface $request */
111	10	$request = $serviceLocator->get('request');
112		/** @var RouteMatch\|null $matchedRoute */
113	10	$matchedRoute = $router->match($request);
114
115	10	return ($matchedRoute instanceof RouteMatch) ? $matchedRoute->getMatchedRouteName() : null;
116		}
117		}
118

noiselabs / zf-debug-utils

Push — master ( 2820f4...076502 )

Module::getCurrentRouteName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like