AdminBlockController::listAction() - Code Metrics - Inspection of "Delegating Administration actions to specific admi..." - alpixel/AlpixelCMSBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#33)

by Benjamin

created 2016-04-13 13:01 UTC

AdminBlockController::listAction() A

↳ Parent: AdminBlockController

Complexity

Conditions	2
Paths	2

Size

Total Lines	20
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
c	4
b	1
f	0
dl	0
loc	20
rs	9.4285
cc	2
eloc	14
nc	2
nop	1

<?php

namespace Alpixel\Bundle\CMSBundle\Controller;

use Sonata\AdminBundle\Controller\CRUDController as Controller;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

class AdminBlockController extends Controller
{
    private $_cmsParameter = 'alpixel_cms.blocks';
    private $_cmsContentParameter = null;
    private $_blockDefaultClass = 'Alpixel\Bundle\CMSBundle\Entity\Block';


    public function editContentAction()
    {
        $object = $this->admin->getSubject();
        if (!$object) {
            throw new NotFoundHttpException(sprintf('unable to find the object'));
        }

        $instanceAdmin = $this->admin->getConfigurationPool()->getAdminByClass(get_class($object));
        if ($instanceAdmin !== null) {
            return $this->redirect($instanceAdmin->generateUrl('edit', ['id' => $object->getId()]));
        }

        throw new NotFoundHttpException(sprintf('unable to find a class admin for the %s class', get_class($content)));
    }

    public function listAction(Request $request = null)
    {
        if (false === $this->admin->isGranted('LIST')) {
            throw new AccessDeniedException();
        }

        $this->getInstancesAdmin();
        // set the theme for the current Admin Form
        $datagrid = $this->admin->getDatagrid();
        $formView = $datagrid->getForm()->createView();
        $this->get('twig')->getExtension('form')->renderer->setTheme($formView, $this->admin->getFilterTheme());

        return $this->render($this->admin->getTemplate('list'), [
            'action'         => 'list',
            'cmsContentType' => $this->getCMSParameter(),
            'form'           => $formView,
            'datagrid'       => $datagrid,
            'csrf_token'     => $this->getCsrfToken('sonata.batch'),
        ], null, $request);

    }

    /**
     *  Set instances of admin in $_cmsContentParameter.
     */
    protected function getInstancesAdmin()
    {
        foreach ($this->getCMSParameter() as $key => $value) {
            if ($this->checkRolesCMS($value)) {
                $instanceAdmin = $this->admin->getConfigurationPool()->getAdminByClass($value['class']);
                if ($instanceAdmin !== null) {
                    $this->_cmsContentParameter[$key]['admin'] = $instanceAdmin;
                }
            }
        }
    }

    /**
     * @param $role array Role in cms.yml
     *
     * Check role define in different parameter of block or content_types cms.yml
     */
    protected function checkRolesCMS(array $role)
    {
        $user = $this->getUser();

        if (!$user) {
            throw new NotFoundHttpException(sprintf('unable to find user'));
        }

        if (!array_key_exists('role', $role) || in_array($user->getRoles()[0], $role['role'])) {
            return true;
        }

        return false;
    }

    /**
     * Get content in cms.yml and set in $_cmsParameter.
     *
     * @return content of cms.yml
     */
    protected function getCMSParameter()
    {
        if ($this->_cmsContentParameter !== null) {
            return $this->_cmsContentParameter;
        }

        $this->_cmsContentParameter = $this->container->getParameter($this->_cmsParameter);

        return $this->_cmsContentParameter;
    }

    /**
     * {@inheritdoc}
     */
    protected function redirectTo($object)

    {
        $request = $this->getRequest();

        $url = $backToNodeList = false;
        $instanceAdmin = $this->admin->getConfigurationPool()->getInstance('alpixel_cms.admin.block');

        if (null !== $request->get('btn_update_and_list') || null !== $request->get('btn_create_and_list')) {
            $backToNodeList = true;
        }

        if (null !== $request->get('btn_create_and_create')) {
            $params = [];
            if ($this->admin->hasActiveSubClass()) {
                $params['subclass'] = $request->get('subclass');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            }
            $url = $this->admin->generateUrl('create', $params);
        }

        if ($this->getRestMethod() === 'DELETE') {
            $backToNodeList = true;
        }

        if (!$url) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            foreach (['edit', 'show'] as $route) {
                if ($this->admin->hasRoute($route) && $this->admin->isGranted(strtoupper($route), $object)) {
                    $url = $this->admin->generateObjectUrl($route, $object);
                    break;
                }
            }
        }

        if ($backToNodeList || !$url) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $url = $instanceAdmin->generateUrl('list');
        }

        return new RedirectResponse($url);
    }
}


