RoleController::roleAction() - Code Metrics - Inspection of "updated comments admin" - VictorTkachenko81/SymfonyBlog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( bb7f99...d04bd8 )

by Victor

created 2016-01-16 21:24 UTC

RoleController::roleAction() B

↳ Parent: RoleController

Complexity

Conditions	5
Paths	6

Size

Total Lines	56
Code Lines	37

Duplication

Lines	56
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	56
loc	56
ccs	0
cts	39
cp	0
rs	8.7592
cc	5
eloc	37
nc	6
nop	2
crap	30

How to fix Long Method

<?php

namespace AppBundle\Controller\Admin;

use AppBundle\Entity\Role;
use AppBundle\Form\Type\RoleType;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
use Symfony\Component\HttpFoundation\Request;

/**
 * Class AdminController
 * @package AppBundle\Controller\Admin
 * @Route("/admin")
 */
class RoleController extends Controller

{
    /**
     * @param Request $request
     * @param $page
     * @Method({"GET", "POST"})
     * @Route("/roles/{pager}/{page}", name="rolesAdmin",
     *     defaults={"pager": "page", "page": 1},
     *     requirements={
     *          "pager": "page",
     *          "page": "[1-9]\d*",
     *     })
     * @Template("AppBundle:admin:roles.html.twig")
     *
     * @return Response
     */
    public function roleAction(Request $request, $page = 1)

    {
        $em = $this->getDoctrine()->getManager();
        $roles = $em->getRepository('AppBundle:Role')
            ->findAll();

        $form = $this->createFormBuilder($roles)
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            ->setAction($this->generateUrl('rolesAdmin'))
            ->setMethod('POST')
            ->add('roles', ChoiceType::class, array(
                    'choices'           => $roles,
                    'choices_as_values' => true,
                    'expanded'          => true,
                    'multiple'          => true,
                    'choice_value'      => 'id',
                    'label'             => false,
                    'choice_label'      => 'id',
                )
            )
            ->add('delete', SubmitType::class, array(
                    'label'     => 'Remove',
                    'attr'      => [
                        'class' => 'btn btn-xs btn-danger'
                    ],
                )
            )
            ->getForm();

        if ($request->getMethod() == 'POST') {
            $form->handleRequest($request);
            if ($form->isValid()) {
                $data = $form->getData();
                foreach ($data['roles'] as $role) {
                    $em->remove($role);
                }

                try {
                    $em->flush();
                } catch (\Exception $e) {
                    return $this->render(
                        'AppBundle:admin:failure.html.twig',
                        array(
                            'message' => 'Deleting record is failed. Because record has relation to other records or another reasons.',
                        )
                    );
                }

                return $this->redirectToRoute('rolesAdmin');
            }
        }

        return [
            'roles'  => $roles,
            'delete' => $form->createView(),
        ];
    }

    /**
     * @param $id
     * @param $action
     * @param Request $request
     * @Route("/role/{action}/{id}", name="roleEdit",
     *     defaults={"id": 0},
     *     requirements={
     *      "action": "new|edit",
     *      "id": "\d+"
     *     })
     * @Method({"GET", "POST"})
     * @Template("AppBundle:admin/form:role.html.twig")
     *
     * @return Response
     */
    public function editRoleAction($id, $action, Request $request)
    {
        $em = $this->getDoctrine()->getManager();
        if ($action == "edit") {
            $role = $em->getRepository('AppBundle:Role')
                ->find($id);
            $title = 'Edit role id: '.$id;
        }
        else {
            $role = new Role();
            $title = 'Create new role';
        }


        $form = $this->createForm(RoleType::class, $role, [
            'em' => $em,
            'action' => $this->generateUrl('roleEdit', ['action' => $action, 'id' => $id]),
            'method' => Request::METHOD_POST,
        ])
            ->add('save', SubmitType::class, array('label' => 'Save'));

        if ($request->getMethod() == 'POST') {
            $form->handleRequest($request);
            if ($form->isValid()) {
                $em->persist($role);
                $em->flush();

                return $this->redirectToRoute('rolesAdmin');
            }
        }

        return [
            'title' => $title,
            'form'  => $form->createView(),
        ];
    }

}


