BatchFormValidRequestHandler::isAbortIfSkipped() - Code Metrics - Inspection of "Dispatch events before and after applying batch ac..." - fsi-open/admin-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#306)

by Piotr

created 2017-08-25 15:52 UTC

BatchFormValidRequestHandler::isAbortIfSkipped() A

↳ Parent: BatchFormValidRequestHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	2
eloc	2
nc	2
nop	1

<?php

/**
 * (c) FSi sp. z o.o. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FSi\Bundle\AdminBundle\Admin\CRUD\Context\Request;

use FSi\Bundle\AdminBundle\Admin\Context\Request\AbstractFormValidRequestHandler;
use FSi\Bundle\AdminBundle\Admin\CRUD\BatchElement;
use FSi\Bundle\AdminBundle\Admin\CRUD\DeleteElement;
use FSi\Bundle\AdminBundle\Event\BatchEvent;
use FSi\Bundle\AdminBundle\Event\BatchEvents;
use FSi\Bundle\AdminBundle\Event\FormEvent;
use FSi\Bundle\AdminBundle\Exception\RequestHandlerException;
use FSi\Bundle\AdminBundle\Message\FlashMessages;
use LogicException;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\RouterInterface;

class BatchFormValidRequestHandler extends AbstractFormValidRequestHandler
{
    /**
     * @var \FSi\Bundle\AdminBundle\Message\FlashMessages
     */
    private $flashMessages;

    /**
     * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher
     * @param \Symfony\Component\Routing\RouterInterface $router
     * @param \FSi\Bundle\AdminBundle\Message\FlashMessages|null
     */
    public function __construct(
        EventDispatcherInterface $eventDispatcher,
        RouterInterface $router,
        FlashMessages $flashMessages = null
    ) {
        parent::__construct($eventDispatcher, $router);
        $this->flashMessages = $flashMessages;
    }

    /**
     * @param \FSi\Bundle\AdminBundle\Event\FormEvent $event
     * @param \Symfony\Component\HttpFoundation\Request $request
     */
    protected function action(FormEvent $event, Request $request)
    {
        /** @var \FSi\Bundle\AdminBundle\Admin\CRUD\BatchElement $element */
        $element = $event->getElement();
        $objects = $this->getObjects($element, $request);

        if (empty($objects)) {
            $this->setWarningMessage();
            return;
        }

        foreach ($objects as $object) {
            $preEvent = $this->eventDispatcher->dispatch(
                BatchEvents::BATCH_OBJECT_PRE_APPLY,
                new BatchEvent($object)

            );

            $skip = $this->checkIfSkip($preEvent);

            $abort = $this->checkIfAbort($preEvent);

            if ($abort || $this->isAbortIfSkipped($element)) {
                return;
            }

            if ($skip) {
                continue;
            }

            $element->apply($object);

            $this->eventDispatcher->dispatch(
                BatchEvents::BATCH_OBJECT_POST_APPLY,
                new BatchEvent($object)

            );
        }
    }

    /**
     * @param \FSi\Bundle\AdminBundle\Admin\CRUD\BatchElement $element
     * @param \Symfony\Component\HttpFoundation\Request $request
     * @return array
     * @throws \FSi\Bundle\AdminBundle\Exception\RequestHandlerException
     */
    private function getObjects(BatchElement $element, Request $request)
    {
        $objects = [];
        $indexes = $request->request->get('indexes', []);

        if (!count($indexes)) {
            return [];
        }

        foreach ($indexes as $index) {
            $object = $element->getDataIndexer()->getData($index);

            if (!isset($object)) {
                throw new RequestHandlerException(sprintf("Can't find object with id %s", $index));
            }

            $objects[] = $object;
        }

        return $objects;
    }

    /**
     * @param \FSi\Bundle\AdminBundle\Event\FormEvent $event
     * @param \Symfony\Component\HttpFoundation\Request $request
     * @return bool
     */
    protected function isValidPostRequest(FormEvent $event, Request $request)
    {
        $element = $event->getElement();
        if ($element instanceof DeleteElement
            && $element->hasOption('allow_delete')
            && !$element->getOption('allow_delete')
        ) {
            throw new LogicException(sprintf(
                'Tried to delete objects through element "%s", which has option "allow_delete" set to false',
                get_class($element)
            ));
        }

        return parent::isValidPostRequest($event, $request);
    }

    /**
     * @param FormEvent $event
     * @param Request $request
     * @return RedirectResponse
     */
    protected function getRedirectResponse(FormEvent $event, Request $request)
    {
        if ($request->query->has('redirect_uri')) {
            return new RedirectResponse($request->query->get('redirect_uri'));
        }

        return parent::getRedirectResponse($event, $request);
    }

    /**
     * @return string
     */
    protected function getPreSaveEventName()
    {
        return BatchEvents::BATCH_OBJECTS_PRE_APPLY;
    }

    /**
     * @return string
     */
    protected function getPostSaveEventName()
    {
        return BatchEvents::BATCH_OBJECTS_POST_APPLY;
    }

    private function setWarningMessage()
    {
        if ($this->flashMessages) {
            $this->flashMessages->warning('messages.batch.no_elements');
        }
    }

    /**
     * @param BatchEvent $event
     * @return boolean
     */
    private function checkIfAbort($event)
    {
        if (!($event instanceof BatchEvent)) {
            return false;
        }

        return $event->getAbort();
    }

    /**
     * @param BatchEvent $event
     * @return boolean
     */
    private function checkIfSkip($event)
    {
        if (!($event instanceof BatchEvent)) {
            return false;
        }

        return $event->getSkipElement();
    }

    private function isAbortIfSkipped(BatchElement $element)
    {
        return $element->hasOption('abort_if_skipped') && $element->getOption('abort_if_skipped');
    }
}


