AbstractMiddleware - Code Metrics - Inspection of "[CLEANUP] Clean classes" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — middleware-wip ( 4ea7b3...161931 )

by Romain

created 2017-03-29 14:41 UTC

AbstractMiddleware A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
wmc	25
lcom	1
cbo	10
dl	0
loc	219
rs	10
c	0
b	0
f	0

18 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	initialize()	4	1
A	initializeMiddleware()	3	1
A	beforeSignal()	4	1
A	afterSignal()	4	1
A	forward()	4	1
A	redirect()	3	1
A	stopPropagation()	4	1
A	getFormObject()	4	1
A	getResult()	4	1
A	getRequest()	4	1
A	getRequestArguments()	4	1
A	getSettings()	4	1
A	getPriority()	4	1
A	bindMiddlewareState()	4	1
A	getBoundSignalName()	12	3
A	dataPreProcessor()	10	2
B	getSignalObject()	21	5

<?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\Item;

use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessor;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessorInterface;
use Romm\Formz\Error\FormResult;
use Romm\Formz\Exceptions\InvalidArgumentValueException;
use Romm\Formz\Exceptions\InvalidEntryException;
use Romm\Formz\Exceptions\MissingArgumentException;
use Romm\Formz\Exceptions\SignalNotFoundException;
use Romm\Formz\Form\FormObject;
use Romm\Formz\Middleware\Option\AbstractOptionDefinition;
use Romm\Formz\Middleware\Request\Exception\StopPropagationException;
use Romm\Formz\Middleware\MiddlewareInterface;
use Romm\Formz\Middleware\Request\Forward;
use Romm\Formz\Middleware\Request\Redirect;
use Romm\Formz\Middleware\Signal\After;
use Romm\Formz\Middleware\Signal\Before;
use Romm\Formz\Middleware\Signal\MiddlewareSignal;
use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
use Romm\Formz\Middleware\Signal\SignalObject;
use Romm\Formz\Middleware\State\MiddlewareState;
use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
use TYPO3\CMS\Extbase\Mvc\Web\Request;

/**
 * Abstract class that must be extended by middlewares.
 *
 * Child middleware must implement their own signals.
 */
abstract class AbstractMiddleware implements MiddlewareInterface, DataPreProcessorInterface
{
    /**
     * @var MiddlewareState
     */
    private $state;

    /**
     * @var \Romm\Formz\Middleware\Option\DefaultOptionDefinition
     */
    protected $options;

    /**
     * @param AbstractOptionDefinition $options
     */
    final public function __construct(AbstractOptionDefinition $options)
    {
        $this->options = $options;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
    }

    /**
     * Abstraction for processing the middleware initialization.
     *
     * For own initialization, @see initializeMiddleware()
     */
    final public function initialize()
    {
        $this->initializeMiddleware();
    }

    /**
     * You can override this method in your child class to initialize your
     * middleware correctly.
     */
    protected function initializeMiddleware()
    {
    }

    /**
     * @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::beforeSignal()
     *
     * @param string $signal
     * @return SignalObject
     */
    final public function beforeSignal($signal = null)
    {
        return $this->getSignalObject($signal, Before::class);
    }

    /**
     * @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::afterSignal()
     *
     * @param string $signal
     * @return SignalObject
     */
    final public function afterSignal($signal = null)
    {
        return $this->getSignalObject($signal, After::class);
    }

    /**
     * Returns a new forward dispatcher, on which you can add options by calling
     * its fluent methods.
     *
     * You must call the method `dispatch()` to actually dispatch the forward
     * signal.
     *
     * @return Forward
     */
    final protected function forward()
    {
        return new Forward($this->getRequest());
    }

    /**
     * Returns a new redirect dispatcher, on which you can add options by
     * calling its fluent methods.
     *
     * You must call the method `dispatch()` to actually dispatch the redirect
     * signal.
     *
     * @return Redirect
     */
    final protected function redirect() {
        return new Redirect($this->getRequest());
    }