1		<?php
2
3		namespace AppBundle\Controller\Admin;
4
5		use AppBundle\Entity\Role;
6		use AppBundle\Form\Type\RoleType;
7		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
8		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
9		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
10		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
11		use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
12		use Symfony\Component\Form\Extension\Core\Type\SubmitType;
13		use Symfony\Component\HttpFoundation\Request;
14
15		/**
16		* Class AdminController
17		* @package AppBundle\Controller\Admin
18		* @Route("/admin")
19		*/
20	View Code Duplication	class RoleController extends Controller
		0 ignored issues – show Duplication introduced 2016-01-16 21:27 UTC by Report Bug Copy Issue Report This class 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...
21		{
22		/**
23		* @param Request $request
24		* @param $page
25		* @Method({"GET", "POST"})
26		* @Route("/roles/{pager}/{page}", name="rolesAdmin",
27		* defaults={"pager": "page", "page": 1},
28		* requirements={
29		* "pager": "page",
30		* "page": "[1-9]\d*",
31		* })
32		* @Template("AppBundle:admin:roles.html.twig")
33		*
34		* @return Response
35		*/
36		public function roleAction(Request $request, $page = 1)
		0 ignored issues – show Unused Code introduced 2016-01-16 21:27 UTC by Report Bug Copy Issue Report The parameter `$page` 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		$em = $this->getDoctrine()->getManager();
39		$roles = $em->getRepository('AppBundle:Role')
40		->findAll();
41
42		$form = $this->createFormBuilder($roles)
		0 ignored issues – show Bug introduced 2016-01-16 21:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Form\FormConfigBuilder` as the method `add()` does only exist in the following sub-classes of `Symfony\Component\Form\FormConfigBuilder`: `Symfony\Component\Form\FormBuilder`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
43		->setAction($this->generateUrl('rolesAdmin'))
44		->setMethod('POST')
45		->add('roles', ChoiceType::class, array(
46		'choices' => $roles,
47		'choices_as_values' => true,
48		'expanded' => true,
49		'multiple' => true,
50		'choice_value' => 'id',
51		'label' => false,
52		'choice_label' => 'id',
53		)
54		)
55		->add('delete', SubmitType::class, array(
56		'label' => 'Remove',
57		'attr' => [
58		'class' => 'btn btn-xs btn-danger'
59		],
60		)
61		)
62		->getForm();
63
64		if ($request->getMethod() == 'POST') {
65		$form->handleRequest($request);
66		if ($form->isValid()) {
67		$data = $form->getData();
68		foreach ($data['roles'] as $role) {
69		$em->remove($role);
70		}
71
72		try {
73		$em->flush();
74		} catch (\Exception $e) {
75		return $this->render(
76		'AppBundle:admin:failure.html.twig',
77		array(
78		'message' => 'Deleting record is failed. Because record has relation to other records or another reasons.',
79		)
80		);
81		}
82
83		return $this->redirectToRoute('rolesAdmin');
84		}
85		}
86
87		return [
88		'roles' => $roles,
89		'delete' => $form->createView(),
90		];
91		}
92
93		/**
94		* @param $id
95		* @param $action
96		* @param Request $request
97		* @Route("/role/{action}/{id}", name="roleEdit",
98		* defaults={"id": 0},
99		* requirements={
100		* "action": "new\|edit",
101		* "id": "\d+"
102		* })
103		* @Method({"GET", "POST"})
104		* @Template("AppBundle:admin/form:role.html.twig")
105		*
106		* @return Response
107		*/
108		public function editRoleAction($id, $action, Request $request)
109		{
110		$em = $this->getDoctrine()->getManager();
111		if ($action == "edit") {
112		$role = $em->getRepository('AppBundle:Role')
113		->find($id);
114		$title = 'Edit role id: '.$id;
115		}
116		else {
117		$role = new Role();
118		$title = 'Create new role';
119		}
120
121
122		$form = $this->createForm(RoleType::class, $role, [
123		'em' => $em,
124		'action' => $this->generateUrl('roleEdit', ['action' => $action, 'id' => $id]),
125		'method' => Request::METHOD_POST,
126		])
127		->add('save', SubmitType::class, array('label' => 'Save'));
128
129		if ($request->getMethod() == 'POST') {
130		$form->handleRequest($request);
131		if ($form->isValid()) {
132		$em->persist($role);
133		$em->flush();
134
135		return $this->redirectToRoute('rolesAdmin');
136		}
137		}
138
139		return [
140		'title' => $title,
141		'form' => $form->createView(),
142		];
143		}
144
145		}
146

VictorTkachenko81 / SymfonyBlog

Push — develop ( bb7f99...d04bd8 )

RoleController::roleAction() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like