MiddlewareState::dispatchAfterSignal() - Code Metrics - Inspection of "[FEATURE] Introduce arguments for middlewares" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — middleware-wip ( ab6ae7...17e892 )

by Romain

created 2017-03-24 11:01 UTC

MiddlewareState::dispatchAfterSignal() A

↳ Parent: MiddlewareState::getSignalSortedMiddlewares()

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	5
nc	3
nop	1

<?php
/*
 * 2017 Romain CANON <[email protected]>
 *
 * This file is part of the TYPO3 FormZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Romm\Formz\Middleware\State;

use Romm\Formz\Controller\ControllerState;
use Romm\Formz\Error\FormResult;
use Romm\Formz\Form\FormObject;
use Romm\Formz\Middleware\Items\Begin\BeginMiddleware;
use Romm\Formz\Middleware\Items\End\EndMiddleware;
use Romm\Formz\Middleware\MiddlewareInterface;
use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
use TYPO3\CMS\Extbase\Mvc\Web\Request;

/**
 * @todo: loop on middlewares and detect which ones are using signals that wont
 * be processed. This should probably be a validator put on:
 *      \Romm\Formz\Configuration\Form\Form::$middlewares
 */
class MiddlewareState
{
    /**
     * @var MiddlewareInterface[]
     */
    protected $list = [];

    /**
     * @var FormObject
     */
    protected $formObject;

    /**
     * @var FormResult
     */
    protected $result;

    /**
     * @var Request
     */
    protected $request;

    /**
     * @var Arguments
     */
    protected $arguments;

    /**
     * @var array
     */
    protected $settings;

    /**
     * @see getSignalSortedMiddlewares()
     *
     * @var array
     */
    protected $signalSortedMiddlewares = [];

    /**
     * @param FormObject      $formObject
     * @param ControllerState $controllerState
     */
    public function __construct(FormObject $formObject, ControllerState $controllerState)
    {
        $this->formObject = $formObject;
        $this->request = $controllerState->getRequest();
        $this->arguments = $controllerState->getArguments();
        $this->settings = $controllerState->getSettings();

        foreach ($this->formObject->getConfiguration()->getMiddlewares() as $middleware) {
            $this->list[] = $middleware;

            $middleware->bindMiddlewareState($this);
            $middleware->initialize();
        }
    }

    /**
     * Will run and process trough every middleware registered for the current
     * form object.
     */
    public function run()
    {
        $beginMiddleware = new BeginMiddleware;
        $beginMiddleware->bindMiddlewareState($this);
        $beginMiddleware->execute();

        $endMiddleware = new EndMiddleware;
        $endMiddleware->bindMiddlewareState($this);
        $endMiddleware->execute();
    }

    /**
     * Returns the sorted list of middlewares bound to the given signal name.
     *
     * @param string $signalName
     * @return array
     */
    public function getMiddlewaresBoundToSignal($signalName)
    {
        $signalSortedMiddlewares = $this->getSignalSortedMiddlewares();

        return (isset($signalSortedMiddlewares[$signalName]))
            ? $signalSortedMiddlewares[$signalName]
            : [];
    }

    /**
     * Returns a sorted list of the registered middlewares: the first level is
     * the signal used by the group, and the second level is the group of
     * middlewares, sorted by descendant priority of each middleware.
     *
     * @return array
     */
    protected function getSignalSortedMiddlewares()
    {
        if (empty($this->signalSortedMiddlewares)) {
            $this->signalSortedMiddlewares = [];
            $middlewareList = [];

            foreach ($this->list as $middleware) {
                $signal = $middleware->getBoundSignalName();

                if (false === isset($middlewareList[$signal])) {
                    $middlewareList[$signal] = [];
                }

                $middlewareList[$signal][] = $middleware;
            }

            foreach ($middlewareList as $key => $list) {
                $this->signalSortedMiddlewares[$key] = $this->sortMiddlewaresListByPriority($list);
            }
        }

        return $this->signalSortedMiddlewares;
    }

    /**
     * Will sort and return a middlewares list based on the priority of each
     * middleware. The middlewares with the highest priority will be placed at
     * the top of the list.
     *
     * @param array $list
     * @return array
     */
    private function sortMiddlewaresListByPriority(array $list)
    {
        usort($list, function (MiddlewareInterface $a, MiddlewareInterface $b) {
            $priorityA = (int)$a->getPriority();
            $priorityB = (int)$b->getPriority();

            if ($priorityA === $priorityB) {
                return 0;
            }

            return $priorityA < $priorityB
                ? 1
                : -1;
        });

        return $list;
    }

    /**
     * @return FormObject
     */
    public function getFormObject()
    {
        return $this->formObject;
    }

    /**
     * @return FormResult
     */
    public function getResult()
    {
        if (null === $this->result) {
            $this->result = new FormResult;
        }

        return $this->result;
    }

    /**
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * @return Arguments
     */
    public function getArguments()
    {
        return $this->arguments;
    }

    /**
     * @return array
     */
    public function getSettings()
    {
        return $this->settings;
    }
}


