WidgetController::updateAction() - Code Metrics - Inspection of "Merge pull request #52 from takeit/split" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 530ce9...1b2ae5 )

by Paweł

created 2016-02-16 10:14 UTC

WidgetController::updateAction() B

↳ Parent: WidgetController

Complexity

Conditions	4
Paths	4

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	27
rs	8.5806
cc	4
eloc	15
nc	4
nop	2

<?php

/**
 * This file is part of the Superdesk Web Publisher Template Engine 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\TemplateEngineBundle\Controller;

use FOS\RestBundle\Controller\FOSRestController;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use FOS\RestBundle\View\View;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use SWP\Bundle\TemplateEngineBundle\Model\Widget;
use SWP\Bundle\TemplateEngineBundle\Form\Type\WidgetType;

class WidgetController extends FOSRestController
{
    /**
     * Lists all registered widgets.
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Lists all registered widgets",
     *     statusCodes={
     *         200="Returned on success."
     *     }
     * )
     * @Route("/api/{version}/templates/widgtes/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_list_widgets")
     * @Method("GET")
     */
    public function listAction(Request $request)

    {
        $entityManager = $this->get('doctrine')->getManager();
        $paginator = $this->get('knp_paginator');
        $widgets = $paginator->paginate($entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getAll());

        if (count($widgets) == 0) {
            throw new NotFoundHttpException('Widgets were not found.');
        }

        return $this->handleView(View::create($this->container->get('swp_pagination_rep')->createRepresentation($widgets, $request), 200));
    }

    /**
     * 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(Request $request, $id)
    {
        if (!$id) {
            throw new UnprocessableEntityHttpException('You need to provide widget Id (integer).');
        }

        $entityManager = $this->get('doctrine')->getManager();
        $widget = $entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getById($id)->getOneOrNullResult();

        if (!$widget) {
            throw new NotFoundHttpException('Widget with this id was not found.');
        }

        // return clean object for LINK requests
        if ($request->attributes->get('_link_request', false) === true) {
            return $widget;
        }

        return $this->handleView(View::create($widget, 200));
    }

    /**
     * Create new widget.
     *
     * @ApiDoc(
     *     resource=true,
     *     description="Create new widget",
     *     statusCodes={
     *         201="Returned on success.",
     *         400="Returned when form have errors"
     *     },
     *     input="SWP\Bundle\TemplateEngineBundle\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)
    {
        $entityManager = $this->get('doctrine')->getManager();

        $widget = new Widget();
        $form = $this->createForm(WidgetType::class, $widget);
        $form->handleRequest($request);
        if ($form->isValid()) {
            $entityManager->persist($widget);
            $entityManager->flush();

            return $this->handleView(View::create($widget, 201));
        }

        return $this->handleView(View::create($form, 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(Request $request, $id)

    {
        if (!$id) {
            throw new UnprocessableEntityHttpException('You need to provide widget Id (integer).');
        }

        $entityManager = $this->get('doctrine')->getManager();
        $widget = $entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getById($id)->getOneOrNullResult();

        if (!$widget) {
            throw new NotFoundHttpException('Widget with this id was not found.');
        }

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

        $entityManager->remove($widget);
        $entityManager->flush();

        return $this->handleView(View::create(null, 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\TemplateEngineBundle\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)
    {
        if (!$id) {
            throw new UnprocessableEntityHttpException('You need to provide container Id (integer).');
        }

        $entityManager = $this->get('doctrine')->getManager();
        $widget = $entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getById($id)->getOneOrNullResult();

        if (!$widget) {
            throw new NotFoundHttpException('Widget with this id was not found.');
        }

        $form = $this->createForm(WidgetType::class, $widget, array(
            'method' => $request->getMethod(),
        ));

        $form->handleRequest($request);
        if ($form->isValid()) {
            $entityManager->flush($widget);
            $entityManager->refresh($widget);

            return $this->handleView(View::create($widget, 201));
        }

        return $this->handleView(View::create($form, 200));
    }
}


1		<?php
2
3		/**
4		* This file is part of the Superdesk Web Publisher Template Engine Bundle.
5		*
6		* Copyright 2015 Sourcefabric z.u. and contributors.
7		*
8		* For the full copyright and license information, please see the
9		* AUTHORS and LICENSE files distributed with this source code.
10		*
11		* @copyright 2015 Sourcefabric z.ú.
12		* @license http://www.superdesk.org/license
13		*/
14		namespace SWP\Bundle\TemplateEngineBundle\Controller;
15
16		use FOS\RestBundle\Controller\FOSRestController;
17		use Nelmio\ApiDocBundle\Annotation\ApiDoc;
18		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
19		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
20		use FOS\RestBundle\View\View;
21		use Symfony\Component\HttpFoundation\Request;
22		use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
23		use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
24		use SWP\Bundle\TemplateEngineBundle\Model\Widget;
25		use SWP\Bundle\TemplateEngineBundle\Form\Type\WidgetType;
26
27		class WidgetController extends FOSRestController
28		{
29		/**
30		* Lists all registered widgets.
31		*
32		* @ApiDoc(
33		* resource=true,
34		* description="Lists all registered widgets",
35		* statusCodes={
36		* 200="Returned on success."
37		* }
38		* )
39		* @Route("/api/{version}/templates/widgtes/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_list_widgets")
40		* @Method("GET")
41		*/
42	View Code Duplication	public function listAction(Request $request)
		0 ignored issues – show Duplication introduced 2016-02-16 10:34 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...
43		{
44		$entityManager = $this->get('doctrine')->getManager();
45		$paginator = $this->get('knp_paginator');
46		$widgets = $paginator->paginate($entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getAll());
47
48		if (count($widgets) == 0) {
49		throw new NotFoundHttpException('Widgets were not found.');
50		}
51
52		return $this->handleView(View::create($this->container->get('swp_pagination_rep')->createRepresentation($widgets, $request), 200));
53		}
54
55		/**
56		* Get single widget.
57		*
58		* @ApiDoc(
59		* resource=true,
60		* description="Get single widget",
61		* statusCodes={
62		* 200="Returned on success.",
63		* 404="Widget not found",
64		* 422="Widget id is not number"
65		* }
66		* )
67		* @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_get_widget")
68		* @Method("GET")
69		*/
70		public function getAction(Request $request, $id)
71		{
72		if (!$id) {
73		throw new UnprocessableEntityHttpException('You need to provide widget Id (integer).');
74		}
75
76		$entityManager = $this->get('doctrine')->getManager();
77		$widget = $entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getById($id)->getOneOrNullResult();
78
79		if (!$widget) {
80		throw new NotFoundHttpException('Widget with this id was not found.');
81		}
82
83		// return clean object for LINK requests
84		if ($request->attributes->get('_link_request', false) === true) {
85		return $widget;
86		}
87
88		return $this->handleView(View::create($widget, 200));
89		}
90
91		/**
92		* Create new widget.
93		*
94		* @ApiDoc(
95		* resource=true,
96		* description="Create new widget",
97		* statusCodes={
98		* 201="Returned on success.",
99		* 400="Returned when form have errors"
100		* },
101		* input="SWP\Bundle\TemplateEngineBundle\Form\Type\WidgetType"
102		* )
103		* @Route("/api/{version}/templates/widgets", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_create_widget")
104		* @Method("POST")
105		*/
106		public function createAction(Request $request)
107		{
108		$entityManager = $this->get('doctrine')->getManager();
109
110		$widget = new Widget();
111		$form = $this->createForm(WidgetType::class, $widget);
112		$form->handleRequest($request);
113		if ($form->isValid()) {
114		$entityManager->persist($widget);
115		$entityManager->flush();
116
117		return $this->handleView(View::create($widget, 201));
118		}
119
120		return $this->handleView(View::create($form, 400));
121		}
122
123		/**
124		* Delete single widget.
125		*
126		* @ApiDoc(
127		* resource=true,
128		* description="Delete single widget",
129		* statusCodes={
130		* 204="Returned on success.",
131		* 404="Widget not found",
132		* 422="Widget id is not number"
133		* }
134		* )
135		* @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_delete_widget")
136		* @Method("DELETE")
137		*/
138		public function deleteAction(Request $request, $id)
		0 ignored issues – show Unused Code introduced 2016-02-11 14:44 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
139		{
140		if (!$id) {
141		throw new UnprocessableEntityHttpException('You need to provide widget Id (integer).');
142		}
143
144		$entityManager = $this->get('doctrine')->getManager();
145		$widget = $entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getById($id)->getOneOrNullResult();
146
147		if (!$widget) {
148		throw new NotFoundHttpException('Widget with this id was not found.');
149		}
150
151		foreach ($widget->getContainers() as $containerWidget) {
152		$entityManager->remove($containerWidget);
153		}
154
155		$entityManager->remove($widget);
156		$entityManager->flush();
157
158		return $this->handleView(View::create(null, 204));
159		}
160
161		/**
162		* Update single widget.
163		*
164		* @ApiDoc(
165		* resource=true,
166		* description="Update single widget",
167		* statusCodes={
168		* 201="Returned on success.",
169		* 404="Widget not found",
170		* 422="Widget id is not number",
171		* 405="Method Not Allowed"
172		* },
173		* input="SWP\Bundle\TemplateEngineBundle\Form\Type\WidgetType"
174		* )
175		* @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_update_widget")
176		* @Method("PATCH")
177		*/
178		public function updateAction(Request $request, $id)
179		{
180		if (!$id) {
181		throw new UnprocessableEntityHttpException('You need to provide container Id (integer).');
182		}
183
184		$entityManager = $this->get('doctrine')->getManager();
185		$widget = $entityManager->getRepository('SWP\Bundle\TemplateEngineBundle\Model\Widget')->getById($id)->getOneOrNullResult();
186
187		if (!$widget) {
188		throw new NotFoundHttpException('Widget with this id was not found.');
189		}
190
191		$form = $this->createForm(WidgetType::class, $widget, array(
192		'method' => $request->getMethod(),
193		));
194
195		$form->handleRequest($request);
196		if ($form->isValid()) {
197		$entityManager->flush($widget);
198		$entityManager->refresh($widget);
199
200		return $this->handleView(View::create($widget, 201));
201		}
202
203		return $this->handleView(View::create($form, 200));
204		}
205		}
206

superdesk / web-publisher

Push — master ( 530ce9...1b2ae5 )

WidgetController::updateAction() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like