FormSubmissionsController::deleteAction() - Code Metrics - Inspection of "Merge branch 'master' into 6.0" - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 6.0 ( 92cb73...aa2689 )

by Ruud

created 2018-06-26 09:07 UTC

FormSubmissionsController::deleteAction() A

↳ Parent: FormSubmissionsController

Complexity

Conditions	3
Paths	9

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	41
rs	9.264
c	0
b	0
f	0
cc	3
nc	9
nop	2

<?php

namespace Kunstmaan\FormBundle\Controller;

use Doctrine\ORM\EntityManager;
use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\PermissionMap;
use Kunstmaan\AdminListBundle\AdminList\AdminList;
use Kunstmaan\AdminListBundle\AdminList\ExportList;
use Kunstmaan\FormBundle\AdminList\FormPageAdminListConfigurator;
use Kunstmaan\FormBundle\AdminList\FormSubmissionAdminListConfigurator;
use Kunstmaan\FormBundle\AdminList\FormSubmissionExportListConfigurator;
use Kunstmaan\NodeBundle\Entity\NodeTranslation;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Kunstmaan\AdminBundle\FlashMessages\FlashTypes;


/**
 * The controller which will handle everything related with form pages and form submissions
 */
class FormSubmissionsController extends Controller
{
    /**
     * The index action will use an admin list to list all the form pages
     *
     * @Route("/", name="KunstmaanFormBundle_formsubmissions")
     * @Template("KunstmaanAdminListBundle:Default:list.html.twig")
     *
     * @return array

     */
    public function indexAction(Request $request)

    {
        /* @var EntityManager $em */
        $em        = $this->getDoctrine()->getManager();
        $aclHelper = $this->container->get('kunstmaan_admin.acl.helper');

        /* @var AdminList $adminList */
        $adminList = $this->get('kunstmaan_adminlist.factory')->createList(
            new FormPageAdminListConfigurator($em, $aclHelper, PermissionMap::PERMISSION_VIEW),
            $em
        );
        $adminList->bindRequest($request);

        return array('adminlist' => $adminList);
    }

    /**
     * The list action will use an admin list to list all the form submissions related to the given $nodeTranslationId
     *
     * @param int $nodeTranslationId
     *
     * @Route("/list/{nodeTranslationId}", requirements={"nodeTranslationId" = "\d+"},
     *                                     name="KunstmaanFormBundle_formsubmissions_list")
     * @Method({"GET", "POST"})
     * @Template()
     *
     * @return array

     */
    public function listAction(Request $request, $nodeTranslationId)
    {
        $em              = $this->getDoctrine()->getManager();
        $nodeTranslation = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->find($nodeTranslationId);

        /** @var AdminList $adminList */
        $adminList = $this->get('kunstmaan_adminlist.factory')->createList(
            new FormSubmissionAdminListConfigurator($em, $nodeTranslation, $this->getParameter('kunstmaan_form.deletable_formsubmissions')),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $em
        );
        $adminList->bindRequest($request);

        return array('nodetranslation' => $nodeTranslation, 'adminlist' => $adminList);
    }

    /**
     * The edit action will be used to edit a given submission.
     *
     * @param int $nodeTranslationId The node translation id
     * @param int $submissionId      The submission id
     *
     * @Route("/list/{nodeTranslationId}/{submissionId}", requirements={"nodeTranslationId" = "\d+", "submissionId" =
     *                                                    "\d+"}, name="KunstmaanFormBundle_formsubmissions_list_edit")
     * @Method({"GET", "POST"})
     * @Template()
     *
     * @return array

     */
    public function editAction($nodeTranslationId, $submissionId)
    {
        $em = $this->getDoctrine()->getManager();
        $nodeTranslation = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->find($nodeTranslationId);
        $formSubmission = $em->getRepository('KunstmaanFormBundle:FormSubmission')->find($submissionId);
        $request = $this->container->get('request_stack')->getCurrentRequest();
        $deletableFormsubmission = $this->getParameter('kunstmaan_form.deletable_formsubmissions');

        /** @var AdminList $adminList */
        $adminList = $this->get('kunstmaan_adminlist.factory')->createList(
            new FormSubmissionAdminListConfigurator($em, $nodeTranslation,$deletableFormsubmission),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $em
        );
        $adminList->bindRequest($request);

        return [
            'nodetranslation' => $nodeTranslation,
            'formsubmission' => $formSubmission,
            'adminlist' => $adminList,
        ];
    }

