SecurityAdmin::getRoutes() - Code Metrics - Inspection of "Add toolbar action registry for datagrid (#4353)" - sulu/sulu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 9120f9...ca30f2 )

by Daniel

created 2019-02-14 17:27 UTC

SecurityAdmin::getRoutes() B

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	55
c	0
b	0
f	0
rs	8.9818
cc	1
nc	1
nop	0

How to fix Long Method

<?php

/*
 * This file is part of Sulu.
 *
 * (c) MASSIVE ART WebServices GmbH
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Sulu\Bundle\SecurityBundle\Admin;

use Sulu\Bundle\AdminBundle\Admin\Admin;
use Sulu\Bundle\AdminBundle\Admin\Routing\RouteBuilderFactoryInterface;
use Sulu\Bundle\AdminBundle\Navigation\Navigation;
use Sulu\Bundle\AdminBundle\Navigation\NavigationItem;
use Sulu\Bundle\ContactBundle\Admin\ContactAdmin;
use Sulu\Component\Security\Authorization\PermissionTypes;
use Sulu\Component\Security\Authorization\SecurityCheckerInterface;

class SecurityAdmin extends Admin
{
    const DATAGRID_ROUTE = 'sulu_security.roles_datagrid';

    const ADD_FORM_ROUTE = 'sulu_security.role_add_form';

    const EDIT_FORM_ROUTE = 'sulu_security.role_edit_form';

    /**
     * @var RouteBuilderFactoryInterface
     */
    private $routeBuilderFactory;

    /**
     * @var SecurityCheckerInterface
     */
    private $securityChecker;

    public function __construct(
        RouteBuilderFactoryInterface $routeBuilderFactory,
        SecurityCheckerInterface $securityChecker
    ) {
        $this->routeBuilderFactory = $routeBuilderFactory;
        $this->securityChecker = $securityChecker;
    }

    public function getNavigation(): Navigation

    {
        $rootNavigationItem = $this->getNavigationItemRoot();

        $settings = Admin::getNavigationItemSettings();

        if ($this->securityChecker->hasPermission('sulu.security.roles', PermissionTypes::VIEW)) {
            $roles = new NavigationItem('sulu_security.roles', $settings);
            $roles->setPosition(10);
            $roles->setMainRoute(static::DATAGRID_ROUTE);
        }

        if ($settings->hasChildren()) {
            $rootNavigationItem->addChild($settings);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return new Navigation($rootNavigationItem);
    }

    public function getSecurityContexts()
    {
        return [
            'Sulu' => [
                'Security' => [
                    'sulu.security.roles' => [
                        PermissionTypes::VIEW,
                        PermissionTypes::ADD,
                        PermissionTypes::EDIT,
                        PermissionTypes::DELETE,
                    ],
                    'sulu.security.groups' => [
                        PermissionTypes::VIEW,
                        PermissionTypes::ADD,
                        PermissionTypes::EDIT,
                        PermissionTypes::DELETE,
                    ],
                    'sulu.security.users' => [
                        PermissionTypes::VIEW,
                        PermissionTypes::ADD,
                        PermissionTypes::EDIT,
                        PermissionTypes::DELETE,
                    ],
                ],
            ],
        ];
    }

    public function getRoutes(): array
    {
        $formToolbarActions = [
            'sulu_admin.save',
        ];

        $listToolbarActions = [
            'sulu_admin.add',
            'sulu_admin.delete',
        ];

        return [
            $this->routeBuilderFactory->createDatagridRouteBuilder(static::DATAGRID_ROUTE, '/roles')
                ->setResourceKey('roles')
                ->setDatagridKey('roles')
                ->setTitle('sulu_security.roles')
                ->addDatagridAdapters(['table'])
                ->setAddRoute(static::ADD_FORM_ROUTE)
                ->setEditRoute(static::EDIT_FORM_ROUTE)
                ->addToolbarActions($listToolbarActions)
                ->getRoute(),
            $this->routeBuilderFactory->createResourceTabRouteBuilder(static::ADD_FORM_ROUTE, '/roles/add')
                ->setResourceKey('roles')
                ->setBackRoute(static::DATAGRID_ROUTE)
                ->getRoute(),
            $this->routeBuilderFactory->createFormRouteBuilder('sulu_security.role_add_form.details', '/details')
                ->setResourceKey('roles')
                ->setFormKey('role_details')
                ->setTabTitle('sulu_admin.details')
                ->setEditRoute(static::EDIT_FORM_ROUTE)
                ->addToolbarActions($formToolbarActions)
                ->setParent(static::ADD_FORM_ROUTE)
                ->getRoute(),
            $this->routeBuilderFactory->createResourceTabRouteBuilder(static::EDIT_FORM_ROUTE, '/roles/:id')
                ->setResourceKey('roles')
                ->setBackRoute(static::DATAGRID_ROUTE)
                ->setTitleProperty('name')
                ->getRoute(),
            $this->routeBuilderFactory->createFormRouteBuilder('sulu_security.role_edit_form.details', '/details')
                ->setResourceKey('roles')
                ->setFormKey('role_details')
                ->setTabTitle('sulu_admin.details')
                ->addToolbarActions($formToolbarActions)
                ->setParent(static::EDIT_FORM_ROUTE)
                ->getRoute(),
            $this->routeBuilderFactory->createFormRouteBuilder('sulu_security.form.permissions', '/permissions')
                ->setResourceKey('users')
                ->setFormKey('user_details')
                ->setTabTitle('sulu_security.permissions')
                ->addToolbarActions(['sulu_admin.save'])
                ->setIdQueryParameter('contactId')
                ->setParent(ContactAdmin::CONTACT_EDIT_FORM_ROUTE)
                ->getRoute(),
        ];
    }
}


