ZoneStorageController - Code Metrics - Inspection of "Add ZoneStorage management" - Dev-Int/glsr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — sf2.7 ( 76dc64...d0498a )

by Laurent

created 2016-04-03 01:14 UTC

ZoneStorageController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	169
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	13
c	1
b	0
f	1
lcom	1
cbo	6
dl	169
loc	169
rs	10

8 Methods

Rating	Name	Duplication	Size	Complexity
A	indexAction()	9	9	1
A	showAction()	9	9	1
A	newAction()	10	10	1
B	createAction()	23	23	4
A	editAction()	14	14	1
A	updateAction()	19	19	2
A	deleteAction()	11	11	2
A	createDeleteForm()	8	8	1

How to fix Duplicated Code

<?php

namespace AppBundle\Controller\Settings\Divers;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use AppBundle\Entity\ZoneStorage;
use AppBundle\Form\Type\ZoneStorageType;

/**
 * ZoneStorage controller.
 *
 * @Route("/admin/settings/divers/zonestorage")
 */
class ZoneStorageController extends Controller

{
    /**
     * Lists all ZoneStorage entities.
     *
     * @Route("/", name="admin_zonestorage")
     * @Method("GET")
     * @Template()
     */
    public function indexAction()
    {
        $em = $this->getDoctrine()->getManager();
        $entities = $em->getRepository('AppBundle:ZoneStorage')->findAll();
        
        return array(
            'entities'  => $entities,
        );
    }

    /**
     * Finds and displays a ZoneStorage entity.
     *
     * @Route("/{slug}/show", name="admin_zonestorage_show")
     * @Method("GET")
     * @Template()
     */
    public function showAction(ZoneStorage $zonestorage)
    {
        $deleteForm = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');

        return array(
            'zonestorage' => $zonestorage,
            'delete_form' => $deleteForm->createView(),
        );
    }

    /**
     * Displays a form to create a new ZoneStorage entity.
     *
     * @Route("/new", name="admin_zonestorage_new")
     * @Method("GET")
     * @Template()
     */
    public function newAction()
    {
        $zonestorage = new ZoneStorage();
        $form = $this->createForm(new ZoneStorageType(), $zonestorage);

        return array(
            'zonestorage' => $zonestorage,
            'form'   => $form->createView(),
        );
    }

    /**
     * Creates a new ZoneStorage entity.
     *
     * @Route("/create", name="admin_zonestorage_create")
     * @Method("POST")
     * @Template("AppBundle:Settings/Divers/ZoneStorage:new.html.twig")
     */
    public function createAction(Request $request)
    {
        $zonestorage = new ZoneStorage();
        $form = $this->createForm(new ZoneStorageType(), $zonestorage);
        if ($form->handleRequest($request)->isValid()) {
            $em = $this->getDoctrine()->getManager();
            $em->persist($zonestorage);
            $em->flush();

            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.
    }
}
                $url = $this->redirectToRoute('admin_znoestorage_show', array('slug' => $zonestorage->getSlug()));
            } elseif ($form->get('addmore')->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('info', 'gestock.settings.add_ok');
                $url = $this->redirect($this->generateUrl('admin_zonestorage_new'));
            }
            return $url;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }

        return array(
            'zonestorage' => $zonestorage,
            'form'   => $form->createView(),
        );
    }

    /**
     * Displays a form to edit an existing ZoneStorage entity.
     *
     * @Route("/{slug}/edit", name="admin_zonestorage_edit")
     * @Method("GET")
     * @Template()
     */
    public function editAction(ZoneStorage $zonestorage)
    {
        $editForm = $this->createForm(new ZoneStorageType(), $zonestorage, array(
            'action' => $this->generateUrl('admin_zonestorage_update', array('slug' => $zonestorage->getSlug())),
            'method' => 'PUT',
        ));
        $deleteForm = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');

        return array(
            'zonestorage' => $zonestorage,
            'edit_form'   => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),
        );
    }

    /**
     * Edits an existing ZoneStorage entity.
     *
     * @Route("/{slug}/update", name="admin_zonestorage_update")
     * @Method("PUT")
     * @Template("AppBundle:Settings/Divers/ZoneStorage:edit.html.twig")
     */
    public function updateAction(ZoneStorage $zonestorage, Request $request)
    {
        $editForm = $this->createForm(new ZoneStorageType(), $zonestorage, array(
            'action' => $this->generateUrl('admin_zonestorage_update', array('slug' => $zonestorage->getSlug())),
            'method' => 'PUT',
        ));
        if ($editForm->handleRequest($request)->isValid()) {
            $this->getDoctrine()->getManager()->flush();

            return $this->redirectToRoute('admin_zonestorage_edit', array('slug' => $zonestorage->getSlug()));
        }
        $deleteForm = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');

        return array(
            'zonestorage' => $zonestorage,
            'edit_form'   => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),
        );
    }

    /**
     * Deletes a ZoneStorage entity.
     *
     * @Route("/{id}/delete", name="admin_zonestorage_delete", requirements={"id"="\d+"})
     * @Method("DELETE")
     */
    public function deleteAction(ZoneStorage $zonestorage, Request $request)
    {
        $form = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');
        if ($form->handleRequest($request)->isValid()) {
            $em = $this->getDoctrine()->getManager();
            $em->remove($zonestorage);
            $em->flush();
        }

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

    /**
     * Create Delete form
     *
     * @param integer                       $id
     * @param string                        $route
     * @return \Symfony\Component\Form\Form
     */
    protected function createDeleteForm($id, $route)
    {
        return $this->createFormBuilder(null, array('attr' => array('id' => 'delete')))

            ->setAction($this->generateUrl($route, array('id' => $id)))
            ->setMethod('DELETE')
            ->getForm()
        ;
    }

}