    /**
     * Export as CSV of all the form submissions for the given $nodeTranslationId
     *
     * @param int $nodeTranslationId
     *
     * @Route("/export/{nodeTranslationId}.{_format}", requirements={"nodeTranslationId" = "\d+","_format" =
     *                                                 "csv|xlsx|ods"}, name="KunstmaanFormBundle_formsubmissions_export")
     * @Method({"GET"})
     *
     * @return Response
     */
    public function exportAction($nodeTranslationId, $_format)
    {
        $em = $this->getDoctrine()->getManager();
        /** @var NodeTranslation $nodeTranslation */
        $nodeTranslation = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->find($nodeTranslationId);
        $translator      = $this->get('translator');

        /** @var ExportList $exportList */
        $configurator = new FormSubmissionExportListConfigurator($em, $nodeTranslation, $translator);

        $exportList   = $this->get('kunstmaan_adminlist.factory')->createExportList($configurator);

        return $this->get('kunstmaan_adminlist.service.export')->getDownloadableResponse($exportList, $_format);
    }

    /**
     * @Route(
     *      "/{id}/delete",
     *      requirements={"id" = "\d+"},
     *      name="KunstmaanFormBundle_formsubmissions_delete"
     * )
     * @Template()
     * @Method("POST")
     *
     * @param Request $request
     * @param int     $id
     *
     * @return RedirectResponse
     *
     * @throws AccessDeniedException
     */
    public function deleteAction(Request $request, $id)
    {
        $em = $this->getDoctrine()->getManager();
        $submission = $em->getRepository('KunstmaanFormBundle:FormSubmission')->find($id);

        $node = $em->getRepository('KunstmaanNodeBundle:Node')->find($submission->getNode());
        $nt = $node->getNodeTranslation($request->getLocale());

        $this->denyAccessUnlessGranted(PermissionMap::PERMISSION_DELETE, $node);

        $url = $this->get('router')->generate(
            'KunstmaanFormBundle_formsubmissions_list',
            ['nodeTranslationId' => $nt->getId()]
        );

        $fields = $em->getRepository('KunstmaanFormBundle:FormSubmissionField')->findBy(['formSubmission' => $submission]);

        try {
            foreach ($fields as $field) {
                $em->remove($field);
            }

            $em->remove($submission);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $em->flush();

            $this->addFlash(
                FlashTypes::SUCCESS,
                $this->get('translator')->trans('formsubmissions.delete.flash.success')
            );
        } catch (\Exception $e) {
            $this->get('logger')->error($e->getMessage());
            $this->addFlash(
                FlashTypes::ERROR,
                $this->get('translator')->trans('formsubmissions.delete.flash.error')
            );
        }

        $response = new RedirectResponse($url);

        return $response;
    }
}


