UserController::saveFilter() - Code Metrics - Inspection of "Sf2.7 to master (Sf2.3)" - Dev-Int/glsr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#45)

by Laurent

created 2016-05-10 19:49 UTC

UserController::saveFilter() B

↳ Parent: UserController

Complexity

Conditions	7
Paths	4

Size

Total Lines	20
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	5
Bugs	2	Features	1

Metric	Value
c	5
b	2
f	1
dl	0
loc	20
rs	8.2222
cc	7
eloc	14
nc	4
nop	5

<?php
/**
 * UserController controller des utilisateurs.
 *
 * PHP Version 5
 *
 * @author    Quétier Laurent <[email protected]>
 * @copyright 2014 Dev-Int GLSR
 * @license   http://opensource.org/licenses/gpl-license.php GNU Public License
 *
 * @version   since 1.0.0
 *
 * @link      https://github.com/Dev-Int/glsr
 */
namespace AppBundle\Controller;

use Symfony\Component\HttpFoundation\Request;
use AppBundle\Controller\AbstractController;
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.
 *
 * @category Controller
 *
 * @Route("/admin/users")
 */
class UserController extends AbstractController
{
    /**
     * 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->redirectToRoute('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->redirectToRoute('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->redirectToRoute('admin_users');
    }

    /**
     * Save filters
     *
     * @param  FormInterface $form
     * @param  string        $name    route/entity name
     * @param  string        $route   route name, if different from entity name
     * @param  Request       $request Request
     * @param  array         $params  possible route parameters
     * @return Response
     */
    protected function saveFilter(
        FormInterface $form,
        $name,
        $route = null,
        Request $request = null,
        array $params = null
    ) {
        $url = $this->generateUrl($route ?: $name, is_null($params) ? array() : $params);
        if (isset($request)) {
            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->redirectToRoute('admin_users');
    }
}


1		<?php
2		/**
3		* UserController controller des utilisateurs.
4		*
5		* PHP Version 5
6		*
7		* @author Quétier Laurent <[email protected]>
8		* @copyright 2014 Dev-Int GLSR
9		* @license http://opensource.org/licenses/gpl-license.php GNU Public License
10		*
11		* @version since 1.0.0
12		*
13		* @link https://github.com/Dev-Int/glsr
14		*/
15		namespace AppBundle\Controller;
16
17		use Symfony\Component\HttpFoundation\Request;
18		use AppBundle\Controller\AbstractController;
19		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
20		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
21		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
22		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
23		use AppBundle\Entity\User;
24		use AppBundle\Form\Type\UserType;
25		use AppBundle\Form\Type\UserFilterType;
26		use Symfony\Component\Form\FormInterface;
27		use Doctrine\ORM\QueryBuilder;
28
29		/**
30		* User controller.
31		*
32		* @category Controller
33		*
34		* @Route("/admin/users")
35		*/
36		class UserController extends AbstractController
37		{
38		/**
39		* Lists all User entities.
40		*
41		* @Route("/", name="admin_users")
42		* @Method("GET")
43		* @Template()
44		*/
45		public function indexAction()
46		{
47		$em = $this->getDoctrine()->getManager();
48		$form = $this->createForm(new UserFilterType());
49		if (!is_null($response = $this->saveFilter($form, 'user', 'admin_users'))) {
50		return $response;
51		}
52		$qb = $em->getRepository('AppBundle:User')->createQueryBuilder('u');
53		$paginator = $this->filter($form, $qb, 'user');
54
55		return array(
56		'form' => $form->createView(),
57		'paginator' => $paginator,
58		);
59		}
60
61		/**
62		* Finds and displays a User entity.
63		*
64		* @Route("/{id}/show", name="admin_users_show", requirements={"id"="\d+"})
65		* @Method("GET")
66		* @Template()
67		*/
68		public function showAction(User $user)
69		{
70		$deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');
71
72		return array(
73		'user' => $user,
74		'delete_form' => $deleteForm->createView(),
75		);
76		}
77
78		/**
79		* Displays a form to create a new User entity.
80		*
81		* @Route("/new", name="admin_users_new")
82		* @Method("GET")
83		* @Template()
84		*/
85		public function newAction()
86		{
87		$user = new User();
88		$form = $this->createForm(new UserType(), $user);
89
90		return array(
91		'user' => $user,
92		'form' => $form->createView(),
93		);
94		}
95
96		/**
97		* Creates a new User entity.
98		*
99		* @Route("/create", name="admin_users_create")
100		* @Method("POST")
101		* @Template("AppBundle:User:new.html.twig")
102		*/
103		public function createAction(Request $request)
104		{
105		$user = new User();
106		$form = $this->createForm(new UserType(), $user);
107		if ($form->handleRequest($request)->isValid()) {
108		$user->setEnabled(true);
109		$userManager = $this->get('fos_user.user_manager');
110		$userManager->updateUser($user);
111
112		return $this->redirectToRoute('admin_users_show', array('id', $user->getId()));
113		}
114
115		return array(
116		'user' => $user,
117		'form' => $form->createView(),
118		);
119		}
120
121		/**
122		* Displays a form to edit an existing User entity.
123		*
124		* @Route("/{id}/edit", name="admin_users_edit", requirements={"id"="\d+"})
125		* @Method("GET")
126		* @Template()
127		*/
128		public function editAction(User $user)
129		{
130		$editForm = $this->createForm(new UserType(), $user, array(
131		'action' => $this->generateUrl('admin_users_update', array('id' => $user->getId())),
132		'method' => 'PUT',
133		'passwordRequired' => false,
134		'lockedRequired' => true
135		));
136		$deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');
137
138		return array(
139		'user' => $user,
140		'edit_form' => $editForm->createView(),
141		'delete_form' => $deleteForm->createView(),
142		);
143		}
144
145		/**
146		* Edits an existing User entity.
147		*
148		* @Route("/{id}/update", name="admin_users_update", requirements={"id"="\d+"})
149		* @Method("PUT")
150		* @Template("AppBundle:User:edit.html.twig")
151		*/
152	View Code Duplication	public function updateAction(User $user, Request $request)
		0 ignored issues – show Duplication introduced 2016-04-02 10:57 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...
153		{
154		$editForm = $this->createForm(new UserType(), $user, array(
155		'action' => $this->generateUrl('admin_users_update', array('id' => $user->getId())),
156		'method' => 'PUT',
157		'passwordRequired' => false,
158		'lockedRequired' => true
159		));
160		if ($editForm->handleRequest($request)->isValid()) {
161		$userManager = $this->get('fos_user.user_manager');
162		$userManager->updateUser($user);
163
164		return $this->redirectToRoute('admin_users_edit', array('id' => $user->getId()));
165		}
166		$deleteForm = $this->createDeleteForm($user->getId(), 'admin_users_delete');
167
168		return array(
169		'user' => $user,
170		'edit_form' => $editForm->createView(),
171		'delete_form' => $deleteForm->createView(),
172		);
173		}
174
175
176		/**
177		* Save order.
178		*
179		* @Route("/order/{field}/{type}", name="admin_users_sort")
180		*/
181		public function sortAction($field, $type)
182		{
183		$this->setOrder('user', $field, $type);
184
185		return $this->redirectToRoute('admin_users');
186		}
187
188		/**
189		* Save filters
190		*
191		* @param FormInterface $form
192		* @param string $name route/entity name
193		* @param string $route route name, if different from entity name
194		* @param Request $request Request
195		* @param array $params possible route parameters
196		* @return Response
197		*/
198		protected function saveFilter(
199		FormInterface $form,
200		$name,
201		$route = null,
202		Request $request = null,
203		array $params = null
204		) {
205		$url = $this->generateUrl($route ?: $name, is_null($params) ? array() : $params);
206		if (isset($request)) {
207		if ($request->query->has('submit-filter') && $form->handleRequest($request)->isValid()) {
208		$request->getSession()->set('filter.' . $name, $request->query->get($form->getName()));
209
210		return $this->redirect($url);
211		} elseif ($request->query->has('reset-filter')) {
212		$request->getSession()->set('filter.' . $name, null);
213
214		return $this->redirect($url);
215		}
216		}
217		}
218
219		/**
220		* Filter form
221		*
222		* @param FormInterface $form
223		* @param QueryBuilder $qb
224		* @param string $name
225		* @return \Knp\Component\Pager\Pagination\PaginationInterface
226		*/
227		protected function filter(FormInterface $form, QueryBuilder $qb, $name)
228		{
229		if (!is_null($values = $this->getFilter($name))) {
230		if ($form->submit($values)->isValid()) {
231		$this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb);
232		}
233		}
234
235		// possible sorting
236		$this->addQueryBuilderSort($qb, $name);
237		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...
238		}
239
240		/**
241		* Get filters from session
242		*
243		* @param string $name
244		* @return array
245		*/
246		protected function getFilter($name)
247		{
248		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...
249		}
250
251		/**
252		* Deletes a User entity.
253		*
254		* @Security("has_role('ROLE_SUPER_ADMIN')")
255		* @Route("/{id}/delete", name="admin_users_delete", requirements={"id"="\d+"})
256		* @Method("DELETE")
257		*/
258		public function deleteAction(User $user, Request $request)
259		{
260		$form = $this->createDeleteForm($user->getId(), 'admin_users_delete');
261		if ($form->handleRequest($request)->isValid()) {
262		$em = $this->getDoctrine()->getManager();
263		$em->remove($user);
264		$em->flush();
265		}
266
267		return $this->redirectToRoute('admin_users');
268		}
269		}
270

Dev-Int / glsr

Pull Request — master (#45)

UserController::saveFilter() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like