1		<?php
2
3		/*
4		* This file is part of Sulu.
5		*
6		* (c) MASSIVE ART WebServices GmbH
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Sulu\Bundle\SecurityBundle\Admin;
13
14		use Sulu\Bundle\AdminBundle\Admin\Admin;
15		use Sulu\Bundle\AdminBundle\Admin\Routing\RouteBuilderFactoryInterface;
16		use Sulu\Bundle\AdminBundle\Navigation\Navigation;
17		use Sulu\Bundle\AdminBundle\Navigation\NavigationItem;
18		use Sulu\Bundle\ContactBundle\Admin\ContactAdmin;
19		use Sulu\Component\Security\Authorization\PermissionTypes;
20		use Sulu\Component\Security\Authorization\SecurityCheckerInterface;
21
22		class SecurityAdmin extends Admin
23		{
24		const DATAGRID_ROUTE = 'sulu_security.roles_datagrid';
25
26		const ADD_FORM_ROUTE = 'sulu_security.role_add_form';
27
28		const EDIT_FORM_ROUTE = 'sulu_security.role_edit_form';
29
30		/**
31		* @var RouteBuilderFactoryInterface
32		*/
33		private $routeBuilderFactory;
34
35		/**
36		* @var SecurityCheckerInterface
37		*/
38		private $securityChecker;
39
40		public function __construct(
41		RouteBuilderFactoryInterface $routeBuilderFactory,
42		SecurityCheckerInterface $securityChecker
43		) {
44		$this->routeBuilderFactory = $routeBuilderFactory;
45		$this->securityChecker = $securityChecker;
46		}
47
48	View Code Duplication	public function getNavigation(): Navigation
		0 ignored issues – show Duplication introduced 2018-03-23 09:26 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
