QualityCode\ApiFeaturesBundle\Controller\ControllerBasicFeaturesTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
	get()	0	1	?
	createForm()	0	1	?
A	getCollectionPaginated()	0	23	1
A	getAnElement()	0	12	2
A	createAnElement()	0	8	1
A	removeAnElement()	0	11	2
A	updateAnElement()	0	16	2
A	checkFormAndPersist()	0	12	3

<?php

namespace QualityCode\ApiFeaturesBundle\Controller;

use FOS\RestBundle\View\View;
use Hateoas\Configuration\Route;
use Hateoas\Representation\Factory\PagerfantaFactory;
use Hateoas\Representation\PaginatedRepresentation;
use Symfony\Component\Form\Form;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Description of controllerBasicFeatures.
 *
 * @author flavien-metivier
 */
trait ControllerBasicFeaturesTrait
{
    /**
     * Gets a container service by its id.
     *
     * @param string $id The service id
     *
     * @return object The service
     */
    abstract protected function get($id);

    /**
     * Creates and returns a Form instance from the type of the form.
     *
     * @param string $type    The fully qualified class name of the form type
     * @param mixed  $data    The initial data for the form
     * @param array  $options Options for the form
     *
     * @return Form
     */
    abstract protected function createForm($type, $data = null, array $options = []);

    /**
     * @param Request $request
     * @param string  $repositoryName
     *
     * @return PaginatedRepresentation
     */
    protected function getCollectionPaginated(Request $request, $repositoryName)
    {
        $limit = $request->query->getInt('limit', 10);
        $page = $request->query->getInt('page', 1);
        $sorting = $this->get('fos_rest.normalizer.camel_keys')->normalize($request->query->get('sorting', []));
        $searching = $this->get('fos_rest.normalizer.camel_keys')->normalize($request->query->get('searching', []));

        $collectionPager = $this->get('doctrine.orm.entity_manager')
                ->getRepository($repositoryName)
                ->findAllPaginated($limit, $page, $sorting, $searching);

        $pagerFactory = new PagerfantaFactory();

        return $pagerFactory->createRepresentation(
            $collectionPager,
            new Route($request->get('_route'), [
                'limit' => $limit,
                'page' => $page,
                'sorting' => $sorting,
                'searching' => $searching,
            ])
        );
    }

    /**
     * @param Request $request
     * @param string  $repositoryName
     *
     * @return mixed|\FOS\RestBundle\View\View
     */
    protected function getAnElement(Request $request, $repositoryName)
    {
        $anElement = $this->get('doctrine.orm.entity_manager')
                ->getRepository($repositoryName)
                ->find($request->get('id'));

        if (empty($anElement)) {
            return View::create(['message' => 'Element not found'], Response::HTTP_NOT_FOUND);
        }

        return $anElement;
    }

    /**
     * @param Request $request
     * @param mixed   $element
     * @param string  $formClassName
     *
     * @return mixed
     */
    protected function createAnElement(Request $request, $element, $formClassName)
    {
        $form = $this->createForm($formClassName, $element, ['csrf_protection' => false]);

        $form->submit($request->request->all(), false);

        return $this->checkFormAndPersist($form, $element);
    }

    /**
     * @param Request $request
     * @param string  $repositoryName
     */
    protected function removeAnElement(Request $request, $repositoryName)
    {
        $em = $this->get('doctrine.orm.entity_manager');
        $element = $em->getRepository($repositoryName)
                ->find($request->get('id'));

        if ($element) {
            $em->remove($element);
            $em->flush();
        }
    }

    /**
     * @param Request $request
     * @param bool    $clearMissing
     * @param $repositoryName
     * @param $formClassName
     *
     * @return mixed|Form|\FOS\RestBundle\View\View
     */
    protected function updateAnElement(Request $request, $clearMissing, $repositoryName, $formClassName)
    {
        $element = $this->get('doctrine.orm.entity_manager')
                ->getRepository($repositoryName)
                ->find($request->get('id'));

        if (empty($element)) {
            return View::create(['message' => 'Element not found'], Response::HTTP_NOT_FOUND);
        }

        $form = $this->createForm($formClassName, $element);

        $form->submit($request->request->all(), $clearMissing);

        return $this->checkFormAndPersist($form, $element);
    }

    /**
     * @param Form  $form
     * @param mixed $element
     *
     * @return mixed|Form
     */
    private function checkFormAndPersist(Form $form, $element)
    {
        if ($form->isSubmitted() && $form->isValid()) {
            $em = $this->get('doctrine.orm.entity_manager');
            $em->persist($element);
            $em->flush();

            return $element;
        }

        return $form;
    }
}