1			<?php
2
3			/**
4			* (c) FSi sp. z o.o. <[email protected]>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace FSi\Bundle\AdminBundle\Admin\CRUD\Context\Request;
11
12			use FSi\Bundle\AdminBundle\Admin\Context\Request\AbstractFormValidRequestHandler;
13			use FSi\Bundle\AdminBundle\Admin\CRUD\BatchElement;
14			use FSi\Bundle\AdminBundle\Admin\CRUD\DeleteElement;
15			use FSi\Bundle\AdminBundle\Event\BatchEvent;
16			use FSi\Bundle\AdminBundle\Event\BatchEvents;
17			use FSi\Bundle\AdminBundle\Event\FormEvent;
18			use FSi\Bundle\AdminBundle\Exception\RequestHandlerException;
19			use FSi\Bundle\AdminBundle\Message\FlashMessages;
20			use LogicException;
21			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
22			use Symfony\Component\HttpFoundation\RedirectResponse;
23			use Symfony\Component\HttpFoundation\Request;
24			use Symfony\Component\Routing\RouterInterface;
25
26			class BatchFormValidRequestHandler extends AbstractFormValidRequestHandler
27			{
28			/**
29			* @var \FSi\Bundle\AdminBundle\Message\FlashMessages
30			*/
31			private $flashMessages;
32
33			/**
34			* @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher
35			* @param \Symfony\Component\Routing\RouterInterface $router
36			* @param \FSi\Bundle\AdminBundle\Message\FlashMessages\|null
37			*/
38			public function __construct(
39			EventDispatcherInterface $eventDispatcher,
40			RouterInterface $router,
41			FlashMessages $flashMessages = null
42			) {
43			parent::__construct($eventDispatcher, $router);
44			$this->flashMessages = $flashMessages;
45			}
46
47			/**
48			* @param \FSi\Bundle\AdminBundle\Event\FormEvent $event
49			* @param \Symfony\Component\HttpFoundation\Request $request
50			*/
51			protected function action(FormEvent $event, Request $request)
52			{
53			/** @var \FSi\Bundle\AdminBundle\Admin\CRUD\BatchElement $element */
54			$element = $event->getElement();
55			$objects = $this->getObjects($element, $request);
56
57			if (empty($objects)) {
58			$this->setWarningMessage();
59			return;
60			}
61
62			foreach ($objects as $object) {
63			$preEvent = $this->eventDispatcher->dispatch(
64			BatchEvents::BATCH_OBJECT_PRE_APPLY,
65			new BatchEvent($object)
			0 ignored issues – show Bug introduced 2017-08-25 15:54 UTC by Report Bug Copy Issue Report The call to `BatchEvent::__construct()` misses some required arguments starting with `$request`. Loading history...
66			);
67
68			$skip = $this->checkIfSkip($preEvent);
			0 ignored issues – show Compatibility introduced 2017-08-25 15:54 UTC by Report Bug Copy Issue Report `$preEvent` of type `object<Symfony\Component\EventDispatcher\Event>` is not a sub-type of `object<FSi\Bundle\AdminBundle\Event\BatchEvent>`. It seems like you assume a child class of the class `Symfony\Component\EventDispatcher\Event` 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...
69			$abort = $this->checkIfAbort($preEvent);
			0 ignored issues – show Compatibility introduced 2017-08-25 15:54 UTC by Report Bug Copy Issue Report `$preEvent` of type `object<Symfony\Component\EventDispatcher\Event>` is not a sub-type of `object<FSi\Bundle\AdminBundle\Event\BatchEvent>`. It seems like you assume a child class of the class `Symfony\Component\EventDispatcher\Event` 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...
70			if ($abort \|\| $this->isAbortIfSkipped($element)) {
71			return;
72			}
73
74			if ($skip) {
75			continue;
76			}
77
78			$element->apply($object);
79
80			$this->eventDispatcher->dispatch(
81			BatchEvents::BATCH_OBJECT_POST_APPLY,
82			new BatchEvent($object)
			0 ignored issues – show Bug introduced 2017-08-25 15:54 UTC by Report Bug Copy Issue Report The call to `BatchEvent::__construct()` misses some required arguments starting with `$request`. Loading history...
83			);
84			}
85			}
86
87			/**
88			* @param \FSi\Bundle\AdminBundle\Admin\CRUD\BatchElement $element
89			* @param \Symfony\Component\HttpFoundation\Request $request
90			* @return array
91			* @throws \FSi\Bundle\AdminBundle\Exception\RequestHandlerException
92			*/
93			private function getObjects(BatchElement $element, Request $request)
94			{
95			$objects = [];
96			$indexes = $request->request->get('indexes', []);
97
98			if (!count($indexes)) {
99			return [];
100			}
101
102			foreach ($indexes as $index) {
103			$object = $element->getDataIndexer()->getData($index);
104
105			if (!isset($object)) {
106			throw new RequestHandlerException(sprintf("Can't find object with id %s", $index));
107			}
108
109			$objects[] = $object;
110			}
111
112			return $objects;
113			}
114
115			/**
116			* @param \FSi\Bundle\AdminBundle\Event\FormEvent $event
117			* @param \Symfony\Component\HttpFoundation\Request $request
118			* @return bool
119			*/
120			protected function isValidPostRequest(FormEvent $event, Request $request)
121			{
122			$element = $event->getElement();
123			if ($element instanceof DeleteElement
124			&& $element->hasOption('allow_delete')
125			&& !$element->getOption('allow_delete')
126			) {
127			throw new LogicException(sprintf(
128			'Tried to delete objects through element "%s", which has option "allow_delete" set to false',
129			get_class($element)
130			));
131			}
132
133			return parent::isValidPostRequest($event, $request);
134			}
135
136			/**
137			* @param FormEvent $event
138			* @param Request $request
139			* @return RedirectResponse
140			*/
141			protected function getRedirectResponse(FormEvent $event, Request $request)
142			{
143			if ($request->query->has('redirect_uri')) {
144			return new RedirectResponse($request->query->get('redirect_uri'));
145			}
146
147			return parent::getRedirectResponse($event, $request);
148			}
149
150			/**
151			* @return string
152			*/
153			protected function getPreSaveEventName()
154			{
155			return BatchEvents::BATCH_OBJECTS_PRE_APPLY;
156			}
157
158			/**
159			* @return string
160			*/
161			protected function getPostSaveEventName()
162			{
163			return BatchEvents::BATCH_OBJECTS_POST_APPLY;
164			}
165
166			private function setWarningMessage()
167			{
168			if ($this->flashMessages) {
169			$this->flashMessages->warning('messages.batch.no_elements');
170			}
171			}
172
173			/**
174			* @param BatchEvent $event
175			* @return boolean
176			*/
177			private function checkIfAbort($event)
178			{
179			if (!($event instanceof BatchEvent)) {
180			return false;
181			}
182
183			return $event->getAbort();
184			}
185
186			/**
187			* @param BatchEvent $event
188			* @return boolean
189			*/
190			private function checkIfSkip($event)
191			{
192			if (!($event instanceof BatchEvent)) {
193			return false;
194			}
195
196			return $event->getSkipElement();
197			}
198
199			private function isAbortIfSkipped(BatchElement $element)
200			{
201			return $element->hasOption('abort_if_skipped') && $element->getOption('abort_if_skipped');
202			}
203			}
204

fsi-open / admin-bundle

Pull Request — master (#306)

BatchFormValidRequestHandler::isAbortIfSkipped() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like