Completed
Push — master ( dc1345...98f380 )
by Benjamin
02:22
created

AdminNodeController::redirectTo()   C

Complexity

Conditions 12
Paths 96

Size

Total Lines 38
Code Lines 21

Duplication

Lines 38
Ratio 100 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 38
loc 38
rs 5.1612
cc 12
eloc 21
nc 96
nop 1

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace Alpixel\Bundle\CMSBundle\Controller;
4
5
use Sonata\AdminBundle\Controller\CRUDController as Controller;
6
use Symfony\Component\HttpFoundation\File\Exception\AccessDeniedException;
7
use Symfony\Component\HttpFoundation\RedirectResponse;
8
use Symfony\Component\HttpFoundation\Request;
9
10
class AdminNodeController extends Controller
11
{
12
    public function createTranslationAction(Request $request)
13
    {
14
        $object = $this->admin->getSubject();
15
        $locale = $request->query->get('locale');
16
17
        if ($locale === null || $object === null) {
18
            return $this->createNotFoundException();
19
        }
20
21
        $entityManager = $this->get('doctrine.orm.entity_manager');
22
        $translation = $entityManager->getRepository('AlpixelCMSBundle:Node')
23
            ->findTranslation($object, $locale);
24
25
        if ($translation !== null) {
26
            return $this->redirect($this->admin->generateUrl('edit', ['id' => $translation->getId()]));
27
        } else {
28
            $translatedContent = $this->get('alpixel_cms.helper.cms')->createTranslation($object, $locale);
29
            $entityManager->persist($translatedContent);
30
            $entityManager->flush();
31
32
            return $this->redirect($this->admin->generateUrl('edit', ['id' => $translatedContent->getId()]));
33
        }
34
    }
35
36
    public function seeAction(Request $request)
0 ignored issues
show
Unused Code introduced by
The parameter $request is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
37
    {
38
        $object = $this->admin->getSubject();
39
        $contentTypes = $this->admin->getCMSTypes();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Sonata\AdminBundle\Admin\AdminInterface as the method getCMSTypes() does only exist in the following implementations of said interface: Alpixel\Bundle\CMSBundle\Admin\AdminBlock, Alpixel\Bundle\CMSBundle\Admin\AdminNode, Alpixel\Bundle\CMSBundle\Admin\BaseAdmin, Alpixel\Bundle\CMSBundle...in\BaseBlockEntityAdmin, Alpixel\Bundle\CMSBundle\Admin\BaseNodeEntityAdmin.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
40
41
        foreach ($contentTypes as $key => $contentType) {
42
            if ($key === $object->getType()) {
43
                if (isset($contentTypes['controller'])) {
44
                    return $this->redirectToRoute('alpixel_cms', ['slug' => $object->getSlug()]);
45
                } elseif ($contentType['admin'] !== null && $contentType['admin']->showCustomURL($object) !== null) {
46
                    return $this->redirect($contentType['admin']->showCustomURL($object));
47
                }
48
            }
49
        }
50
51
        $this->get('session')->getFlashBag()->add('warning', 'Impossible de trouver une adresse pour cette page');
52
53
        return $this->redirectTo($object);
54
    }
55
56
    public function listAction(Request $request = null)
57
    {
58
        if (false === $this->admin->isGranted('LIST')) {
59
            throw new AccessDeniedException();
0 ignored issues
show
Bug introduced by
The call to AccessDeniedException::__construct() misses a required argument $path.

This check looks for function calls that miss required arguments.

Loading history...
60
        }
61
62
        $datagrid = $this->admin->getDatagrid();
63
        $formView = $datagrid->getForm()->createView();
64
65
        if (!$this->container->hasParameter('alpixel_cms.content_types')) {
66
            throw $this->createNotFoundException('alpixel_cms.content_types parameters has not been  not found, maybe you must be configured cms.yml file');
67
        }
68
69
        $cmsContentType = $this->container->getParameter('alpixel_cms.content_types');
70
        $this->get('twig')->getExtension('form')->renderer->setTheme($formView, $this->admin->getFilterTheme());
71
72
        return $this->render($this->admin->getTemplate('list'), [
73
            'action'         => 'list',
74
            'cmsContentType' => $cmsContentType,
75
            'form'           => $formView,
76
            'datagrid'       => $datagrid,
77
            'csrf_token'     => $this->getCsrfToken('sonata.batch'),
78
        ], null, $request);
0 ignored issues
show
Unused Code introduced by
The call to AdminNodeController::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...
79
    }
80
81
    /**
82
     * {@inheritdoc}
83
     */
84 View Code Duplication
    protected function redirectTo($object)
0 ignored issues
show
Duplication introduced by
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...
85
    {
86
        $request = $this->getRequest();
87
88
        $url = $backToNodeList = false;
89
        $instanceAdmin = $this->admin->getConfigurationPool()->getInstance('alpixel_cms.admin.node');
90
91
        if (null !== $request->get('btn_update_and_list') || null !== $request->get('btn_create_and_list')) {
92
            $backToNodeList = true;
93
        }
94
95
        if (null !== $request->get('btn_create_and_create')) {
96
            $params = [];
97
            if ($this->admin->hasActiveSubClass()) {
98
                $params['subclass'] = $request->get('subclass');
0 ignored issues
show
Bug introduced by
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...
99
            }
100
            $url = $this->admin->generateUrl('create', $params);
101
        }
102
103
        if ($this->getRestMethod() === 'DELETE') {
104
            $backToNodeList = true;
105
        }
106
107
        if (!$url) {
0 ignored issues
show
Bug Best Practice introduced by
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...
108
            foreach (['edit', 'show'] as $route) {
109
                if ($this->admin->hasRoute($route) && $this->admin->isGranted(strtoupper($route), $object)) {
110
                    $url = $this->admin->generateObjectUrl($route, $object);
111
                    break;
112
                }
113
            }
114
        }
115
116
        if ($backToNodeList || !$url) {
0 ignored issues
show
Bug Best Practice introduced by
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...
117
            $url = $instanceAdmin->generateUrl('list');
118
        }
119
120
        return new RedirectResponse($url);
121
    }
122
}
123