AppBundle\Controller\AbstractController

Complexity

Total Complexity

39

Size/Duplication

Total Lines	327
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes	3
Bugs	0	Features	1

14 Methods

Rating	Name	Duplication	Size	Complexity
A	abstractIndexAction()	0	14	4
A	abstractShowAction()	0	6	1
B	abstractNewAction()	0	20	5
B	abstractCreateAction()	0	24	4
A	abstractEditAction()	0	15	2
B	abstractUpdateAction()	0	25	3
A	abstractDeleteAction()	0	9	2
A	abstractDeleteWithArticlesAction()	0	18	3
B	addQueryBuilderSort()	0	18	5
A	createDeleteForm()	0	8	1
A	testReturnParam()	0	11	2
A	getExistingRoles()	0	11	2
A	addRolesAction()	0	8	1
A	getEntity()	0	16	4

<?php
/**
 * AbstractController controller des méthodes communes.
 *
 * PHP Version 5
 *
 * @author    Quétier Laurent <lq@dev-int.net>
 * @copyright 2014 Dev-Int GLSR
 * @license   http://opensource.org/licenses/gpl-license.php GNU Public License
 *
 * @version GIT: <git_id>
 *
 * @link      https://github.com/Dev-Int/glsr
 */
namespace AppBundle\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\ORM\QueryBuilder;

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;

/**
 * Abstract controller.
 *
 * @category Controller
 */
abstract class AbstractController extends Controller
{
    /**
     * Lists all items entity.
     *
     * @param string $entityName Name of Entity
     * @param string $prefixRoute  prefix_route
     * @param \Symfony\Component\HttpFoundation\Request $request Sort request
     * @return array
     */
    public function abstractIndexAction($entityName, $prefixRoute, Request $request = null)
    {
        $etm = $this->getDoctrine()->getManager();
        $paginator = '';
        $entities = $this->getEntity($entityName, $etm);
        
        if ($request !== null && is_array($entities) === false && $entities !== null) {
            $item = $this->container->getParameter('knp_paginator.page_range');
            $this->addQueryBuilderSort($entities, $prefixRoute);
            $paginator = $this->get('knp_paginator')->paginate($entities, $request->query->get('page', 1), $item);
        }

        return ['entities'  => $entities, 'ctEntity' => count($entities), 'paginator' => $paginator,];
    }

    /**
     * Finds and displays an item entity.
     *
     * @param Object $entity      Entity
     * @param string $prefixRoute prefix_route
     * @return array
     */
    public function abstractShowAction($entity, $prefixRoute)
    {
        $deleteForm = $this->createDeleteForm($entity->getId(), $prefixRoute.'_delete');

        return [$prefixRoute => $entity, 'delete_form' => $deleteForm->createView(),];
    }

    /**
     * Displays a form to create a new item entity.
     *
     * @param string $entityName  Name of Entity
     * @param string $entityPath  Path of Entity
     * @param string $typePath    Path of FormType
     * @param string $prefixRoute Prefix of Route
     * @return array
     */
    public function abstractNewAction($entityName, $entityPath, $typePath, $prefixRoute)
    {
        $etm = $this->getDoctrine()->getManager();
        $ctEntity = count($etm->getRepository('AppBundle:'.$entityName)->findAll());
        
        if ($entityName === 'Settings\Company' || $entityName === 'Settings\Settings' && $ctEntity >= 1) {
            $return = $this->redirectToRoute('_home');
            $this->addFlash('danger', 'gestock.settings.'.$prefixRoute.'.add2');
        }

        $entityNew = $etm->getClassMetadata($entityPath)->newInstance();
        $form = $this->createForm($typePath, $entityNew, ['action' => $this->generateUrl($prefixRoute.'_create'),]);

        if ($entityName === 'Group') {
            $this->addRolesAction($form, $entityNew);
        }
        $return = [strtolower($entityName) => $entityNew, 'form'   => $form->createView(),];

        return $return;
    }