1		<?php
2
3		namespace Kunstmaan\FormBundle\Controller;
4
5		use Doctrine\ORM\EntityManager;
6		use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\PermissionMap;
7		use Kunstmaan\AdminListBundle\AdminList\AdminList;
8		use Kunstmaan\AdminListBundle\AdminList\ExportList;
9		use Kunstmaan\FormBundle\AdminList\FormPageAdminListConfigurator;
10		use Kunstmaan\FormBundle\AdminList\FormSubmissionAdminListConfigurator;
11		use Kunstmaan\FormBundle\AdminList\FormSubmissionExportListConfigurator;
12		use Kunstmaan\NodeBundle\Entity\NodeTranslation;
13		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
14		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
15		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
16		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
17		use Symfony\Component\HttpFoundation\RedirectResponse;
18		use Symfony\Component\HttpFoundation\Request;
19		use Symfony\Component\HttpFoundation\Response;
20		use Kunstmaan\AdminBundle\FlashMessages\FlashTypes;
21
22
23		/**
24		* The controller which will handle everything related with form pages and form submissions
25		*/
26		class FormSubmissionsController extends Controller
27		{
28		/**
29		* The index action will use an admin list to list all the form pages
30		*
31		* @Route("/", name="KunstmaanFormBundle_formsubmissions")
32		* @Template("KunstmaanAdminListBundle:Default:list.html.twig")
33		*
34		* @return array
		0 ignored issues – show Documentation introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,AdminList>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
35		*/
36	View Code Duplication	public function indexAction(Request $request)
		0 ignored issues – show Duplication introduced 2018-04-18 14:49 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...
37		{
38		/* @var EntityManager $em */
39		$em = $this->getDoctrine()->getManager();
40		$aclHelper = $this->container->get('kunstmaan_admin.acl.helper');
41
42		/* @var AdminList $adminList */
43		$adminList = $this->get('kunstmaan_adminlist.factory')->createList(
44		new FormPageAdminListConfigurator($em, $aclHelper, PermissionMap::PERMISSION_VIEW),
45		$em
46		);
47		$adminList->bindRequest($request);
48
49		return array('adminlist' => $adminList);
50		}
51
52		/**
53		* The list action will use an admin list to list all the form submissions related to the given $nodeTranslationId
54		*
55		* @param int $nodeTranslationId
56		*
57		* @Route("/list/{nodeTranslationId}", requirements={"nodeTranslationId" = "\d+"},
58		* name="KunstmaanFormBundle_formsubmissions_list")
59		* @Method({"GET", "POST"})
60		* @Template()
61		*
62		* @return array
		0 ignored issues – show Documentation introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,object\|null>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
63		*/
64		public function listAction(Request $request, $nodeTranslationId)
65		{
66		$em = $this->getDoctrine()->getManager();
67		$nodeTranslation = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->find($nodeTranslationId);
68
69		/** @var AdminList $adminList */
70		$adminList = $this->get('kunstmaan_adminlist.factory')->createList(
71		new FormSubmissionAdminListConfigurator($em, $nodeTranslation, $this->getParameter('kunstmaan_form.deletable_formsubmissions')),
		0 ignored issues – show Compatibility introduced 2018-06-12 10:44 UTC by Report Bug Copy Issue Report `$em` of type `object<Doctrine\Common\Persistence\ObjectManager>` is not a sub-type of `object<Doctrine\ORM\EntityManager>`. It seems like you assume a concrete implementation of the interface `Doctrine\Common\Persistence\ObjectManager` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history... Documentation introduced 2018-06-12 10:44 UTC by Report Bug Copy Issue Report `$nodeTranslation` is of type `object\|null`, but the function expects a `object<Kunstmaan\NodeBun...Entity\NodeTranslation>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
72		$em
73		);
74		$adminList->bindRequest($request);
75
76		return array('nodetranslation' => $nodeTranslation, 'adminlist' => $adminList);
77		}
78
79		/**
80		* The edit action will be used to edit a given submission.
81		*
82		* @param int $nodeTranslationId The node translation id
83		* @param int $submissionId The submission id
84		*
85		* @Route("/list/{nodeTranslationId}/{submissionId}", requirements={"nodeTranslationId" = "\d+", "submissionId" =
86		* "\d+"}, name="KunstmaanFormBundle_formsubmissions_list_edit")
87		* @Method({"GET", "POST"})
88		* @Template()
89		*
90		* @return array
		0 ignored issues – show Documentation introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,object\|null>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
91		*/
92		public function editAction($nodeTranslationId, $submissionId)
93		{
94		$em = $this->getDoctrine()->getManager();
95		$nodeTranslation = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->find($nodeTranslationId);
96		$formSubmission = $em->getRepository('KunstmaanFormBundle:FormSubmission')->find($submissionId);
97		$request = $this->container->get('request_stack')->getCurrentRequest();
98		$deletableFormsubmission = $this->getParameter('kunstmaan_form.deletable_formsubmissions');
99
100		/** @var AdminList $adminList */
101		$adminList = $this->get('kunstmaan_adminlist.factory')->createList(
102		new FormSubmissionAdminListConfigurator($em, $nodeTranslation,$deletableFormsubmission),
		0 ignored issues – show Compatibility introduced 2018-06-12 10:44 UTC by Report Bug Copy Issue Report `$em` of type `object<Doctrine\Common\Persistence\ObjectManager>` is not a sub-type of `object<Doctrine\ORM\EntityManager>`. It seems like you assume a concrete implementation of the interface `Doctrine\Common\Persistence\ObjectManager` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history... Documentation introduced 2018-06-12 10:44 UTC by Report Bug Copy Issue Report `$nodeTranslation` is of type `object\|null`, but the function expects a `object<Kunstmaan\NodeBun...Entity\NodeTranslation>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
103		$em
104		);
105		$adminList->bindRequest($request);
106
107		return [
108		'nodetranslation' => $nodeTranslation,
109		'formsubmission' => $formSubmission,
110		'adminlist' => $adminList,
111		];
112		}
113
114		/**
115		* Export as CSV of all the form submissions for the given $nodeTranslationId
116		*
117		* @param int $nodeTranslationId
118		*
119		* @Route("/export/{nodeTranslationId}.{_format}", requirements={"nodeTranslationId" = "\d+","_format" =
120		* "csv\|xlsx\|ods"}, name="KunstmaanFormBundle_formsubmissions_export")
121		* @Method({"GET"})
122		*
123		* @return Response
124		*/
125		public function exportAction($nodeTranslationId, $_format)
126		{
127		$em = $this->getDoctrine()->getManager();
128		/** @var NodeTranslation $nodeTranslation */
129		$nodeTranslation = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->find($nodeTranslationId);
130		$translator = $this->get('translator');
131
132		/** @var ExportList $exportList */
133		$configurator = new FormSubmissionExportListConfigurator($em, $nodeTranslation, $translator);
		0 ignored issues – show Compatibility introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report `$em` of type `object<Doctrine\Common\Persistence\ObjectManager>` is not a sub-type of `object<Doctrine\ORM\EntityManagerInterface>`. It seems like you assume a child interface of the interface `Doctrine\Common\Persistence\ObjectManager` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
134		$exportList = $this->get('kunstmaan_adminlist.factory')->createExportList($configurator);
135
136		return $this->get('kunstmaan_adminlist.service.export')->getDownloadableResponse($exportList, $_format);
137		}
138
139		/**
140		* @Route(
141		* "/{id}/delete",
142		* requirements={"id" = "\d+"},
143		* name="KunstmaanFormBundle_formsubmissions_delete"
144		* )
145		* @Template()
146		* @Method("POST")
147		*
148		* @param Request $request
149		* @param int $id
150		*
151		* @return RedirectResponse
152		*
153		* @throws AccessDeniedException
154		*/
155		public function deleteAction(Request $request, $id)
156		{
157		$em = $this->getDoctrine()->getManager();
158		$submission = $em->getRepository('KunstmaanFormBundle:FormSubmission')->find($id);
159
160		$node = $em->getRepository('KunstmaanNodeBundle:Node')->find($submission->getNode());
161		$nt = $node->getNodeTranslation($request->getLocale());
162
163		$this->denyAccessUnlessGranted(PermissionMap::PERMISSION_DELETE, $node);
164
165		$url = $this->get('router')->generate(
166		'KunstmaanFormBundle_formsubmissions_list',
167		['nodeTranslationId' => $nt->getId()]
168		);
169
170		$fields = $em->getRepository('KunstmaanFormBundle:FormSubmissionField')->findBy(['formSubmission' => $submission]);
171
172		try {
173		foreach ($fields as $field) {
174		$em->remove($field);
175		}
176
177		$em->remove($submission);
		0 ignored issues – show Bug introduced 2018-06-12 10:44 UTC by Report Bug Copy Issue Report It seems like `$submission` defined by `$em->getRepository('Kuns...Submission')->find($id)` on line `158` can also be of type `null`; however, `Doctrine\Common\Persiste...ObjectManager::remove()` does only seem to accept `object`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
178		$em->flush();
179
180		$this->addFlash(
181		FlashTypes::SUCCESS,
182		$this->get('translator')->trans('formsubmissions.delete.flash.success')
183		);
184		} catch (\Exception $e) {
185		$this->get('logger')->error($e->getMessage());
186		$this->addFlash(
187		FlashTypes::ERROR,
188		$this->get('translator')->trans('formsubmissions.delete.flash.error')
189		);
190		}
191
192		$response = new RedirectResponse($url);
193
194		return $response;
195		}
196		}
197

Kunstmaan / KunstmaanBundlesCMS

Push — 6.0 ( 92cb73...aa2689 )

FormSubmissionsController::deleteAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like