UserController::saveFilter() - Code Metrics - Inspection of "Add Listener to change submit button" - Dev-Int/glsr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — sf2.7 ( 18de34...b252b6 )

by Laurent

created 2016-03-27 21:42 UTC

UserController::saveFilter() B

↳ Parent: UserController

Complexity

Conditions	6
Paths	3

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	14
rs	8.8571
cc	6
eloc	9
nc	3
nop	4

<?php

namespace AppBundle\Controller;

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 Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use AppBundle\Entity\User;
use AppBundle\Form\Type\UserType;
use AppBundle\Form\Type\UserFilterType;
use Symfony\Component\Form\FormInterface;
use Doctrine\ORM\QueryBuilder;

/**
 * User controller.
 *
 * @Route("/admin/users")
 */
class UserController extends Controller
{
    /**
     * Lists all User entities.
     *
     * @Route("/", name="admin_users")
     * @Method("GET")
     * @Template()
     */
    public function indexAction()
    {
        $em = $this->getDoctrine()->getManager();
        $form = $this->createForm(new UserFilterType());
        if (!is_null($response = $this->saveFilter($form, 'user', 'admin_users'))) {
            return $response;
        }
        $qb = $em->getRepository('AppBundle:User')->createQueryBuilder('u');
        $paginator = $this->filter($form, $qb, 'user');
        
        return array(
            'form'      => $form->createView(),
            'paginator' => $paginator,
        );
    }