    /**
     * Creates a new item entity.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request   Request in progress
     * @param string $entityName  Entity name <i>First letter Upper</i>
     * @param string $entityPath  Path of Entity
     * @param string $typePath    Path of FormType
     * @param string $prefixRoute Prefix of route
     * @return array
     */
    public function abstractCreateAction(Request $request, $entityName, $entityPath, $typePath, $prefixRoute)
    {
        $etm = $this->getDoctrine()->getManager();
        $entityNew = $etm->getClassMetadata($entityPath)->newInstance();
        $form = $this->createForm($typePath, $entityNew, ['action' => $this->generateUrl($prefixRoute.'_create'),]);
        if ($entityName === 'Staff\Group') {
            $this->addRolesAction($form, $entityNew);
        }
        $form->handleRequest($request);
        $return = [$entityName => $entityNew, 'form' => $form->createView(),];

        if ($form->isValid()) {
            $etm = $this->getDoctrine()->getManager();
            $etm->persist($entityNew);
            $etm->flush();

            $param = $this->testReturnParam($entityNew, $prefixRoute);
            $route = $form->get('addmore')->isClicked() ? $prefixRoute.'_new' : $prefixRoute.'_show';

            $return = $this->redirectToRoute($route, $param);
        }

        return $return;
    }

    /**
     * Displays a form to edit an existing item entity.
     *
     * @param Object $entity      Entity
     * @param string $prefixRoute Prefix of Route
     * @param string $typePath    Path of FormType
     * @return array
     */
    public function abstractEditAction($entity, $prefixRoute, $typePath)
    {
        $param = $this->testReturnParam($entity, $prefixRoute);
        $editForm = $this->createForm($typePath, $entity, array(
            'action' => $this->generateUrl($prefixRoute.'_update', $param),
            'method' => 'PUT',
        ));
        if ($prefixRoute === 'group') {
            $this->addRolesAction($editForm, $entity);
        }
        $deleteForm = $this->createDeleteForm($entity->getId(), $prefixRoute.'_delete');

        return [$prefixRoute => $entity, 'edit_form' => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),];
    }

    /**
     * Edits an existing item entity.
     *
     * @param Object $entity      Entity
     * @param \Symfony\Component\HttpFoundation\Request $request Request in progress
     * @param string $prefixRoute Prefix of Route
     * @param string $typePath    Path of FormType
     * @return array
     */
    public function abstractUpdateAction($entity, Request $request, $prefixRoute, $typePath)
    {
        $param = $this->testReturnParam($entity, $prefixRoute);
        $editForm = $this->createForm($typePath, $entity, array(
            'action' => $this->generateUrl($prefixRoute.'_update', $param),
            'method' => 'PUT',
        ));
        if ($prefixRoute === 'group') {
            $this->addRolesAction($editForm, $entity);
        }
        $editForm->handleRequest($request);
        $deleteForm = $this->createDeleteForm($entity->getId(), $prefixRoute.'_delete');

        $return = [$prefixRoute => $entity, 'edit_form' => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),];

        if ($editForm->isValid()) {
            $this->getDoctrine()->getManager()->flush();
            $this->addFlash('info', 'gestock.edit.ok');

            $return = $this->redirectToRoute($prefixRoute.'_edit', $param);
        }

        return $return;
    }

    /**
     * Deletes an item entity.
     *
     * @param Object $entity      Entity
     * @param \Symfony\Component\HttpFoundation\Request $request Request in progress
     * @param string $prefixRoute Prefix of Route
     * @return array
     */
    public function abstractDeleteAction($entity, Request $request, $prefixRoute)
    {
        $form = $this->createDeleteForm($entity->getId(), $prefixRoute.'_delete');
        if ($form->handleRequest($request)->isValid()) {
            $etm = $this->getDoctrine()->getManager();
            $etm->remove($entity);
            $etm->flush();
        }
    }

    /**
     * Deletes a item entity with Articles.
     *
     * @param Object $entity     Entity
     * @param \Symfony\Component\HttpFoundation\Request $request   Request in progress
     * @param string $entityName Name of Entity
     * @param string $prefixRoute Prefix of Route
     * @return array
     */
    public function abstractDeleteWithArticlesAction($entity, Request $request, $entityName, $prefixRoute)
    {
        $etm = $this->getDoctrine()->getManager();
        $form = $this->createDeleteForm($entity->getId(), $prefixRoute . '_delete');
        $entityArticles = $etm
            ->getRepository('AppBundle:' .  $entityName . 'Articles')
            ->findBy([$prefixRoute => $entity->getId()]);

        if ($form->handleRequest($request)->isValid()) {
            foreach ($entityArticles as $article) {
                $etm->remove($article);
            }
            $etm->remove($entity);
            $etm->flush();
        }

        return $this->redirect($this->generateUrl($prefixRoute));
    }

    /**
     * AddQueryBuilderSort for the SortAction in views.
     *
     * @param QueryBuilder $qbd
     * @param string       $name
     */
    protected function addQueryBuilderSort(QueryBuilder $qbd, $name)
    {
        $alias = '';
        if (is_array($order = $this->get('app.helper.controller')->getOrder($name))) {
            if ($name !== $order['entity']) {
                $rootAlias = current($qbd->getDQLPart('from'))->getAlias();
                $join = current($qbd->getDQLPart('join'));
                foreach ($join as $item) {
                    if ($item->getJoin() === $rootAlias.'.'.$order['entity']) {
                        $alias = $item->getAlias();
                    }
                }
            } else {
                $alias = current($qbd->getDQLPart('from'))->getAlias();
            }
            $qbd->orderBy($alias . '.' . $order['field'], $order['type']);
        }
    }

    /**
     * Create Delete form.
     *
     * @param int    $id
     * @param string $route
     *
     * @return \Symfony\Component\Form\Form
     */
    protected function createDeleteForm($id, $route)
    {
        return $this->createFormBuilder(null, ['attr' => ['id' => 'delete']])
            ->setAction($this->generateUrl($route, ['id' => $id]))
            ->setMethod('DELETE')
            ->getForm()
        ;
    }

    /**
     * Test paramters to return.
     *
     * @param object $entity     Entity to return
     * @param string $prefixRoute Entity name to test
     * @return array Parameters to return
     */
    protected function testReturnParam($entity, $prefixRoute)
    {
        $entityArray = ['article', 'supplier', 'familylog', 'zonestorage', 'unitstorage', 'material',];
        if (in_array($prefixRoute, $entityArray, true)) {
            $param = ['slug' => $entity->getSlug()];
        } else {
            $param = ['id' => $entity->getId()];
        }

        return $param;
    }

    /**
     * Get the existing roles
     *
     * @return array Array of roles
     */
    private function getExistingRoles()
    {
        $roleHierarchy = $this->container->getParameter('security.role_hierarchy.roles');
        $roles = array_keys($roleHierarchy);
        $theRoles = array();

        foreach ($roles as $role) {
            $theRoles[$role] = $role;
        }
        return $theRoles;
    }

    /**
     * Add roles to form
     *
     * @param \Symfony\Component\Form\Form  $form  The form in which to insert the roles
     * @param \AppBundle\Entity\Staff\Group $group The entity to deal
     * @return \Symfony\Component\Form\Form The form
     */
    public function addRolesAction($form, $group)
    {
        $form->add('roles', ChoiceType::class, ['choices' => $this->getExistingRoles(), 'choices_as_values' => true,
            'data' => $group->getRoles(), 'label' => 'Roles', 'expanded' => true, 'multiple' => true, 'mapped' => true,
        ]);

        return $form;
    }

    /**
     * Get the entity.
     *
     * @param string                                     $entityName Name of Entity
     * @param \Doctrine\Common\Persistence\ObjectManager $etm        ObjectManager instances
     * @return array|\Doctrine\ORM\QueryBuilder|null Entity elements
     */
    private function getEntity($entityName, ObjectManager $etm)
    {
        $roles = ['ROLE_ADMIN', 'ROLE_SUPER_ADMIN'];
        switch ($entityName) {
            case 'Settings\Diverse\FamilyLog':
                $entities = $etm->getRepository('AppBundle:'.$entityName)->childrenHierarchy();
                break;
            default:
                if ($this->getUser() !== null && in_array($this->getUser()->getRoles()[0], $roles)) {
                    $entities = $etm->getRepository('AppBundle:'.$entityName)->getAllItems();
                } else {
                    $entities = $etm->getRepository('AppBundle:'.$entityName)->getItems();
                }
        }
        return $entities;
    }
}