1		<?php
2
3		namespace AppBundle\Controller\Settings\Divers;
4
5		use Symfony\Component\HttpFoundation\Request;
6		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
7		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
8		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
9		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
10		use AppBundle\Entity\ZoneStorage;
11		use AppBundle\Form\Type\ZoneStorageType;
12
13		/**
14		* ZoneStorage controller.
15		*
16		* @Route("/admin/settings/divers/zonestorage")
17		*/
18	View Code Duplication	class ZoneStorageController extends Controller
		1 ignored issue – show Duplication introduced 2016-04-03 01:17 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...
19		{
20		/**
21		* Lists all ZoneStorage entities.
22		*
23		* @Route("/", name="admin_zonestorage")
24		* @Method("GET")
25		* @Template()
26		*/
27		public function indexAction()
28		{
29		$em = $this->getDoctrine()->getManager();
30		$entities = $em->getRepository('AppBundle:ZoneStorage')->findAll();
31
32		return array(
33		'entities' => $entities,
34		);
35		}
36
37		/**
38		* Finds and displays a ZoneStorage entity.
39		*
40		* @Route("/{slug}/show", name="admin_zonestorage_show")
41		* @Method("GET")
42		* @Template()
43		*/
44		public function showAction(ZoneStorage $zonestorage)
45		{
46		$deleteForm = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');
47
48		return array(
49		'zonestorage' => $zonestorage,
50		'delete_form' => $deleteForm->createView(),
51		);
52		}
53
54		/**
55		* Displays a form to create a new ZoneStorage entity.
56		*
57		* @Route("/new", name="admin_zonestorage_new")
58		* @Method("GET")
59		* @Template()
60		*/
61		public function newAction()
62		{
63		$zonestorage = new ZoneStorage();
64		$form = $this->createForm(new ZoneStorageType(), $zonestorage);
65
66		return array(
67		'zonestorage' => $zonestorage,
68		'form' => $form->createView(),
69		);
70		}
71
72		/**
73		* Creates a new ZoneStorage entity.
74		*
75		* @Route("/create", name="admin_zonestorage_create")
76		* @Method("POST")
77		* @Template("AppBundle:Settings/Divers/ZoneStorage:new.html.twig")
78		*/
79		public function createAction(Request $request)
80		{
81		$zonestorage = new ZoneStorage();
82		$form = $this->createForm(new ZoneStorageType(), $zonestorage);
83		if ($form->handleRequest($request)->isValid()) {
84		$em = $this->getDoctrine()->getManager();
85		$em->persist($zonestorage);
86		$em->flush();
87
88		if ($form->get('save')->isClicked()) {
		0 ignored issues – show Bug introduced 2016-04-03 01:17 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...
89		$url = $this->redirectToRoute('admin_znoestorage_show', array('slug' => $zonestorage->getSlug()));
90		} elseif ($form->get('addmore')->isClicked()) {
		0 ignored issues – show Bug introduced 2016-04-03 01:17 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...
91		$this->addFlash('info', 'gestock.settings.add_ok');
92		$url = $this->redirect($this->generateUrl('admin_zonestorage_new'));
93		}
94		return $url;
		0 ignored issues – show Bug introduced 2016-04-03 01:17 UTC by Report Bug Copy Issue Report The variable `$url` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
95		}
96
97		return array(
98		'zonestorage' => $zonestorage,
99		'form' => $form->createView(),
100		);
101		}
102
103		/**
104		* Displays a form to edit an existing ZoneStorage entity.
105		*
106		* @Route("/{slug}/edit", name="admin_zonestorage_edit")
107		* @Method("GET")
108		* @Template()
109		*/
110		public function editAction(ZoneStorage $zonestorage)
111		{
112		$editForm = $this->createForm(new ZoneStorageType(), $zonestorage, array(
113		'action' => $this->generateUrl('admin_zonestorage_update', array('slug' => $zonestorage->getSlug())),
114		'method' => 'PUT',
115		));
116		$deleteForm = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');
117
118		return array(
119		'zonestorage' => $zonestorage,
120		'edit_form' => $editForm->createView(),
121		'delete_form' => $deleteForm->createView(),
122		);
123		}
124
125		/**
126		* Edits an existing ZoneStorage entity.
127		*
128		* @Route("/{slug}/update", name="admin_zonestorage_update")
129		* @Method("PUT")
130		* @Template("AppBundle:Settings/Divers/ZoneStorage:edit.html.twig")
131		*/
132		public function updateAction(ZoneStorage $zonestorage, Request $request)
133		{
134		$editForm = $this->createForm(new ZoneStorageType(), $zonestorage, array(
135		'action' => $this->generateUrl('admin_zonestorage_update', array('slug' => $zonestorage->getSlug())),
136		'method' => 'PUT',
137		));
138		if ($editForm->handleRequest($request)->isValid()) {
139		$this->getDoctrine()->getManager()->flush();
140
141		return $this->redirectToRoute('admin_zonestorage_edit', array('slug' => $zonestorage->getSlug()));
142		}
143		$deleteForm = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');
144
145		return array(
146		'zonestorage' => $zonestorage,
147		'edit_form' => $editForm->createView(),
148		'delete_form' => $deleteForm->createView(),
149		);
150		}
151
152		/**
153		* Deletes a ZoneStorage entity.
154		*
155		* @Route("/{id}/delete", name="admin_zonestorage_delete", requirements={"id"="\d+"})
156		* @Method("DELETE")
157		*/
158		public function deleteAction(ZoneStorage $zonestorage, Request $request)
159		{
160		$form = $this->createDeleteForm($zonestorage->getId(), 'admin_zonestorage_delete');
161		if ($form->handleRequest($request)->isValid()) {
162		$em = $this->getDoctrine()->getManager();
163		$em->remove($zonestorage);
164		$em->flush();
165		}
166
167		return $this->redirectToRoute('admin_zonestorage');
168		}
169
170		/**
171		* Create Delete form
172		*
173		* @param integer $id
174		* @param string $route
175		* @return \Symfony\Component\Form\Form
176		*/
177		protected function createDeleteForm($id, $route)
178		{
179		return $this->createFormBuilder(null, array('attr' => array('id' => 'delete')))
		0 ignored issues – show Bug introduced 2016-04-03 01:17 UTC by Report Bug Copy Issue Report The method `getForm()` does not exist on `Symfony\Component\Form\FormConfigBuilder`. Did you maybe mean `getFormConfig()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
180		->setAction($this->generateUrl($route, array('id' => $id)))
181		->setMethod('DELETE')
182		->getForm()
183		;
184		}
185
186		}
187

Dev-Int / glsr

Push — sf2.7 ( 76dc64...d0498a )

ZoneStorageController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like