1			<?php
2			/*
3			* 2017 Romain CANON <[email protected]>
4			*
5			* This file is part of the TYPO3 FormZ project.
6			* It is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU General Public License, either
8			* version 3 of the License, or any later version.
9			*
10			* For the full copyright and license information, see:
11			* http://www.gnu.org/licenses/gpl-3.0.html
12			*/
13
14			namespace Romm\Formz\Middleware\State;
15
16			use Romm\Formz\Controller\ControllerState;
17			use Romm\Formz\Error\FormResult;
18			use Romm\Formz\Form\FormObject;
19			use Romm\Formz\Middleware\Items\Begin\BeginMiddleware;
20			use Romm\Formz\Middleware\Items\End\EndMiddleware;
21			use Romm\Formz\Middleware\MiddlewareInterface;
22			use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
23			use TYPO3\CMS\Extbase\Mvc\Web\Request;
24
25			/**
26			* @todo: loop on middlewares and detect which ones are using signals that wont
27			* be processed. This should probably be a validator put on:
28			* \Romm\Formz\Configuration\Form\Form::$middlewares
29			*/
30			class MiddlewareState
31			{
32			/**
33			* @var MiddlewareInterface[]
34			*/
35			protected $list = [];
36
37			/**
38			* @var FormObject
39			*/
40			protected $formObject;
41
42			/**
43			* @var FormResult
44			*/
45			protected $result;
46
47			/**
48			* @var Request
49			*/
50			protected $request;
51
52			/**
53			* @var Arguments
54			*/
55			protected $arguments;
56
57			/**
58			* @var array
59			*/
60			protected $settings;
61
62			/**
63			* @see getSignalSortedMiddlewares()
64			*
65			* @var array
66			*/
67			protected $signalSortedMiddlewares = [];
68
69			/**
70			* @param FormObject $formObject
71			* @param ControllerState $controllerState
72			*/
73			public function __construct(FormObject $formObject, ControllerState $controllerState)
74			{
75			$this->formObject = $formObject;
76			$this->request = $controllerState->getRequest();
77			$this->arguments = $controllerState->getArguments();
78			$this->settings = $controllerState->getSettings();
79
80			foreach ($this->formObject->getConfiguration()->getMiddlewares() as $middleware) {
81			$this->list[] = $middleware;
82
83			$middleware->bindMiddlewareState($this);
84			$middleware->initialize();
85			}
86			}
87
88			/**
89			* Will run and process trough every middleware registered for the current
90			* form object.
91			*/
92			public function run()
93			{
94			$beginMiddleware = new BeginMiddleware;
95			$beginMiddleware->bindMiddlewareState($this);
96			$beginMiddleware->execute();
97
98			$endMiddleware = new EndMiddleware;
99			$endMiddleware->bindMiddlewareState($this);
100			$endMiddleware->execute();
101			}
102
103			/**
104			* Returns the sorted list of middlewares bound to the given signal name.
105			*
106			* @param string $signalName
107			* @return array
108			*/
109			public function getMiddlewaresBoundToSignal($signalName)
110			{
111			$signalSortedMiddlewares = $this->getSignalSortedMiddlewares();
112
113			return (isset($signalSortedMiddlewares[$signalName]))
114			? $signalSortedMiddlewares[$signalName]
115			: [];
116			}
117
118			/**
119			* Returns a sorted list of the registered middlewares: the first level is
120			* the signal used by the group, and the second level is the group of
121			* middlewares, sorted by descendant priority of each middleware.
122			*
123			* @return array
124			*/
125			protected function getSignalSortedMiddlewares()
126			{
127			if (empty($this->signalSortedMiddlewares)) {
128			$this->signalSortedMiddlewares = [];
129			$middlewareList = [];
130
131			foreach ($this->list as $middleware) {
132			$signal = $middleware->getBoundSignalName();
133
134			if (false === isset($middlewareList[$signal])) {
135			$middlewareList[$signal] = [];
136			}
137
138			$middlewareList[$signal][] = $middleware;
139			}
140
141			foreach ($middlewareList as $key => $list) {
142			$this->signalSortedMiddlewares[$key] = $this->sortMiddlewaresListByPriority($list);
143			}
144			}
145
146			return $this->signalSortedMiddlewares;
147			}
148
149			/**
150			* Will sort and return a middlewares list based on the priority of each
151			* middleware. The middlewares with the highest priority will be placed at
152			* the top of the list.
153			*
154			* @param array $list
155			* @return array
156			*/
157			private function sortMiddlewaresListByPriority(array $list)
158			{
159			usort($list, function (MiddlewareInterface $a, MiddlewareInterface $b) {
160			$priorityA = (int)$a->getPriority();
161			$priorityB = (int)$b->getPriority();
162
163			if ($priorityA === $priorityB) {
164			return 0;
165			}
166
167			return $priorityA < $priorityB
168			? 1
169			: -1;
170			});
171
172			return $list;
173			}
174
175			/**
176			* @return FormObject
177			*/
178			public function getFormObject()
179			{
180			return $this->formObject;
181			}
182
183			/**
184			* @return FormResult
185			*/
186			public function getResult()
187			{
188			if (null === $this->result) {
189			$this->result = new FormResult;
190			}
191
192			return $this->result;
193			}
194
195			/**
196			* @return Request
197			*/
198			public function getRequest()
199			{
200			return $this->request;
201			}
202
203			/**
204			* @return Arguments
205			*/
206			public function getArguments()
207			{
208			return $this->arguments;
209			}
210
211			/**
212			* @return array
213			*/
214			public function getSettings()
215			{
216			return $this->settings;
217			}
218			}
219

romm / formz

Push — middleware-wip ( ab6ae7...17e892 )

MiddlewareState::dispatchAfterSignal() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like