1		<?php
2
3		namespace Alpixel\Bundle\CMSBundle\Controller;
4
5		use Sonata\AdminBundle\Controller\CRUDController as Controller;
6		use Symfony\Component\HttpFoundation\RedirectResponse;
7		use Symfony\Component\HttpFoundation\Request;
8		use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
9		use Symfony\Component\Security\Core\Exception\AccessDeniedException;
10
11		class AdminBlockController extends Controller
12		{
13		private $_cmsParameter = 'alpixel_cms.blocks';
14		private $_cmsContentParameter = null;
15		private $_blockDefaultClass = 'Alpixel\Bundle\CMSBundle\Entity\Block';
		0 ignored issues – show Unused Code introduced 2016-03-29 14:53 UTC by Report Bug Copy Issue Report The property `$_blockDefaultClass` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
16
17		public function editContentAction()
18		{
19		$object = $this->admin->getSubject();
20		if (!$object) {
21		throw new NotFoundHttpException(sprintf('unable to find the object'));
22		}
23
24		$instanceAdmin = $this->admin->getConfigurationPool()->getAdminByClass(get_class($object));
25		if ($instanceAdmin !== null) {
26		return $this->redirect($instanceAdmin->generateUrl('edit', ['id' => $object->getId()]));
27		}
28
29		throw new NotFoundHttpException(sprintf('unable to find a class admin for the %s class', get_class($content)));
30		}
31
32		public function listAction(Request $request = null)
33		{
34		if (false === $this->admin->isGranted('LIST')) {
35		throw new AccessDeniedException();
36		}
37
38		$this->getInstancesAdmin();
39		// set the theme for the current Admin Form
40		$datagrid = $this->admin->getDatagrid();
41		$formView = $datagrid->getForm()->createView();
42		$this->get('twig')->getExtension('form')->renderer->setTheme($formView, $this->admin->getFilterTheme());
43
44		return $this->render($this->admin->getTemplate('list'), [
45		'action' => 'list',
46		'cmsContentType' => $this->getCMSParameter(),
47		'form' => $formView,
48		'datagrid' => $datagrid,
49		'csrf_token' => $this->getCsrfToken('sonata.batch'),
50		], null, $request);
		0 ignored issues – show Unused Code introduced 2016-04-04 10:14 UTC by Report Bug Copy Issue Report The call to `AdminBlockController::render()` has too many arguments starting with `$request`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
51		}
52
53		/**
54		* Set instances of admin in $_cmsContentParameter.
55		*/
56		protected function getInstancesAdmin()
57		{
58		foreach ($this->getCMSParameter() as $key => $value) {
59		if ($this->checkRolesCMS($value)) {
60		$instanceAdmin = $this->admin->getConfigurationPool()->getAdminByClass($value['class']);
61		if ($instanceAdmin !== null) {
62		$this->_cmsContentParameter[$key]['admin'] = $instanceAdmin;
63		}
64		}
65		}
66		}
67
68		/**
69		* @param $role array Role in cms.yml
70		*
71		* Check role define in different parameter of block or content_types cms.yml
72		*/
73		protected function checkRolesCMS(array $role)
74		{
75		$user = $this->getUser();
76
77		if (!$user) {
78		throw new NotFoundHttpException(sprintf('unable to find user'));
79		}
80
81		if (!array_key_exists('role', $role) \|\| in_array($user->getRoles()[0], $role['role'])) {
82		return true;
83		}
84
85		return false;
86		}
87
88		/**
89		* Get content in cms.yml and set in $_cmsParameter.
90		*
91		* @return content of cms.yml
92		*/
93		protected function getCMSParameter()
94		{
95		if ($this->_cmsContentParameter !== null) {
96		return $this->_cmsContentParameter;
97		}
98
99		$this->_cmsContentParameter = $this->container->getParameter($this->_cmsParameter);
100
101		return $this->_cmsContentParameter;
102		}
103
104		/**
105		* {@inheritdoc}
106		*/
107	View Code Duplication	protected function redirectTo($object)
		0 ignored issues – show Duplication introduced 2016-01-21 10:01 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...
108		{
109		$request = $this->getRequest();
110
111		$url = $backToNodeList = false;
112		$instanceAdmin = $this->admin->getConfigurationPool()->getInstance('alpixel_cms.admin.block');
113
114		if (null !== $request->get('btn_update_and_list') \|\| null !== $request->get('btn_create_and_list')) {
115		$backToNodeList = true;
116		}
117
118		if (null !== $request->get('btn_create_and_create')) {
119		$params = [];
120		if ($this->admin->hasActiveSubClass()) {
121		$params['subclass'] = $request->get('subclass');
		0 ignored issues – show Bug introduced 2016-04-13 12:52 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$params['subclass']` is correct as `$request->get('subclass')` (which targets `Symfony\Component\HttpFoundation\Request::get()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
122		}
123		$url = $this->admin->generateUrl('create', $params);
124		}
125
126		if ($this->getRestMethod() === 'DELETE') {
127		$backToNodeList = true;
128		}
129
130		if (!$url) {
		0 ignored issues – show Bug Best Practice introduced 2016-04-13 12:52 UTC by Report Bug Copy Issue Report The expression `$url` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
131		foreach (['edit', 'show'] as $route) {
132		if ($this->admin->hasRoute($route) && $this->admin->isGranted(strtoupper($route), $object)) {
133		$url = $this->admin->generateObjectUrl($route, $object);
134		break;
135		}
136		}
137		}
138
139		if ($backToNodeList \|\| !$url) {
		0 ignored issues – show Bug Best Practice introduced 2016-04-13 12:52 UTC by Report Bug Copy Issue Report The expression `$url` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
140		$url = $instanceAdmin->generateUrl('list');
141		}
142
143		return new RedirectResponse($url);
144		}
145		}
146

alpixel / AlpixelCMSBundle

Pull Request — master (#33)

AdminBlockController::listAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like