    /**
     * Will stop the propagation of middlewares: the next middlewares wont be
     * processed.
     *
     * Use with caution!
     */
    final protected function stopPropagation()
    {
        throw new StopPropagationException;
    }

    /**
     * @return FormObject
     */
    final protected function getFormObject()
    {
        return $this->state->getFormObject();
    }

    /**
     * @return FormResult
     */
    final protected function getResult()
    {
        return $this->state->getResult();
    }

    /**
     * @return Request
     */
    final protected function getRequest()
    {
        return $this->state->getRequest();
    }

    /**
     * @return Arguments
     */
    final protected function getRequestArguments()
    {
        return $this->state->getRequestArguments();
    }

    /**
     * @return array
     */
    final protected function getSettings()
    {
        return $this->state->getSettings();
    }

    /**
     * @return int
     */
    public function getPriority()
    {
        return 0;
    }

    /**
     * @param MiddlewareState $middlewareState
     */
    final public function bindMiddlewareState(MiddlewareState $middlewareState)
    {
        $this->state = $middlewareState;
    }

    /**
     * Returns the name of the signal on which this middleware is bound.
     *
     * @return string
     * @throws SignalNotFoundException
     */
    final public function getBoundSignalName()
    {
        $interfaces = class_implements($this);

        foreach ($interfaces as $interface) {
            if (in_array(MiddlewareSignal::class, class_implements($interface))) {
                return $interface;
            }
        }

        throw SignalNotFoundException::signalNotFoundInMiddleware($this);
    }

    /**
     * Will inject empty options if no option has been defined at all.
     *
     * @param DataPreProcessor $processor
     */
    public static function dataPreProcessor(DataPreProcessor $processor)
    {
        $data = $processor->getData();

        if (false === isset($data['options'])) {
            $data['options'] = [];
        }

        $processor->setData($data);
    }

    /**
     * @param string $signal
     * @param string $type
     * @return SignalObject
     * @throws InvalidArgumentValueException
     * @throws InvalidEntryException
     * @throws MissingArgumentException
     */
    private function getSignalObject($signal, $type)
    {
        if (false === $this instanceof SendsMiddlewareSignal) {
            throw InvalidEntryException::middlewareNotSendingSignals($this);
        }

        /** @var SendsMiddlewareSignal $this */
        if (null === $signal) {
            if (count($this->getAllowedSignals()) > 1) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                throw MissingArgumentException::signalNameArgumentMissing($this);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }

            $signal = reset($this->getAllowedSignals());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        if (false === in_array($signal, $this->getAllowedSignals())) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            throw InvalidArgumentValueException::signalNotAllowed($this);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return new SignalObject($this->state, $signal, $type);
    }
}


Push — middleware-wip ( 4ea7b3...161931 )

AbstractMiddleware A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

Available Fixes

Available Fixes