49		{
50		$rootNavigationItem = $this->getNavigationItemRoot();
51
52		$settings = Admin::getNavigationItemSettings();
53
54		if ($this->securityChecker->hasPermission('sulu.security.roles', PermissionTypes::VIEW)) {
55		$roles = new NavigationItem('sulu_security.roles', $settings);
56		$roles->setPosition(10);
57		$roles->setMainRoute(static::DATAGRID_ROUTE);
58		}
59
60		if ($settings->hasChildren()) {
61		$rootNavigationItem->addChild($settings);
		0 ignored issues – show Documentation introduced 2018-03-26 13:47 UTC by Report Bug Copy Issue Report `$settings` is of type `object<Sulu\Bundle\Admin...igation\NavigationItem>`, but the function expects a `object<self>`. 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...
62		}
63
64		return new Navigation($rootNavigationItem);
65		}
66
67		public function getSecurityContexts()
68		{
69		return [
70		'Sulu' => [
71		'Security' => [
72		'sulu.security.roles' => [
73		PermissionTypes::VIEW,
74		PermissionTypes::ADD,
75		PermissionTypes::EDIT,
76		PermissionTypes::DELETE,
77		],
78		'sulu.security.groups' => [
79		PermissionTypes::VIEW,
80		PermissionTypes::ADD,
81		PermissionTypes::EDIT,
82		PermissionTypes::DELETE,
83		],
84		'sulu.security.users' => [
85		PermissionTypes::VIEW,
86		PermissionTypes::ADD,
87		PermissionTypes::EDIT,
88		PermissionTypes::DELETE,
89		],
90		],
91		],
92		];
93		}
94
95		public function getRoutes(): array
96		{
97		$formToolbarActions = [
98		'sulu_admin.save',
99		];
100
101		$listToolbarActions = [
102		'sulu_admin.add',
103		'sulu_admin.delete',
104		];
105
106		return [
107		$this->routeBuilderFactory->createDatagridRouteBuilder(static::DATAGRID_ROUTE, '/roles')
108		->setResourceKey('roles')
109		->setDatagridKey('roles')
110		->setTitle('sulu_security.roles')
111		->addDatagridAdapters(['table'])
112		->setAddRoute(static::ADD_FORM_ROUTE)
113		->setEditRoute(static::EDIT_FORM_ROUTE)
114		->addToolbarActions($listToolbarActions)
115		->getRoute(),
116		$this->routeBuilderFactory->createResourceTabRouteBuilder(static::ADD_FORM_ROUTE, '/roles/add')
117		->setResourceKey('roles')
118		->setBackRoute(static::DATAGRID_ROUTE)
119		->getRoute(),
120		$this->routeBuilderFactory->createFormRouteBuilder('sulu_security.role_add_form.details', '/details')
121		->setResourceKey('roles')
122		->setFormKey('role_details')
123		->setTabTitle('sulu_admin.details')
124		->setEditRoute(static::EDIT_FORM_ROUTE)
125		->addToolbarActions($formToolbarActions)
126		->setParent(static::ADD_FORM_ROUTE)
127		->getRoute(),
128		$this->routeBuilderFactory->createResourceTabRouteBuilder(static::EDIT_FORM_ROUTE, '/roles/:id')
129		->setResourceKey('roles')
130		->setBackRoute(static::DATAGRID_ROUTE)
131		->setTitleProperty('name')
132		->getRoute(),
133		$this->routeBuilderFactory->createFormRouteBuilder('sulu_security.role_edit_form.details', '/details')
134		->setResourceKey('roles')
135		->setFormKey('role_details')
136		->setTabTitle('sulu_admin.details')
137		->addToolbarActions($formToolbarActions)
138		->setParent(static::EDIT_FORM_ROUTE)
139		->getRoute(),
140		$this->routeBuilderFactory->createFormRouteBuilder('sulu_security.form.permissions', '/permissions')
141		->setResourceKey('users')
142		->setFormKey('user_details')
143		->setTabTitle('sulu_security.permissions')
144		->addToolbarActions(['sulu_admin.save'])
145		->setIdQueryParameter('contactId')
146		->setParent(ContactAdmin::CONTACT_EDIT_FORM_ROUTE)
147		->getRoute(),
148		];
149		}
150		}
151

sulu / sulu

Push — develop ( 9120f9...ca30f2 )

SecurityAdmin::getRoutes() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like