    /**
     * Finds and displays a User entity.
     *
     * @Route("/{id}/show", name="admin_users_show", requirements={"id"="\d+"})
     * @Method("GET")
     * @Template()
     */
    public function showAction(User $user)
    {
        $deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');

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

    /**
     * Displays a form to create a new User entity.
     *
     * @Route("/new", name="admin_users_new")
     * @Method("GET")
     * @Template()
     */
    public function newAction()
    {
        $user = new User();
        $form = $this->createForm(new UserType(), $user);

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

    /**
     * Creates a new User entity.
     *
     * @Route("/create", name="admin_users_create")
     * @Method("POST")
     * @Template("AppBundle:User:new.html.twig")
     */
    public function createAction(Request $request)
    {
        $user = new User();
        $form = $this->createForm(new UserType(), $user);
        if ($form->handleRequest($request)->isValid()) {

            $user->setEnabled(true);
            $userManager = $this->get('fos_user.user_manager');
            $userManager->updateUser($user);

            return $this->redirect(
                $this->generateUrl(
                    'admin_users_show',
                    array('id' => $user->getId())
                )
            );
        }

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

    /**
     * Displays a form to edit an existing User entity.
     *
     * @Route("/{id}/edit", name="admin_users_edit", requirements={"id"="\d+"})
     * @Method("GET")
     * @Template()
     */
    public function editAction(User $user)
    {
        $editForm = $this->createForm(new UserType(), $user, array(
            'action' => $this->generateUrl('admin_users_update', array('id' => $user->getId())),
            'method' => 'PUT',
            'passwordRequired' => false,
            'lockedRequired' => true
        ));
        $deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');
 
        return array(
            'user' => $user,
            'edit_form'   => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),
        );
    }

    /**
     * Edits an existing User entity.
     *
     * @Route("/{id}/update", name="admin_users_update", requirements={"id"="\d+"})
     * @Method("PUT")
     * @Template("AppBundle:User:edit.html.twig")
     */
    public function updateAction(User $user, Request $request)
    {
        $editForm = $this->createForm(new UserType(), $user, array(
            'action' => $this->generateUrl('admin_users_update', array('id' => $user->getId())),
            'method' => 'PUT',
            'passwordRequired' => false,
            'lockedRequired' => true
        ));
        if ($editForm->handleRequest($request)->isValid()) {

            $userManager = $this->get('fos_user.user_manager');
            $userManager->updateUser($user);

            return $this->redirect($this->generateUrl('admin_users_edit', array('id' => $user->getId())));
        }
        $deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');

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


    /**
     * Save order.
     *
     * @Route("/order/{field}/{type}", name="admin_users_sort")
     */
    public function sortAction($field, $type)
    {
        $this->setOrder('user', $field, $type);

        return $this->redirect($this->generateUrl('admin_users'));
    }

    /**
     * @param string $name  session name
     * @param string $field field name
     * @param string $type  sort type ("ASC"/"DESC")
     */
    protected function setOrder($name, $field, $type = 'ASC')
    {
        $this->getRequest()->getSession()->set('sort.' . $name, array('field' => $field, 'type' => $type));

    }

    /**
     * @param  string $name
     * @return array
     */
    protected function getOrder($name)
    {
        $session = $this->getRequest()->getSession();


        return $session->has('sort.' . $name) ? $session->get('sort.' . $name) : null;
    }

    /**
     * @param QueryBuilder $qb
     * @param string       $name
     */
    protected function addQueryBuilderSort(QueryBuilder $qb, $name)

    {
        $alias = current($qb->getDQLPart('from'))->getAlias();
        if (is_array($order = $this->getOrder($name))) {
            $qb->orderBy($alias . '.' . $order['field'], $order['type']);
        }
    }

    /**
     * Save filters
     *
     * @param  FormInterface $form
     * @param  string        $name   route/entity name
     * @param  string        $route  route name, if different from entity name
     * @param  array         $params possible route parameters
     * @return Response
     */
    protected function saveFilter(FormInterface $form, $name, $route = null, array $params = null)
    {
        $request = $this->getRequest();

        $url = $this->generateUrl($route ?: $name, is_null($params) ? array() : $params);
        if ($request->query->has('submit-filter') && $form->handleRequest($request)->isValid()) {
            $request->getSession()->set('filter.' . $name, $request->query->get($form->getName()));

            return $this->redirect($url);
        } elseif ($request->query->has('reset-filter')) {
            $request->getSession()->set('filter.' . $name, null);

            return $this->redirect($url);
        }
    }

    /**
     * Filter form
     *
     * @param  FormInterface                                       $form
     * @param  QueryBuilder                                        $qb
     * @param  string                                              $name
     * @return \Knp\Component\Pager\Pagination\PaginationInterface
     */
    protected function filter(FormInterface $form, QueryBuilder $qb, $name)
    {
        if (!is_null($values = $this->getFilter($name))) {
            if ($form->submit($values)->isValid()) {
                $this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb);
            }
        }

        // possible sorting
        $this->addQueryBuilderSort($qb, $name);
        return $this->get('knp_paginator')->paginate($qb, $this->getRequest()->query->get('page', 1), 20);

    }

    /**
     * Get filters from session
     *
     * @param  string $name
     * @return array
     */
    protected function getFilter($name)
    {
        return $this->getRequest()->getSession()->get('filter.' . $name);

    }

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

        return $this->redirect($this->generateUrl('admin_users'));
    }

    /**
     * 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;
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 Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
11		use AppBundle\Entity\User;
12		use AppBundle\Form\Type\UserType;
13		use AppBundle\Form\Type\UserFilterType;
14		use Symfony\Component\Form\FormInterface;
15		use Doctrine\ORM\QueryBuilder;
16
17		/**
18		* User controller.
19		*
20		* @Route("/admin/users")
21		*/
22		class UserController extends Controller
23		{
24		/**
25		* Lists all User entities.
26		*
27		* @Route("/", name="admin_users")
28		* @Method("GET")
29		* @Template()
30		*/
31		public function indexAction()
32		{
33		$em = $this->getDoctrine()->getManager();
34		$form = $this->createForm(new UserFilterType());
35		if (!is_null($response = $this->saveFilter($form, 'user', 'admin_users'))) {
36		return $response;
37		}
38		$qb = $em->getRepository('AppBundle:User')->createQueryBuilder('u');
39		$paginator = $this->filter($form, $qb, 'user');
40
41		return array(
42		'form' => $form->createView(),
43		'paginator' => $paginator,
44		);
45		}
46
47		/**
48		* Finds and displays a User entity.
49		*
50		* @Route("/{id}/show", name="admin_users_show", requirements={"id"="\d+"})
51		* @Method("GET")
52		* @Template()
53		*/
54		public function showAction(User $user)
55		{
56		$deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');
57
58		return array(
59		'user' => $user,
60		'delete_form' => $deleteForm->createView(),
61		);
62		}
63
64		/**
65		* Displays a form to create a new User entity.
66		*
67		* @Route("/new", name="admin_users_new")
68		* @Method("GET")
69		* @Template()
70		*/
71		public function newAction()
72		{
73		$user = new User();
74		$form = $this->createForm(new UserType(), $user);
75
76		return array(
77		'user' => $user,
78		'form' => $form->createView(),
79		);
80		}
81
82		/**
83		* Creates a new User entity.
84		*
85		* @Route("/create", name="admin_users_create")
86		* @Method("POST")
87		* @Template("AppBundle:User:new.html.twig")
88		*/
89		public function createAction(Request $request)
90		{
91		$user = new User();
92		$form = $this->createForm(new UserType(), $user);
93	View Code Duplication	if ($form->handleRequest($request)->isValid()) {
		0 ignored issues – show Duplication introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
94		$user->setEnabled(true);
95		$userManager = $this->get('fos_user.user_manager');
96		$userManager->updateUser($user);
97
98		return $this->redirect(
99		$this->generateUrl(
100		'admin_users_show',
101		array('id' => $user->getId())
102		)
103		);
104		}
105
106		return array(
107		'user' => $user,
108		'form' => $form->createView(),
109		);
110		}
111
112		/**
113		* Displays a form to edit an existing User entity.
114		*
115		* @Route("/{id}/edit", name="admin_users_edit", requirements={"id"="\d+"})
116		* @Method("GET")
117		* @Template()
118		*/
119		public function editAction(User $user)
120		{
121		$editForm = $this->createForm(new UserType(), $user, array(
122		'action' => $this->generateUrl('admin_users_update', array('id' => $user->getId())),
123		'method' => 'PUT',
124		'passwordRequired' => false,
125		'lockedRequired' => true
126		));
127		$deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');
128
129		return array(
130		'user' => $user,
131		'edit_form' => $editForm->createView(),
132		'delete_form' => $deleteForm->createView(),
133		);
134		}
135
136		/**
137		* Edits an existing User entity.
138		*
139		* @Route("/{id}/update", name="admin_users_update", requirements={"id"="\d+"})
140		* @Method("PUT")
141		* @Template("AppBundle:User:edit.html.twig")
142		*/
143		public function updateAction(User $user, Request $request)
144		{
145		$editForm = $this->createForm(new UserType(), $user, array(
146		'action' => $this->generateUrl('admin_users_update', array('id' => $user->getId())),
147		'method' => 'PUT',
148		'passwordRequired' => false,
149		'lockedRequired' => true
150		));
151	View Code Duplication	if ($editForm->handleRequest($request)->isValid()) {
		0 ignored issues – show Duplication introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
152		$userManager = $this->get('fos_user.user_manager');
153		$userManager->updateUser($user);
154
155		return $this->redirect($this->generateUrl('admin_users_edit', array('id' => $user->getId())));
156		}
157		$deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');
158
159		return array(
160		'user' => $user,
161		'edit_form' => $editForm->createView(),
162		'delete_form' => $deleteForm->createView(),
163		);
164		}
165
166
167		/**
168		* Save order.
169		*
170		* @Route("/order/{field}/{type}", name="admin_users_sort")
171		*/
172		public function sortAction($field, $type)
173		{
174		$this->setOrder('user', $field, $type);
175
176		return $this->redirect($this->generateUrl('admin_users'));
177		}
178
179		/**
180		* @param string $name session name
181		* @param string $field field name
182		* @param string $type sort type ("ASC"/"DESC")
183		*/
184		protected function setOrder($name, $field, $type = 'ASC')
185		{
186		$this->getRequest()->getSession()->set('sort.' . $name, array('field' => $field, 'type' => $type));
		0 ignored issues – show Deprecated Code introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report The method `Symfony\Bundle\Framework...ontroller::getRequest()` has been deprecated with message: since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
187		}
188
189		/**
190		* @param string $name
191		* @return array
192		*/
193		protected function getOrder($name)
194		{
195		$session = $this->getRequest()->getSession();
		0 ignored issues – show Deprecated Code introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report The method `Symfony\Bundle\Framework...ontroller::getRequest()` has been deprecated with message: since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
196
197		return $session->has('sort.' . $name) ? $session->get('sort.' . $name) : null;
198		}
199
200		/**
201		* @param QueryBuilder $qb
202		* @param string $name
203		*/
204	View Code Duplication	protected function addQueryBuilderSort(QueryBuilder $qb, $name)
		0 ignored issues – show Duplication introduced 2016-03-27 22: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...
205		{
206		$alias = current($qb->getDQLPart('from'))->getAlias();
207		if (is_array($order = $this->getOrder($name))) {
208		$qb->orderBy($alias . '.' . $order['field'], $order['type']);
209		}
210		}
211
212		/**
213		* Save filters
214		*
215		* @param FormInterface $form
216		* @param string $name route/entity name
217		* @param string $route route name, if different from entity name
218		* @param array $params possible route parameters
219		* @return Response
220		*/
221		protected function saveFilter(FormInterface $form, $name, $route = null, array $params = null)
222		{
223		$request = $this->getRequest();
		0 ignored issues – show Deprecated Code introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report The method `Symfony\Bundle\Framework...ontroller::getRequest()` has been deprecated with message: since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
224		$url = $this->generateUrl($route ?: $name, is_null($params) ? array() : $params);
225		if ($request->query->has('submit-filter') && $form->handleRequest($request)->isValid()) {
226		$request->getSession()->set('filter.' . $name, $request->query->get($form->getName()));
227
228		return $this->redirect($url);
229		} elseif ($request->query->has('reset-filter')) {
230		$request->getSession()->set('filter.' . $name, null);
231
232		return $this->redirect($url);
233		}
234		}
235
236		/**
237		* Filter form
238		*
239		* @param FormInterface $form
240		* @param QueryBuilder $qb
241		* @param string $name
242		* @return \Knp\Component\Pager\Pagination\PaginationInterface
243		*/
244		protected function filter(FormInterface $form, QueryBuilder $qb, $name)
245		{
246		if (!is_null($values = $this->getFilter($name))) {
247		if ($form->submit($values)->isValid()) {
248		$this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb);
249		}
250		}
251
252		// possible sorting
253		$this->addQueryBuilderSort($qb, $name);
254		return $this->get('knp_paginator')->paginate($qb, $this->getRequest()->query->get('page', 1), 20);
		0 ignored issues – show Deprecated Code introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report The method `Symfony\Bundle\Framework...ontroller::getRequest()` has been deprecated with message: since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
255		}
256
257		/**
258		* Get filters from session
259		*
260		* @param string $name
261		* @return array
262		*/
263		protected function getFilter($name)
264		{
265		return $this->getRequest()->getSession()->get('filter.' . $name);
		0 ignored issues – show Deprecated Code introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report The method `Symfony\Bundle\Framework...ontroller::getRequest()` has been deprecated with message: since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
266		}
267
268		/**
269		* Deletes a User entity.
270		*
271		* @Security("has_role('ROLE_SUPER_ADMIN')")
272		* @Route("/{id}/delete", name="admin_users_delete", requirements={"id"="\d+"})
273		* @Method("DELETE")
274		*/
275		public function deleteAction(User $user, Request $request)
276		{
277		$form = $this->createDeleteForm($user->getId(), 'admin_users_delete');
278		if ($form->handleRequest($request)->isValid()) {
279		$em = $this->getDoctrine()->getManager();
280		$em->remove($user);
281		$em->flush();
282		}
283
284		return $this->redirect($this->generateUrl('admin_users'));
285		}
286
287		/**
288		* Create Delete form
289		*
290		* @param integer $id
291		* @param string $route
292		* @return \Symfony\Component\Form\Form
293		*/
294		protected function createDeleteForm($id, $route)
295		{
296		return $this->createFormBuilder(null, array('attr' => array('id' => 'delete')))
		0 ignored issues – show Bug introduced 2016-03-27 22:01 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...
297		->setAction($this->generateUrl($route, array('id' => $id)))
298		->setMethod('DELETE')
299		->getForm()
300		;
301		}
302
303		}
304

Dev-Int / glsr

Push — sf2.7 ( 18de34...b252b6 )

UserController::saveFilter() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like