RouteCollection::add() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/3.x'" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( acb828...319569 )

by Grégoire

created 2018-11-11 09:25 UTC

RouteCollection::add() B

↳ Parent: RouteCollection

Complexity

Conditions	7
Paths	20

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	37
rs	8.3946
c	0
b	0
f	0
cc	7
nc	20
nop	9

How to fix Many Parameters

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Route;

use Symfony\Component\Routing\Route;

/**
 * @author Thomas Rabaix <[email protected]>
 */
class RouteCollection
{
    /**
     * @var Route[]
     */
    protected $elements = [];

    /**
     * @var string
     */
    protected $baseCodeRoute;

    /**
     * @var string
     */
    protected $baseRouteName;

    /**
     * @var string
     */
    protected $baseControllerName;

    /**
     * @var string
     */
    protected $baseRoutePattern;

    /**
     * @param string $baseCodeRoute
     * @param string $baseRouteName
     * @param string $baseRoutePattern
     * @param string $baseControllerName
     */
    public function __construct($baseCodeRoute, $baseRouteName, $baseRoutePattern, $baseControllerName)
    {
        $this->baseCodeRoute = $baseCodeRoute;
        $this->baseRouteName = $baseRouteName;
        $this->baseRoutePattern = $baseRoutePattern;
        $this->baseControllerName = $baseControllerName;
    }

