LocalizedRouter::localizeUris() - Code Metrics - Inspection of "Webpack & UI" - AudithSoftworks/Basis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#45)

by Şəhriyar

created 2016-11-03 09:03 UTC

LocalizedRouter::localizeUris() B

↳ Parent: LocalizedRouter

Complexity

Conditions	6
Paths	15

Size

Total Lines	27
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	6.0073

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	27
ccs	16
cts	17
cp	0.9412
rs	8.439
cc	6
eloc	19
nc	15
nop	1
crap	6.0073

<?php namespace App\Services\Routing;

use Illuminate\Container\Container;
use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Routing\ControllerInspector;
use Illuminate\Routing\Router;

class LocalizedRouter extends Router
{
    /**
     * Create a new Router instance.
     *
     * @param  \Illuminate\Contracts\Events\Dispatcher $events
     * @param  \Illuminate\Container\Container         $container
     */
    public function __construct(Dispatcher $events, Container $container = null)
    {
        parent::__construct($events, $container);

        $this->routes = new LocalizedRouteCollection;
    }

    /**
     * Add a route to the underlying route collection.
     *
     * @param  array|string          $methods
     * @param  string                $uri
     * @param  \Closure|array|string $action
     *
     * @return \Illuminate\Routing\Route
     */
    protected function addRoute($methods, $uri, $action)
    {
        // Now we apply our Localization modifications.
        $uri = $this->localizeUris($uri);

        return parent::addRoute($methods, $uri, $action);
    }

    /**
     * Route a controller to a URI with wildcard routing.
     *
     * @param  string $uri
     * @param  string $controller
     * @param  array  $names
     *
     * @return void
     *
     * @deprecated since version 5.2.
     */
    public function controller($uri, $controller, $names = [])
    {
        $prepended = $controller;

        // First, we will check to see if a controller prefix has been registered in
        // the route group. If it has, we will need to prefix it before trying to
        // reflect into the class instance and pull out the method for routing.
        if (!empty($this->groupStack)) {
            $prepended = $this->prependGroupUses($controller);
        }

        $controllerInspector = new ControllerInspector;
        $routable = $controllerInspector->getRoutable($prepended, $uri);

        // Now we apply our Localization modifications.
        foreach ($routable as &$routes) {
            foreach ($routes as &$route) {
                $route['plain'] = $this->localizeUris($route['plain']);
                unset($route);
            }
            unset($routes);
        }

        // When a controller is routed using this method, we use Reflection to parse
        // out all of the routable methods for the controller, then register each
        // route explicitly for the developers, so reverse routing is possible.
        foreach ($routable as $method => $routes) {
            foreach ($routes as $route) {
                $this->registerInspected($route, $controller, $method, $names);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }
        }

        $this->addFallthroughRoute($controller, $uri);

    }

    /**
     * Route a resource to a controller.
     *
     * @param  string $name
     * @param  string $controller
     * @param  array  $options
     *
     * @return void
     */
    public function resource($name, $controller, array $options = [])
    {
        if ($this->container && $this->container->bound(LocalizedResourceRegistrar::class)) {
            $registrar = $this->container->make(LocalizedResourceRegistrar::class);
        } else {
            $registrar = new LocalizedResourceRegistrar($this);
        }

        $registrar->register($name, $controller, $options);
    }

    /**
     * Add a fallthrough route for a controller.
     *
     * @param  string $controller
     * @param  string $uri
     *
     * @return void
     *
     * @deprecated since version 5.2.
     */
    protected function addFallthroughRoute($controller, $uri)
    {
        $localizedUri = app('translator')->get('routes.' . $uri . '.');
        if (false !== strpos($localizedUri, '.')) {
            $localizedUri = $uri;
        }

        parent::addFallthroughRoute($controller, $localizedUri);
    }

    /**
     * @param string $uri
     *
     * @return string
     */
    private function localizeUris($uri)
    {
        $uriExploded = explode('/', trim($uri, '/'));
        $localizedUriTranslationBitParts = [];
        while (list($level, $bitName) = each($uriExploded)) {
            if ($level == 0) {
                $localizedUriTranslationBitParts[$level] = 'routes.' . $bitName . '.';
            } else {
                $localizedUriTranslationBitParts[$level] = trim($localizedUriTranslationBitParts[$level - 1], '.') . '.' . $bitName;
            }
        }
        foreach ($localizedUriTranslationBitParts as $level => &$translationBitPart) {
            $phraseToGetTranslationFor = $translationBitPart;
            if (preg_match('#(?<!routes)\.\{[^\}]+\}\.#', $translationBitPart)) { // For lower-level paths, in order not to hit 'routes.' index.
                $phraseToGetTranslationFor = preg_replace('#\{[^\}]+\}\.?#', '', $translationBitPart);
            }
            $translatedPhrase = app('translator')->get($phraseToGetTranslationFor);
            if (false !== strpos($translatedPhrase, '.')) {
                $translationBitPart = $uriExploded[$level];
            } else {
                $translationBitPart = $translatedPhrase;
            }
            unset($translationBitPart); // Delete the reference (won't delete the original).
        }

        return implode('/', $localizedUriTranslationBitParts);
    }
}


