SWP\Bundle\CoreBundle\Controller\WidgetController

Complexity

Total Complexity

16

Size/Duplication

Total Lines	208
Duplicated Lines	14.42 %

Coupling/Cohesion

Components	1
Dependencies	14

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	listAction()	0	8	1
B	listTemplatesAction()	0	26	3
A	getAction()	0	4	1
A	createAction()	14	14	2
A	deleteAction()	0	13	2
A	updateAction()	16	16	2
A	findOr404()	0	8	2
A	ensureWidgetDontExists()	0	6	2
A	getWidgetRepository()	0	4	1

<?php

/*
 * This file is part of the Superdesk Web Publisher Core Bundle.
 *
 * Copyright 2015 Sourcefabric z.u. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2015 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\CoreBundle\Controller;

use FOS\RestBundle\Controller\FOSRestController;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use SWP\Component\Common\Criteria\Criteria;
use SWP\Component\Common\Pagination\PaginationData;
use SWP\Component\Common\Response\ResourcesListResponse;
use SWP\Component\Common\Response\ResponseContext;
use SWP\Component\Common\Response\SingleResourceResponse;
use SWP\Bundle\TemplatesSystemBundle\Form\Type\WidgetType;
use SWP\Bundle\CoreBundle\Model\WidgetModel;
use Symfony\Component\Finder\Finder;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\ConflictHttpException;

class WidgetController extends FOSRestController
{
    /**
     * Lists all registered widgets.
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Lists all registered widgets",
     *     statusCodes={
     *         200="Returned on success."
     *     },
     *     filters={
     *         {"name"="sorting", "dataType"="string", "pattern"="[updatedAt]=asc|desc"}
     *     }
     * )
     * @Route("/api/{version}/templates/widgets/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_list_widgets")
     * @Method("GET")
     * @Cache(expires="10 minutes", public=true)
     */
    public function listAction(Request $request)
    {
        $repository = $this->get('swp.repository.widget_model');

        $widgets = $repository->getPaginatedByCriteria(new Criteria(), $request->query->get('sorting', []), new PaginationData($request));

        return new ResourcesListResponse($widgets);
    }

    /**
     * Lists all theme widgets templates.
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Lists all theme widgets templates",
     *     statusCodes={
     *         200="Returned on success."
     *     }
     * )
     * @Route("/api/{version}/templates/widgets/templates/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_list_widgets_templates")
     * @Method("GET")
     * Cache(expires="10 minutes", public=true)
     */
    public function listTemplatesAction(Request $request)

The parameter $request is not used and could be removed.

    {
        $themeContext = $this->container->get('sylius.context.theme');
        $path = $themeContext->getTheme()->getPath().DIRECTORY_SEPARATOR.'views'.DIRECTORY_SEPARATOR.'widgets';

        if (!file_exists($path)) {
            return new SingleResourceResponse([]);
        }

        $files = Finder::create()
            ->files()
            ->depth(0)
            ->in($path)
            ->sortByName();

        $templates = [];

        foreach ($files as $file) {
            $templates[] = [
                'name' => $file->getFilename(),
                'modified' => date('Y-m-d H:i:s', $file->getMTime()),
            ];
        }

        return new SingleResourceResponse($templates);
    }

    /**
     * Get single widget.
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Get single widget",
     *     statusCodes={
     *         200="Returned on success.",
     *         404="Widget not found",
     *         422="Widget id is not number"
     *     }
     * )
     * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_get_widget")
     * @Method("GET")
     */
    public function getAction($id)
    {
        return new SingleResourceResponse($this->findOr404($id));
    }

    /**
     * Create new widget.
     *
     * Note:
     *
     *     Widget Type can be widget ID or his class (string).
     *     Example: "SWP\\Bundle\\CoreBundle\\Widget\\ContentListWidget"
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Create new widget",
     *     statusCodes={
     *         201="Returned on success.",
     *         400="Returned when form have errors"
     *     },
     *     input="SWP\Bundle\TemplatesSystemBundle\Form\Type\WidgetType"
     * )
     * @Route("/api/{version}/templates/widgets/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_create_widget")
     * @Method("POST")
     */
    public function createAction(Request $request)

This method seems to be duplicated in your project.

    {
        $widget = new WidgetModel();
        $form = $this->createForm(WidgetType::class, $widget);
        $form->handleRequest($request);
        if ($form->isValid()) {
            $this->ensureWidgetDontExists($widget->getName());
            $this->getWidgetRepository()->add($widget);

            return new SingleResourceResponse($widget, new ResponseContext(201));
        }

        return new SingleResourceResponse($form, new ResponseContext(400));
    }

    /**
     * Delete single widget.
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Delete single widget",
     *     statusCodes={
     *         204="Returned on success.",
     *         404="Widget not found",
     *         422="Widget id is not number"
     *     }
     * )
     * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_delete_widget")
     * @Method("DELETE")
     */
    public function deleteAction($id)
    {
        $entityManager = $this->get('doctrine')->getManager();
        $widget = $this->findOr404($id);

        foreach ($widget->getContainers() as $containerWidget) {
            $entityManager->remove($containerWidget);
        }

        $this->getWidgetRepository()->remove($widget);

        return new SingleResourceResponse(null, new ResponseContext(204));
    }

    /**
     * Update single widget.
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Update single widget",
     *     statusCodes={
     *         201="Returned on success.",
     *         404="Widget not found",
     *         422="Widget id is not number",
     *         405="Method Not Allowed"
     *     },
     *     input="SWP\Bundle\TemplatesSystemBundle\Form\Type\WidgetType"
     * )
     * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_update_widget")
     * @Method("PATCH")
     */
    public function updateAction(Request $request, $id)

This method seems to be duplicated in your project.

    {
        $widget = $this->findOr404($id);
        $form = $this->createForm(WidgetType::class, $widget, [
            'method' => $request->getMethod(),
        ]);

        $form->handleRequest($request);
        if ($form->isValid()) {
            $this->getWidgetRepository()->add($widget);

            return new SingleResourceResponse($widget, new ResponseContext(201));
        }

        return new SingleResourceResponse($form);
    }

    private function findOr404(int $id)
    {
        if (null === $widget = $this->getWidgetRepository()->findOneById($id)) {
            throw $this->createNotFoundException(sprintf('Widget with id "%s" was not found.', $id));
        }

        return $widget;
    }

    private function ensureWidgetDontExists(string $name)
    {
        if (null !== $this->getWidgetRepository()->findOneByName($name)) {
            throw new ConflictHttpException(sprintf('Widget with name "%s" already exists.', $name));
        }
    }

    private function getWidgetRepository()
    {
        return $this->get('swp.repository.widget_model');
    }
}