    /**
     * Add route.
     *
     * @param string $name
     * @param string $pattern   Pattern (will be automatically combined with @see $this->baseRoutePattern and $name
     * @param string $host
     * @param string $condition
     *
     * @return RouteCollection
     */
    public function add(
        $name,
        $pattern = null,
        array $defaults = [],
        array $requirements = [],
        array $options = [],
        $host = '',
        array $schemes = [],
        array $methods = [],
        $condition = ''
    ) {
        $pattern = $this->baseRoutePattern.'/'.($pattern ?: $name);
        $code = $this->getCode($name);
        $routeName = $this->baseRouteName.'_'.$name;

        if (!isset($defaults['_controller'])) {
            $actionJoiner = false === \strpos($this->baseControllerName, '\\') ? ':' : '::';
            if (':' !== $actionJoiner && false !== \strpos($this->baseControllerName, ':')) {
                $actionJoiner = ':';
            }

            $defaults['_controller'] = $this->baseControllerName.$actionJoiner.$this->actionify($code);
        }

        if (!isset($defaults['_sonata_admin'])) {
            $defaults['_sonata_admin'] = $this->baseCodeRoute;
        }

        $defaults['_sonata_name'] = $routeName;

        $this->elements[$this->getCode($name)] = function () use (
            $pattern, $defaults, $requirements, $options, $host, $schemes, $methods, $condition) {
            return new Route($pattern, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
        };

        return $this;
    }

    /**
     * @param string $name
     *
     * @return string
     */
    public function getCode($name)
    {
        if (false !== strrpos($name, '.')) {
            return $name;
        }

        return $this->baseCodeRoute.'.'.$name;
    }

    /**
     * @return RouteCollection
     */
    public function addCollection(self $collection)
    {
        foreach ($collection->getElements() as $code => $route) {
            $this->elements[$code] = $route;
        }

        return $this;
    }

    /**
     * @return Route[]
     */
    public function getElements()
    {
        foreach ($this->elements as $name => $element) {
            $this->elements[$name] = $this->resolve($element);
        }

        return $this->elements;
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function has($name)
    {
        return array_key_exists($this->getCode($name), $this->elements);
    }

    /**
     * @param string $name
     *
     * @throws \InvalidArgumentException
     *
     * @return Route
     */
    public function get($name)
    {
        if ($this->has($name)) {
            $code = $this->getCode($name);

            $this->elements[$code] = $this->resolve($this->elements[$code]);

            return $this->elements[$code];
        }

        throw new \InvalidArgumentException(sprintf('Element "%s" does not exist.', $name));
    }

    /**
     * @param string $name
     *
     * @return RouteCollection
     */
    public function remove($name)
    {
        unset($this->elements[$this->getCode($name)]);

        return $this;
    }

    /**
     * Remove all routes except routes in $routeList.
     *
     * @param string[]|string $routeList
     *
     * @return RouteCollection
     */
    public function clearExcept($routeList)
    {
        if (!\is_array($routeList)) {
            $routeList = [$routeList];
        }

        $routeCodeList = [];
        foreach ($routeList as $name) {
            $routeCodeList[] = $this->getCode($name);
        }

        $elements = $this->elements;
        foreach ($elements as $key => $element) {
            if (!\in_array($key, $routeCodeList)) {
                unset($this->elements[$key]);
            }
        }

        return $this;
    }

    /**
     * Remove all routes.
     *
     * @return RouteCollection
     */
    public function clear()
    {
        $this->elements = [];

        return $this;
    }

    /**
     * Convert a word in to the format for a symfony action action_name => actionName.
     *
     * @param string $action Word to actionify
     *
     * @return string Actionified word
     */
    public function actionify($action)
    {
        if (false !== ($pos = strrpos($action, '.'))) {
            $action = substr($action, $pos + 1);
        }

        // if this is a service rather than just a controller name, the suffix
        // Action is not automatically appended to the method name
        if (false === strpos($this->baseControllerName, ':')) {
            $action .= 'Action';
        }

        return lcfirst(str_replace(' ', '', ucwords(strtr($action, '_-', '  '))));
    }

    /**
     * @return string
     */
    public function getBaseCodeRoute()
    {
        return $this->baseCodeRoute;
    }

    /**
     * @return string
     */
    public function getBaseControllerName()
    {
        return $this->baseControllerName;
    }

    /**
     * @return string
     */
    public function getBaseRouteName()
    {
        return $this->baseRouteName;
    }

    /**
     * @return string
     */
    public function getBaseRoutePattern()
    {
        return $this->baseRoutePattern;
    }

    /**
     * @return Route
     */
    private function resolve($element)
    {
        if (\is_callable($element)) {
            return \call_user_func($element);
        }

        return $element;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\AdminBundle\Route;
15
16			use Symfony\Component\Routing\Route;
17
18			/**
19			* @author Thomas Rabaix <[email protected]>
20			*/
21			class RouteCollection
22			{
23			/**
24			* @var Route[]
25			*/
26			protected $elements = [];
27
28			/**
29			* @var string
30			*/
31			protected $baseCodeRoute;
32
33			/**
34			* @var string
35			*/
36			protected $baseRouteName;
37
38			/**
39			* @var string
40			*/
41			protected $baseControllerName;
42
43			/**
44			* @var string
45			*/
46			protected $baseRoutePattern;
47
48			/**
49			* @param string $baseCodeRoute
50			* @param string $baseRouteName
51			* @param string $baseRoutePattern
52			* @param string $baseControllerName
53			*/
54			public function __construct($baseCodeRoute, $baseRouteName, $baseRoutePattern, $baseControllerName)
55			{
56			$this->baseCodeRoute = $baseCodeRoute;
57			$this->baseRouteName = $baseRouteName;
58			$this->baseRoutePattern = $baseRoutePattern;
59			$this->baseControllerName = $baseControllerName;
60			}
61
62			/**
63			* Add route.
64			*
65			* @param string $name
66			* @param string $pattern Pattern (will be automatically combined with @see $this->baseRoutePattern and $name
67			* @param string $host
68			* @param string $condition
69			*
70			* @return RouteCollection
71			*/
72			public function add(
73			$name,
74			$pattern = null,
75			array $defaults = [],
76			array $requirements = [],
77			array $options = [],
78			$host = '',
79			array $schemes = [],
80			array $methods = [],
81			$condition = ''
82			) {
83			$pattern = $this->baseRoutePattern.'/'.($pattern ?: $name);
84			$code = $this->getCode($name);
85			$routeName = $this->baseRouteName.'_'.$name;
86
87			if (!isset($defaults['_controller'])) {
88			$actionJoiner = false === \strpos($this->baseControllerName, '\\') ? ':' : '::';
89			if (':' !== $actionJoiner && false !== \strpos($this->baseControllerName, ':')) {
90			$actionJoiner = ':';
91			}
92
93			$defaults['_controller'] = $this->baseControllerName.$actionJoiner.$this->actionify($code);
94			}
95
96			if (!isset($defaults['_sonata_admin'])) {
97			$defaults['_sonata_admin'] = $this->baseCodeRoute;
98			}
99
100			$defaults['_sonata_name'] = $routeName;
101
102			$this->elements[$this->getCode($name)] = function () use (
103			$pattern, $defaults, $requirements, $options, $host, $schemes, $methods, $condition) {
104			return new Route($pattern, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
105			};
106
107			return $this;
108			}
109
110			/**
111			* @param string $name
112			*
113			* @return string
114			*/
115			public function getCode($name)
116			{
117			if (false !== strrpos($name, '.')) {
118			return $name;
119			}
120
121			return $this->baseCodeRoute.'.'.$name;
122			}
123
124			/**
125			* @return RouteCollection
126			*/
127			public function addCollection(self $collection)
128			{
129			foreach ($collection->getElements() as $code => $route) {
130			$this->elements[$code] = $route;
131			}
132
133			return $this;
134			}
135
136			/**
137			* @return Route[]
138			*/
139			public function getElements()
140			{
141			foreach ($this->elements as $name => $element) {
142			$this->elements[$name] = $this->resolve($element);
143			}
144
145			return $this->elements;
146			}
147
148			/**
149			* @param string $name
150			*
151			* @return bool
152			*/
153			public function has($name)
154			{
155			return array_key_exists($this->getCode($name), $this->elements);
156			}
157
158			/**
159			* @param string $name
160			*
161			* @throws \InvalidArgumentException
162			*
163			* @return Route
164			*/
165			public function get($name)
166			{
167			if ($this->has($name)) {
168			$code = $this->getCode($name);
169
170			$this->elements[$code] = $this->resolve($this->elements[$code]);
171
172			return $this->elements[$code];
173			}
174
175			throw new \InvalidArgumentException(sprintf('Element "%s" does not exist.', $name));
176			}
177
178			/**
179			* @param string $name
180			*
181			* @return RouteCollection
182			*/
183			public function remove($name)
184			{
185			unset($this->elements[$this->getCode($name)]);
186
187			return $this;
188			}
189
190			/**
191			* Remove all routes except routes in $routeList.
192			*
193			* @param string[]\|string $routeList
194			*
195			* @return RouteCollection
196			*/
197			public function clearExcept($routeList)
198			{
199			if (!\is_array($routeList)) {
200			$routeList = [$routeList];
201			}
202
203			$routeCodeList = [];
204			foreach ($routeList as $name) {
205			$routeCodeList[] = $this->getCode($name);
206			}
207
208			$elements = $this->elements;
209			foreach ($elements as $key => $element) {
210			if (!\in_array($key, $routeCodeList)) {
211			unset($this->elements[$key]);
212			}
213			}
214
215			return $this;
216			}
217
218			/**
219			* Remove all routes.
220			*
221			* @return RouteCollection
222			*/
223			public function clear()
224			{
225			$this->elements = [];
226
227			return $this;
228			}
229
230			/**
231			* Convert a word in to the format for a symfony action action_name => actionName.
232			*
233			* @param string $action Word to actionify
234			*
235			* @return string Actionified word
236			*/
237			public function actionify($action)
238			{
239			if (false !== ($pos = strrpos($action, '.'))) {
240			$action = substr($action, $pos + 1);
241			}
242
243			// if this is a service rather than just a controller name, the suffix
244			// Action is not automatically appended to the method name
245			if (false === strpos($this->baseControllerName, ':')) {
246			$action .= 'Action';
247			}
248
249			return lcfirst(str_replace(' ', '', ucwords(strtr($action, '_-', ' '))));
250			}
251
252			/**
253			* @return string
254			*/
255			public function getBaseCodeRoute()
256			{
257			return $this->baseCodeRoute;
258			}
259
260			/**
261			* @return string
262			*/
263			public function getBaseControllerName()
264			{
265			return $this->baseControllerName;
266			}
267
268			/**
269			* @return string
270			*/
271			public function getBaseRouteName()
272			{
273			return $this->baseRouteName;
274			}
275
276			/**
277			* @return string
278			*/
279			public function getBaseRoutePattern()
280			{
281			return $this->baseRoutePattern;
282			}
283
284			/**
285			* @return Route
286			*/
287			private function resolve($element)
288			{
289			if (\is_callable($element)) {
290			return \call_user_func($element);
291			}
292
293			return $element;
294			}
295			}
296

sonata-project / SonataAdminBundle

Push — master ( acb828...319569 )

RouteCollection::add() B

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like