Available Fixes

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\Item;
15
16			use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessor;
17			use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessorInterface;
18			use Romm\Formz\Error\FormResult;
19			use Romm\Formz\Exceptions\InvalidArgumentValueException;
20			use Romm\Formz\Exceptions\InvalidEntryException;
21			use Romm\Formz\Exceptions\MissingArgumentException;
22			use Romm\Formz\Exceptions\SignalNotFoundException;
23			use Romm\Formz\Form\FormObject;
24			use Romm\Formz\Middleware\Option\AbstractOptionDefinition;
25			use Romm\Formz\Middleware\Request\Exception\StopPropagationException;
26			use Romm\Formz\Middleware\MiddlewareInterface;
27			use Romm\Formz\Middleware\Request\Forward;
28			use Romm\Formz\Middleware\Request\Redirect;
29			use Romm\Formz\Middleware\Signal\After;
30			use Romm\Formz\Middleware\Signal\Before;
31			use Romm\Formz\Middleware\Signal\MiddlewareSignal;
32			use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
33			use Romm\Formz\Middleware\Signal\SignalObject;
34			use Romm\Formz\Middleware\State\MiddlewareState;
35			use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
36			use TYPO3\CMS\Extbase\Mvc\Web\Request;
37
38			/**
39			* Abstract class that must be extended by middlewares.
40			*
41			* Child middleware must implement their own signals.
42			*/
43			abstract class AbstractMiddleware implements MiddlewareInterface, DataPreProcessorInterface
44			{
45			/**
46			* @var MiddlewareState
47			*/
48			private $state;
49
50			/**
51			* @var \Romm\Formz\Middleware\Option\DefaultOptionDefinition
52			*/
53			protected $options;
54
55			/**
56			* @param AbstractOptionDefinition $options
57			*/
58			final public function __construct(AbstractOptionDefinition $options)
59			{
60			$this->options = $options;
			0 ignored issues – show Documentation Bug introduced 2017-03-28 12:00 UTC by Report Bug Copy Issue Report `$options` is of type `object<Romm\Formz\Middle...stractOptionDefinition>`, but the property `$options` was declared to be of type `object<Romm\Formz\Middle...efaultOptionDefinition>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
61			}
62
63			/**
64			* Abstraction for processing the middleware initialization.
65			*
66			* For own initialization, @see initializeMiddleware()
67			*/
68			final public function initialize()
69			{
70			$this->initializeMiddleware();
71			}
72
73			/**
74			* You can override this method in your child class to initialize your
75			* middleware correctly.
76			*/
77			protected function initializeMiddleware()
78			{
79			}
80
81			/**
82			* @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::beforeSignal()
83			*
84			* @param string $signal
85			* @return SignalObject
86			*/
87			final public function beforeSignal($signal = null)
88			{
89			return $this->getSignalObject($signal, Before::class);
90			}
91
92			/**
93			* @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::afterSignal()
94			*
95			* @param string $signal
96			* @return SignalObject
97			*/
98			final public function afterSignal($signal = null)
99			{
100			return $this->getSignalObject($signal, After::class);
101			}
102
103			/**
104			* Returns a new forward dispatcher, on which you can add options by calling
105			* its fluent methods.
106			*
107			* You must call the method `dispatch()` to actually dispatch the forward
108			* signal.
109			*
110			* @return Forward
111			*/
112			final protected function forward()
113			{
114			return new Forward($this->getRequest());
115			}
116
117			/**
118			* Returns a new redirect dispatcher, on which you can add options by
119			* calling its fluent methods.
120			*
121			* You must call the method `dispatch()` to actually dispatch the redirect
122			* signal.
123			*
124			* @return Redirect
125			*/
126			final protected function redirect() {
127			return new Redirect($this->getRequest());
128			}
129
130			/**
131			* Will stop the propagation of middlewares: the next middlewares wont be
132			* processed.
133			*
134			* Use with caution!
135			*/
136			final protected function stopPropagation()
137			{
138			throw new StopPropagationException;
139			}
140
141			/**
142			* @return FormObject
143			*/
144			final protected function getFormObject()
145			{
146			return $this->state->getFormObject();
147			}
148
149			/**
150			* @return FormResult
151			*/
152			final protected function getResult()
153			{
154			return $this->state->getResult();
155			}
156
157			/**
158			* @return Request
159			*/
160			final protected function getRequest()
161			{
162			return $this->state->getRequest();
163			}
164
165			/**
166			* @return Arguments
167			*/
168			final protected function getRequestArguments()
169			{
170			return $this->state->getRequestArguments();
171			}
172
173			/**
174			* @return array
175			*/
176			final protected function getSettings()
177			{
178			return $this->state->getSettings();
179			}
180
181			/**
182			* @return int
183			*/
184			public function getPriority()
185			{
186			return 0;
187			}
188
189			/**
190			* @param MiddlewareState $middlewareState
191			*/
192			final public function bindMiddlewareState(MiddlewareState $middlewareState)
193			{
194			$this->state = $middlewareState;
195			}
196
197			/**
198			* Returns the name of the signal on which this middleware is bound.
199			*
200			* @return string
201			* @throws SignalNotFoundException
202			*/
203			final public function getBoundSignalName()
204			{
205			$interfaces = class_implements($this);
206
207			foreach ($interfaces as $interface) {
208			if (in_array(MiddlewareSignal::class, class_implements($interface))) {
209			return $interface;
210			}
211			}
212
213			throw SignalNotFoundException::signalNotFoundInMiddleware($this);
214			}
215
216			/**
217			* Will inject empty options if no option has been defined at all.
218			*
219			* @param DataPreProcessor $processor
220			*/
221			public static function dataPreProcessor(DataPreProcessor $processor)
222			{
223			$data = $processor->getData();
224
225			if (false === isset($data['options'])) {
226			$data['options'] = [];
227			}
228
229			$processor->setData($data);
230			}
231
232			/**
233			* @param string $signal
234			* @param string $type
235			* @return SignalObject
236			* @throws InvalidArgumentValueException
237			* @throws InvalidEntryException
238			* @throws MissingArgumentException
239			*/
240			private function getSignalObject($signal, $type)
241			{
242			if (false === $this instanceof SendsMiddlewareSignal) {
243			throw InvalidEntryException::middlewareNotSendingSignals($this);
244			}
245
246			/** @var SendsMiddlewareSignal $this */
247			if (null === $signal) {
248			if (count($this->getAllowedSignals()) > 1) {
			0 ignored issues – show Bug introduced 2017-03-29 14:45 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Romm\Formz\Middleware\Item\AbstractMiddleware` as the method `getAllowedSignals()` does only exist in the following sub-classes of `Romm\Formz\Middleware\Item\AbstractMiddleware`: `Romm\Formz\Middleware\It...our\BehaviourMiddleware`, `Romm\Formz\Middleware\It...ormValidationMiddleware`, `Romm\Formz\Middleware\It...rm\InjectFormMiddleware`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
249			throw MissingArgumentException::signalNameArgumentMissing($this);
			0 ignored issues – show Documentation introduced 2017-03-29 14:45 UTC by Report Bug Copy Issue Report `$this` is of type `this<Romm\Formz\Middlewa...tem\AbstractMiddleware>`, but the function expects a `object<Romm\Formz\Middle...\SendsMiddlewareSignal>`. 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...
250			}
251
252			$signal = reset($this->getAllowedSignals());
			0 ignored issues – show Bug introduced 2017-03-29 14:45 UTC by Report Bug Copy Issue Report `$this->getAllowedSignals()` cannot be passed to `reset()` as the parameter `$array` expects a reference. Loading history... Bug introduced 2017-03-29 14:45 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Romm\Formz\Middleware\Item\AbstractMiddleware` as the method `getAllowedSignals()` does only exist in the following sub-classes of `Romm\Formz\Middleware\Item\AbstractMiddleware`: `Romm\Formz\Middleware\It...our\BehaviourMiddleware`, `Romm\Formz\Middleware\It...ormValidationMiddleware`, `Romm\Formz\Middleware\It...rm\InjectFormMiddleware`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
253			}
254
255			if (false === in_array($signal, $this->getAllowedSignals())) {
			0 ignored issues – show Bug introduced 2017-03-29 14:45 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Romm\Formz\Middleware\Item\AbstractMiddleware` as the method `getAllowedSignals()` does only exist in the following sub-classes of `Romm\Formz\Middleware\Item\AbstractMiddleware`: `Romm\Formz\Middleware\It...our\BehaviourMiddleware`, `Romm\Formz\Middleware\It...ormValidationMiddleware`, `Romm\Formz\Middleware\It...rm\InjectFormMiddleware`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
256			throw InvalidArgumentValueException::signalNotAllowed($this);
			0 ignored issues – show Documentation introduced 2017-03-29 14:45 UTC by Report Bug Copy Issue Report `$this` is of type `this<Romm\Formz\Middlewa...tem\AbstractMiddleware>`, but the function expects a `object<Romm\Formz\Middle...\SendsMiddlewareSignal>`. 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...
257			}
258
259			return new SignalObject($this->state, $signal, $type);
260			}
261			}
262

romm / formz

Push — middleware-wip ( 4ea7b3...161931 )

AbstractMiddleware A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like