AbstractConfigController::configAction() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/1.4'" - zikula/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2fb092...058edd )

by Craig

created 2017-01-08 19:21 UTC

AbstractConfigController::configAction() B

↳ Parent: AbstractConfigController

Complexity

Conditions	5
Paths	5

Size

Total Lines	30
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	16
nc	5
nop	1
dl	0
loc	30
rs	8.439
c	0
b	0
f	0

<?php
/**
 * Routes.
 *
 * @copyright Zikula contributors (Zikula)
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 * @author Zikula contributors <[email protected]>.
 * @link http://www.zikula.org
 * @link http://zikula.org
 * @version Generated by ModuleStudio 0.7.1 (http://modulestudio.de).
 */

namespace Zikula\RoutesModule\Controller\Base;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Zikula\Core\Controller\AbstractController;

/**
 * Config controller base class.
 */
abstract class AbstractConfigController extends AbstractController
{
    /**
     * This method takes care of the application configuration.
     *
     * @param Request $request Current request instance
     *
     * @return string Output
     *
     * @throws AccessDeniedException Thrown if the user doesn't have required permissions
     */
    public function configAction(Request $request)
    {
        if (!$this->hasPermission($this->name . '::', '::', ACCESS_ADMIN)) {
            throw new AccessDeniedException();
        }
        
        $form = $this->createForm('Zikula\RoutesModule\Form\AppSettingsType');
        
        if ($form->handleRequest($request)->isValid()) {
            if ($form->get('save')->isClicked()) {
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.
    }
}
                $this->setVars($form->getData());
        
                $this->addFlash('status', $this->__('Done! Module configuration updated.'));
                $userName = $this->get('zikula_users_module.current_user')->get('uname');
                $this->get('logger')->notice('{app}: User {user} updated the configuration.', ['app' => 'ZikulaRoutesModule', 'user' => $userName]);
            } elseif ($form->get('cancel')->isClicked()) {
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.
    }
}
                $this->addFlash('status', $this->__('Operation cancelled.'));
            }
        
            // redirect to config page again (to show with GET request)
            return $this->redirectToRoute('zikularoutesmodule_config_config');
        }
        
        $templateParameters = [
            'form' => $form->createView()
        ];
        
        // render the config form
        return $this->render('@ZikulaRoutesModule/Config/config.html.twig', $templateParameters);
    }
}


Push — master ( 2fb092...058edd )

AbstractConfigController::configAction() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Routes.
4			*
5			* @copyright Zikula contributors (Zikula)
6			* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
7			* @author Zikula contributors <[email protected]>.
8			* @link http://www.zikula.org
9			* @link http://zikula.org
10			* @version Generated by ModuleStudio 0.7.1 (http://modulestudio.de).
11			*/
12
13			namespace Zikula\RoutesModule\Controller\Base;
14
15			use Symfony\Component\HttpFoundation\Request;
16			use Symfony\Component\Security\Core\Exception\AccessDeniedException;
17			use Zikula\Core\Controller\AbstractController;
18
19			/**
20			* Config controller base class.
21			*/
22			abstract class AbstractConfigController extends AbstractController
23			{
24			/**
25			* This method takes care of the application configuration.
26			*
27			* @param Request $request Current request instance
28			*
29			* @return string Output
30			*
31			* @throws AccessDeniedException Thrown if the user doesn't have required permissions
32			*/
33			public function configAction(Request $request)
34			{
35			if (!$this->hasPermission($this->name . '::', '::', ACCESS_ADMIN)) {
36			throw new AccessDeniedException();
37			}
38
39			$form = $this->createForm('Zikula\RoutesModule\Form\AppSettingsType');
40
41			if ($form->handleRequest($request)->isValid()) {
42			if ($form->get('save')->isClicked()) {
			0 ignored issues – show Bug introduced 2017-01-08 19:27 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Form\FormInterface` as the method `isClicked()` does only exist in the following implementations of said interface: `Symfony\Component\Form\SubmitButton`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
43			$this->setVars($form->getData());
44
45			$this->addFlash('status', $this->__('Done! Module configuration updated.'));
46			$userName = $this->get('zikula_users_module.current_user')->get('uname');
47			$this->get('logger')->notice('{app}: User {user} updated the configuration.', ['app' => 'ZikulaRoutesModule', 'user' => $userName]);
48			} elseif ($form->get('cancel')->isClicked()) {
			0 ignored issues – show Bug introduced 2017-01-08 19:27 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Form\FormInterface` as the method `isClicked()` does only exist in the following implementations of said interface: `Symfony\Component\Form\SubmitButton`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
49			$this->addFlash('status', $this->__('Operation cancelled.'));
50			}
51
52			// redirect to config page again (to show with GET request)
53			return $this->redirectToRoute('zikularoutesmodule_config_config');
54			}
55
56			$templateParameters = [
57			'form' => $form->createView()
58			];
59
60			// render the config form
61			return $this->render('@ZikulaRoutesModule/Config/config.html.twig', $templateParameters);
62			}
63			}
64

zikula / core

Push — master ( 2fb092...058edd )

AbstractConfigController::configAction() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like