1		<?php namespace App\Services\Routing;
2
3		use Illuminate\Container\Container;
4		use Illuminate\Contracts\Events\Dispatcher;
5		use Illuminate\Routing\ControllerInspector;
6		use Illuminate\Routing\Router;
7
8		class LocalizedRouter extends Router
9		{
10		/**
11		* Create a new Router instance.
12		*
13		* @param \Illuminate\Contracts\Events\Dispatcher $events
14		* @param \Illuminate\Container\Container $container
15		*/
16	19	public function __construct(Dispatcher $events, Container $container = null)
17		{
18	19	parent::__construct($events, $container);
19
20	19	$this->routes = new LocalizedRouteCollection;
21	19	}
22
23		/**
24		* Add a route to the underlying route collection.
25		*
26		* @param array\|string $methods
27		* @param string $uri
28		* @param \Closure\|array\|string $action
29		*
30		* @return \Illuminate\Routing\Route
31		*/
32	19	protected function addRoute($methods, $uri, $action)
33		{
34		// Now we apply our Localization modifications.
35	19	$uri = $this->localizeUris($uri);
36
37	19	return parent::addRoute($methods, $uri, $action);
38		}
39
40		/**
41		* Route a controller to a URI with wildcard routing.
42		*
43		* @param string $uri
44		* @param string $controller
45		* @param array $names
46		*
47		* @return void
48		*
49		* @deprecated since version 5.2.
50		*/
51		public function controller($uri, $controller, $names = [])
52		{
53		$prepended = $controller;
54
55		// First, we will check to see if a controller prefix has been registered in
56		// the route group. If it has, we will need to prefix it before trying to
57		// reflect into the class instance and pull out the method for routing.
58		if (!empty($this->groupStack)) {
59		$prepended = $this->prependGroupUses($controller);
60		}
61
62		$controllerInspector = new ControllerInspector;
63		$routable = $controllerInspector->getRoutable($prepended, $uri);
64
65		// Now we apply our Localization modifications.
66		foreach ($routable as &$routes) {
67		foreach ($routes as &$route) {
68		$route['plain'] = $this->localizeUris($route['plain']);
69		unset($route);
70		}
71		unset($routes);
72		}
73
74		// When a controller is routed using this method, we use Reflection to parse
75		// out all of the routable methods for the controller, then register each
76		// route explicitly for the developers, so reverse routing is possible.
77		foreach ($routable as $method => $routes) {
78		foreach ($routes as $route) {
79		$this->registerInspected($route, $controller, $method, $names);
		0 ignored issues – show Documentation Bug introduced 2016-07-09 17:35 UTC by Report Bug Copy Issue Report The method `registerInspected` does not exist on `object<App\Services\Routing\LocalizedRouter>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
80		}
81		}
82
83		$this->addFallthroughRoute($controller, $uri);
		0 ignored issues – show Deprecated Code introduced 2016-01-26 14:52 UTC by Report Bug Copy Issue Report The method `App\Services\Routing\Loc...::addFallthroughRoute()` has been deprecated with message: since version 5.2. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
84		}
85
86		/**
87		* Route a resource to a controller.
88		*
89		* @param string $name
90		* @param string $controller
91		* @param array $options
92		*
93		* @return void
94		*/
95	19	public function resource($name, $controller, array $options = [])
96		{
97	19	if ($this->container && $this->container->bound(LocalizedResourceRegistrar::class)) {
98		$registrar = $this->container->make(LocalizedResourceRegistrar::class);
99		} else {
100	19	$registrar = new LocalizedResourceRegistrar($this);
101		}
102
103	19	$registrar->register($name, $controller, $options);
104	19	}
105
106		/**
107		* Add a fallthrough route for a controller.
108		*
109		* @param string $controller
110		* @param string $uri
111		*
112		* @return void
113		*
114		* @deprecated since version 5.2.
115		*/
116		protected function addFallthroughRoute($controller, $uri)
117		{
118		$localizedUri = app('translator')->get('routes.' . $uri . '.');
119		if (false !== strpos($localizedUri, '.')) {
120		$localizedUri = $uri;
121		}
122
123		parent::addFallthroughRoute($controller, $localizedUri);
124		}
125
126		/**
127		* @param string $uri
128		*
129		* @return string
130		*/
131	19	private function localizeUris($uri)
132		{
133	19	$uriExploded = explode('/', trim($uri, '/'));
134	19	$localizedUriTranslationBitParts = [];
135	19	while (list($level, $bitName) = each($uriExploded)) {
136	19	if ($level == 0) {
137	19	$localizedUriTranslationBitParts[$level] = 'routes.' . $bitName . '.';
138		} else {
139	19	$localizedUriTranslationBitParts[$level] = trim($localizedUriTranslationBitParts[$level - 1], '.') . '.' . $bitName;
140		}
141		}
142	19	foreach ($localizedUriTranslationBitParts as $level => &$translationBitPart) {
143	19	$phraseToGetTranslationFor = $translationBitPart;
144	19	if (preg_match('#(?<!routes)\.\{[^\}]+\}\.#', $translationBitPart)) { // For lower-level paths, in order not to hit 'routes.' index.
145		$phraseToGetTranslationFor = preg_replace('#\{[^\}]+\}\.?#', '', $translationBitPart);
146		}
147	19	$translatedPhrase = app('translator')->get($phraseToGetTranslationFor);
148	19	if (false !== strpos($translatedPhrase, '.')) {
149	19	$translationBitPart = $uriExploded[$level];
150		} else {
151	19	$translationBitPart = $translatedPhrase;
152		}
153	19	unset($translationBitPart); // Delete the reference (won't delete the original).
154		}
155
156	19	return implode('/', $localizedUriTranslationBitParts);
157		}
158		}
159

AudithSoftworks / Basis

Pull Request — master (#45)

LocalizedRouter::localizeUris() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like