DefaultRouteGenerator::generateMenuUrl() - Code Metrics - Inspection of "Add support for unlimited nested child admins. (#4..." - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.x ( f7534c...26d69b )

by Grégoire

created 2017-09-28 14:48 UTC

DefaultRouteGenerator::generateMenuUrl() C

↳ Parent: DefaultRouteGenerator

Complexity

Conditions	10
Paths	48

Size

Total Lines	49
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	49
rs	5.5471
c	0
b	0
f	0
cc	10
eloc	25
nc	48
nop	4

How to fix Complexity

<?php

/*
 * 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 Sonata\AdminBundle\Admin\AdminInterface;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Routing\RouterInterface;

/**
 * @author Thomas Rabaix <[email protected]>
 */
class DefaultRouteGenerator implements RouteGeneratorInterface
{
    /**
     * @var RouterInterface
     */
    private $router;

    /**
     * @var RoutesCache
     */
    private $cache;

    /**
     * @var array
     */
    private $caches = array();

    /**
     * @var string[]
     */
    private $loaded = array();

    /**
     * @param RouterInterface $router
     * @param RoutesCache     $cache
     */
    public function __construct(RouterInterface $router, RoutesCache $cache)
    {
        $this->router = $router;
        $this->cache = $cache;
    }

    /**
     * {@inheritdoc}
     */
    public function generate($name, array $parameters = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH)
    {
        return $this->router->generate($name, $parameters, $absolute);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * {@inheritdoc}
     */
    public function generateUrl(AdminInterface $admin, $name, array $parameters = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH)
    {
        $arrayRoute = $this->generateMenuUrl($admin, $name, $parameters, $absolute);

        return $this->router->generate($arrayRoute['route'], $arrayRoute['routeParameters'], $arrayRoute['routeAbsolute']);
    }

    /**
     * {@inheritdoc}
     */
    public function generateMenuUrl(AdminInterface $admin, $name, array $parameters = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH)
    {
        // if the admin is a child we automatically append the parent's id
        if ($admin->isChild() && $admin->hasRequest()) {
            // twig template does not accept variable hash key ... so cannot use admin.idparameter ...
            // switch value
            if (isset($parameters['id'])) {
                $parameters[$admin->getIdParameter()] = $parameters['id'];
                unset($parameters['id']);
            }

            for ($parentAdmin = $admin->getParent(); null !== $parentAdmin; $parentAdmin = $parentAdmin->getParent()) {
                $parameters[$parentAdmin->getIdParameter()] = $admin->getRequest()->attributes->get($parentAdmin->getIdParameter());
            }
        }

        // if the admin is linked to a parent FieldDescription (ie, embedded widget)
        if ($admin->hasParentFieldDescription()) {
            // merge link parameter if any provided by the parent field
            $parameters = array_merge($parameters, $admin->getParentFieldDescription()->getOption('link_parameters', array()));

            $parameters['uniqid'] = $admin->getUniqid();
            $parameters['code'] = $admin->getCode();
            $parameters['pcode'] = $admin->getParentFieldDescription()->getAdmin()->getCode();
            $parameters['puniqid'] = $admin->getParentFieldDescription()->getAdmin()->getUniqid();
        }

        if ($name == 'update' || substr($name, -7) == '|update') {
            $parameters['uniqid'] = $admin->getUniqid();
            $parameters['code'] = $admin->getCode();
        }

        // allows to define persistent parameters
        if ($admin->hasRequest()) {
            $parameters = array_merge($admin->getPersistentParameters(), $parameters);
        }

        $code = $this->getCode($admin, $name);

        if (!array_key_exists($code, $this->caches)) {
            throw new \RuntimeException(sprintf('unable to find the route `%s`', $code));
        }

        return array(
            'route' => $this->caches[$code],
            'routeParameters' => $parameters,
            'routeAbsolute' => $absolute,
        );
    }

    /**
     * {@inheritdoc}
     */
    public function hasAdminRoute(AdminInterface $admin, $name)
    {
        return array_key_exists($this->getCode($admin, $name), $this->caches);
    }

    /**
     * @param AdminInterface $admin
     * @param string         $name
     *
     * @return string
     */
    private function getCode(AdminInterface $admin, $name)
    {
        $this->loadCache($admin);

        // someone provide the fullname
        if (!$admin->isChild() && array_key_exists($name, $this->caches)) {
            return $name;
        }

        // NEXT_MAJOR: Uncomment the following line.
        // $codePrefix = $admin->getBaseCodeRoute();

        // NEXT_MAJOR: Remove next 5 lines.
        $codePrefix = $admin->getCode();

        if ($admin->isChild()) {
            $codePrefix = $admin->getBaseCodeRoute();
        }

        // someone provide a code, so it is a child
        if (strpos($name, '.')) {
            return $codePrefix.'|'.$name;
        }

        return $codePrefix.'.'.$name;
    }

    /**
     * @param AdminInterface $admin
     */
    private function loadCache(AdminInterface $admin)
    {
        if ($admin->isChild()) {
            $this->loadCache($admin->getParent());
        } else {
            if (in_array($admin->getCode(), $this->loaded)) {
                return;
            }

            $this->caches = array_merge($this->cache->load($admin), $this->caches);

            $this->loaded[] = $admin->getCode();
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sonata Project package.
5			*
6			* (c) Thomas Rabaix <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sonata\AdminBundle\Route;
13
14			use Sonata\AdminBundle\Admin\AdminInterface;
15			use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
16			use Symfony\Component\Routing\RouterInterface;
17
18			/**
19			* @author Thomas Rabaix <[email protected]>
20			*/
21			class DefaultRouteGenerator implements RouteGeneratorInterface
22			{
23			/**
24			* @var RouterInterface
25			*/
26			private $router;
27
28			/**
29			* @var RoutesCache
30			*/
31			private $cache;
32
33			/**
34			* @var array
35			*/
36			private $caches = array();
37
38			/**
39			* @var string[]
40			*/
41			private $loaded = array();
42
43			/**
44			* @param RouterInterface $router
45			* @param RoutesCache $cache
46			*/
47			public function __construct(RouterInterface $router, RoutesCache $cache)
48			{
49			$this->router = $router;
50			$this->cache = $cache;
51			}
52
53			/**
54			* {@inheritdoc}
55			*/
56			public function generate($name, array $parameters = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH)
57			{
58			return $this->router->generate($name, $parameters, $absolute);
			0 ignored issues – show Documentation introduced 2017-05-15 14:24 UTC by Report Bug Copy Issue Report `$absolute` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
59			}
60
61			/**
62			* {@inheritdoc}
63			*/
64			public function generateUrl(AdminInterface $admin, $name, array $parameters = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH)
65			{
66			$arrayRoute = $this->generateMenuUrl($admin, $name, $parameters, $absolute);
67
68			return $this->router->generate($arrayRoute['route'], $arrayRoute['routeParameters'], $arrayRoute['routeAbsolute']);
69			}
70
71			/**
72			* {@inheritdoc}
73			*/
74			public function generateMenuUrl(AdminInterface $admin, $name, array $parameters = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH)
75			{
76			// if the admin is a child we automatically append the parent's id
77			if ($admin->isChild() && $admin->hasRequest()) {
78			// twig template does not accept variable hash key ... so cannot use admin.idparameter ...
79			// switch value
80			if (isset($parameters['id'])) {
81			$parameters[$admin->getIdParameter()] = $parameters['id'];
82			unset($parameters['id']);
83			}
84
85			for ($parentAdmin = $admin->getParent(); null !== $parentAdmin; $parentAdmin = $parentAdmin->getParent()) {
86			$parameters[$parentAdmin->getIdParameter()] = $admin->getRequest()->attributes->get($parentAdmin->getIdParameter());
87			}
88			}
89
90			// if the admin is linked to a parent FieldDescription (ie, embedded widget)
91			if ($admin->hasParentFieldDescription()) {
92			// merge link parameter if any provided by the parent field
93			$parameters = array_merge($parameters, $admin->getParentFieldDescription()->getOption('link_parameters', array()));
94
95			$parameters['uniqid'] = $admin->getUniqid();
96			$parameters['code'] = $admin->getCode();
97			$parameters['pcode'] = $admin->getParentFieldDescription()->getAdmin()->getCode();
98			$parameters['puniqid'] = $admin->getParentFieldDescription()->getAdmin()->getUniqid();
99			}
100
101			if ($name == 'update' \|\| substr($name, -7) == '\|update') {
102			$parameters['uniqid'] = $admin->getUniqid();
103			$parameters['code'] = $admin->getCode();
104			}
105
106			// allows to define persistent parameters
107			if ($admin->hasRequest()) {
108			$parameters = array_merge($admin->getPersistentParameters(), $parameters);
109			}
110
111			$code = $this->getCode($admin, $name);
112
113			if (!array_key_exists($code, $this->caches)) {
114			throw new \RuntimeException(sprintf('unable to find the route `%s`', $code));
115			}
116
117			return array(
118			'route' => $this->caches[$code],
119			'routeParameters' => $parameters,
120			'routeAbsolute' => $absolute,
121			);
122			}
123
124			/**
125			* {@inheritdoc}
126			*/
127			public function hasAdminRoute(AdminInterface $admin, $name)
128			{
129			return array_key_exists($this->getCode($admin, $name), $this->caches);
130			}
131
132			/**
133			* @param AdminInterface $admin
134			* @param string $name
135			*
136			* @return string
137			*/
138			private function getCode(AdminInterface $admin, $name)
139			{
140			$this->loadCache($admin);
141
142			// someone provide the fullname
143			if (!$admin->isChild() && array_key_exists($name, $this->caches)) {
144			return $name;
145			}
146
147			// NEXT_MAJOR: Uncomment the following line.
148			// $codePrefix = $admin->getBaseCodeRoute();
149
150			// NEXT_MAJOR: Remove next 5 lines.
151			$codePrefix = $admin->getCode();
152
153			if ($admin->isChild()) {
154			$codePrefix = $admin->getBaseCodeRoute();
155			}
156
157			// someone provide a code, so it is a child
158			if (strpos($name, '.')) {
159			return $codePrefix.'\|'.$name;
160			}
161
162			return $codePrefix.'.'.$name;
163			}
164
165			/**
166			* @param AdminInterface $admin
167			*/
168			private function loadCache(AdminInterface $admin)
169			{
170			if ($admin->isChild()) {
171			$this->loadCache($admin->getParent());
172			} else {
173			if (in_array($admin->getCode(), $this->loaded)) {
174			return;
175			}
176
177			$this->caches = array_merge($this->cache->load($admin), $this->caches);
178
179			$this->loaded[] = $admin->getCode();
180			}
181			}
182			}
183

sonata-project / SonataAdminBundle

Push — 3.x ( f7534c...26d69b )

DefaultRouteGenerator::generateMenuUrl() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like