AbstractMiddleware - Code Metrics - Inspection of "wip" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — wip/steps ( 593c83...eae10b )

by Romain

created 2017-09-25 09:22 UTC

AbstractMiddleware A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	282
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	32
c	1
b	0
f	0
lcom	2
cbo	12
dl	0
loc	282
rs	9.6

21 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	initialize()	4	1
A	initializeMiddleware()	3	1
A	beforeSignal()	4	1
A	afterSignal()	4	1
A	getOptions()	4	1
A	redirectToNextStep()	19	4
A	getScopes()	4	1
A	forward()	4	1
A	redirect()	4	1
A	getFormObject()	4	1
A	getRequest()	4	1
A	getRequestArguments()	4	1
A	getSettings()	4	1
A	getCurrentStep()	4	1
A	getPriority()	4	1
A	bindMiddlewareProcessor()	4	1
A	getBoundSignalName()	12	3
A	dataPreProcessor()	14	3
B	getSignalObject()	21	5
A	__sleep()	4	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\Item;

use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessor;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessorInterface;
use Romm\Formz\Exceptions\InvalidArgumentValueException;
use Romm\Formz\Exceptions\InvalidEntryException;
use Romm\Formz\Exceptions\MissingArgumentException;
use Romm\Formz\Exceptions\SignalNotFoundException;
use Romm\Formz\Form\Definition\Step\Step\Step;
use Romm\Formz\Form\Definition\Middleware\MiddlewareScopes;
use Romm\Formz\Form\FormObject\FormObject;
use Romm\Formz\Middleware\Item\Step\Service\StepMiddlewareService;
use Romm\Formz\Middleware\MiddlewareInterface;
use Romm\Formz\Middleware\Option\AbstractOptionDefinition;
use Romm\Formz\Middleware\Option\OptionInterface;
use Romm\Formz\Middleware\Processor\MiddlewareProcessor;
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 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 MiddlewareProcessor
     */
    private $processor;

    /**
     * This is the default option class, this property can be overridden in
     * child classes to be mapped to another option definition.
     *
     * @var \Romm\Formz\Middleware\Option\DefaultOptionDefinition
     */
    protected $options;

    /**
     * @var \Romm\Formz\Form\Definition\Middleware\MiddlewareScopes
     */
    protected $scopes = [];

    /**
     * Can be overridden in child class with custom priority value.
     *
     * The higher the priority is, the earlier the middleware is called.
     *
     * Note that you can also override the method `getPriority()` for advanced
     * priority calculation.
     *
     * @var int
     */
    protected $priority = 0;

    /**
     * @param OptionInterface  $options
     * @param MiddlewareScopes $scopes
     */
    final public function __construct(OptionInterface $options, MiddlewareScopes $scopes)
    {
        $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;
}
        $this->scopes = $scopes;
    }

    /**
     * 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);
    }

    /**
     * @return AbstractOptionDefinition
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * @todo
     */
    protected function redirectToNextStep()
    {
        $formObject = $this->getFormObject();

        if ($formObject->hasForm()
            && $formObject->isPersistent()
        ) {
            $formObject->getFormMetadata()->persist();
        }

        $service = StepMiddlewareService::get();
        $nextStep = $service->getNextStep($this->getCurrentStep());

        if ($nextStep) {
            $this->beforeSignal()->dispatch();

            $service->moveForwardToStep($nextStep, $this->redirect());
        }
    }

    /**
     * @return MiddlewareScopes
     */
    public function getScopes()
    {
        return $this->scopes;
    }

    /**
     * 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(), $this->getFormObject());
    }

    /**
     * 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(), $this->getFormObject());
    }

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

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

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

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

    /**
     * @return Step|null
     */
    final protected function getCurrentStep()
    {
        return $this->getFormObject()->getCurrentStep();
    }

    /**
     * @return int
     */
    public function getPriority()
    {
        return (int)$this->priority;
    }

    /**
     * @param MiddlewareProcessor $middlewareProcessor
     */
    final public function bindMiddlewareProcessor(MiddlewareProcessor $middlewareProcessor)
    {
        $this->processor = $middlewareProcessor;
    }

    /**
     * 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'] = [];
        }

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

        $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->processor, $signal, $type);
    }

    /**
     * @return array
     */
    public function __sleep()
    {
        return ['options', 'scopes'];
    }
}


Push — wip/steps ( 593c83...eae10b )

AbstractMiddleware A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

21 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\Exceptions\InvalidArgumentValueException;
19			use Romm\Formz\Exceptions\InvalidEntryException;
20			use Romm\Formz\Exceptions\MissingArgumentException;
21			use Romm\Formz\Exceptions\SignalNotFoundException;
22			use Romm\Formz\Form\Definition\Step\Step\Step;
23			use Romm\Formz\Form\Definition\Middleware\MiddlewareScopes;
24			use Romm\Formz\Form\FormObject\FormObject;
25			use Romm\Formz\Middleware\Item\Step\Service\StepMiddlewareService;
26			use Romm\Formz\Middleware\MiddlewareInterface;
27			use Romm\Formz\Middleware\Option\AbstractOptionDefinition;
28			use Romm\Formz\Middleware\Option\OptionInterface;
29			use Romm\Formz\Middleware\Processor\MiddlewareProcessor;
30			use Romm\Formz\Middleware\Request\Forward;
31			use Romm\Formz\Middleware\Request\Redirect;
32			use Romm\Formz\Middleware\Signal\After;
33			use Romm\Formz\Middleware\Signal\Before;
34			use Romm\Formz\Middleware\Signal\MiddlewareSignal;
35			use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
36			use Romm\Formz\Middleware\Signal\SignalObject;
37			use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
38			use TYPO3\CMS\Extbase\Mvc\Web\Request;
39
40			/**
41			* Abstract class that must be extended by middlewares.
42			*
43			* Child middleware must implement their own signals.
44			*/
45			abstract class AbstractMiddleware implements MiddlewareInterface, DataPreProcessorInterface
46			{
47			/**
48			* @var MiddlewareProcessor
49			*/
50			private $processor;
51
52			/**
53			* This is the default option class, this property can be overridden in
54			* child classes to be mapped to another option definition.
55			*
56			* @var \Romm\Formz\Middleware\Option\DefaultOptionDefinition
57			*/
58			protected $options;
59
60			/**
61			* @var \Romm\Formz\Form\Definition\Middleware\MiddlewareScopes
62			*/
63			protected $scopes = [];
64
65			/**
66			* Can be overridden in child class with custom priority value.
67			*
68			* The higher the priority is, the earlier the middleware is called.
69			*
70			* Note that you can also override the method `getPriority()` for advanced
71			* priority calculation.
72			*
73			* @var int
74			*/
75			protected $priority = 0;
76
77			/**
78			* @param OptionInterface $options
79			* @param MiddlewareScopes $scopes
80			*/
81			final public function __construct(OptionInterface $options, MiddlewareScopes $scopes)
82			{
83			$this->options = $options;
			0 ignored issues – show Documentation Bug introduced 2017-09-25 09:27 UTC by Report Bug Copy Issue Report `$options` is of type `object<Romm\Formz\Middle...Option\OptionInterface>`, 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...
84			$this->scopes = $scopes;
85			}
86
87			/**
88			* Abstraction for processing the middleware initialization.
89			*
90			* For own initialization, @see initializeMiddleware()
91			*/
92			final public function initialize()
93			{
94			$this->initializeMiddleware();
95			}
96
97			/**
98			* You can override this method in your child class to initialize your
99			* middleware correctly.
100			*/
101			protected function initializeMiddleware()
102			{
103			}
104
105			/**
106			* @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::beforeSignal()
107			*
108			* @param string $signal
109			* @return SignalObject
110			*/
111			final public function beforeSignal($signal = null)
112			{
113			return $this->getSignalObject($signal, Before::class);
114			}
115
116			/**
117			* @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::afterSignal()
118			*
119			* @param string $signal
120			* @return SignalObject
121			*/
122			final public function afterSignal($signal = null)
123			{
124			return $this->getSignalObject($signal, After::class);
125			}
126
127			/**
128			* @return AbstractOptionDefinition
129			*/
130			public function getOptions()
131			{
132			return $this->options;
133			}
134
135			/**
136			* @todo
137			*/
138			protected function redirectToNextStep()
139			{
140			$formObject = $this->getFormObject();
141
142			if ($formObject->hasForm()
143			&& $formObject->isPersistent()
144			) {
145			$formObject->getFormMetadata()->persist();
146			}
147
148			$service = StepMiddlewareService::get();
149			$nextStep = $service->getNextStep($this->getCurrentStep());
150
151			if ($nextStep) {
152			$this->beforeSignal()->dispatch();
153
154			$service->moveForwardToStep($nextStep, $this->redirect());
155			}
156			}
157
158			/**
159			* @return MiddlewareScopes
160			*/
161			public function getScopes()
162			{
163			return $this->scopes;
164			}
165
166			/**
167			* Returns a new forward dispatcher, on which you can add options by calling
168			* its fluent methods.
169			*
170			* You must call the method `dispatch()` to actually dispatch the forward
171			* signal.
172			*
173			* @return Forward
174			*/
175			final protected function forward()
176			{
177			return new Forward($this->getRequest(), $this->getFormObject());
178			}
179
180			/**
181			* Returns a new redirect dispatcher, on which you can add options by
182			* calling its fluent methods.
183			*
184			* You must call the method `dispatch()` to actually dispatch the redirect
185			* signal.
186			*
187			* @return Redirect
188			*/
189			final protected function redirect()
190			{
191			return new Redirect($this->getRequest(), $this->getFormObject());
192			}
193
194			/**
195			* @return FormObject
196			*/
197			final protected function getFormObject()
198			{
199			return $this->processor->getFormObject();
200			}
201
202			/**
203			* @return Request
204			*/
205			final protected function getRequest()
206			{
207			return $this->processor->getRequest();
208			}
209
210			/**
211			* @return Arguments
212			*/
213			final protected function getRequestArguments()
214			{
215			return $this->processor->getRequestArguments();
216			}
217
218			/**
219			* @return array
220			*/
221			final protected function getSettings()
222			{
223			return $this->processor->getSettings();
224			}
225
226			/**
227			* @return Step\|null
228			*/
229			final protected function getCurrentStep()
230			{
231			return $this->getFormObject()->getCurrentStep();
232			}
233
234			/**
235			* @return int
236			*/
237			public function getPriority()
238			{
239			return (int)$this->priority;
240			}
241
242			/**
243			* @param MiddlewareProcessor $middlewareProcessor
244			*/
245			final public function bindMiddlewareProcessor(MiddlewareProcessor $middlewareProcessor)
246			{
247			$this->processor = $middlewareProcessor;
248			}
249
250			/**
251			* Returns the name of the signal on which this middleware is bound.
252			*
253			* @return string
254			* @throws SignalNotFoundException
255			*/
256			final public function getBoundSignalName()
257			{
258			$interfaces = class_implements($this);
259
260			foreach ($interfaces as $interface) {
261			if (in_array(MiddlewareSignal::class, class_implements($interface))) {
262			return $interface;
263			}
264			}
265
266			throw SignalNotFoundException::signalNotFoundInMiddleware($this);
267			}
268
269			/**
270			* Will inject empty options if no option has been defined at all.
271			*
272			* @param DataPreProcessor $processor
273			*/
274			public static function dataPreProcessor(DataPreProcessor $processor)
275			{
276			$data = $processor->getData();
277
278			if (false === isset($data['options'])) {
279			$data['options'] = [];
280			}
281
282			if (false === isset($data['scopes'])) {
283			$data['scopes'] = [];
284			}
285
286			$processor->setData($data);
287			}
288
289			/**
290			* @param string $signal
291			* @param string $type
292			* @return SignalObject
293			* @throws InvalidArgumentValueException
294			* @throws InvalidEntryException
295			* @throws MissingArgumentException
296			*/
297			private function getSignalObject($signal, $type)
298			{
299			if (false === $this instanceof SendsMiddlewareSignal) {
300			throw InvalidEntryException::middlewareNotSendingSignals($this);
301			}
302
303			/** @var SendsMiddlewareSignal $this */
304			if (null === $signal) {
305			if (count($this->getAllowedSignals()) > 1) {
			0 ignored issues – show Bug introduced 2017-07-06 12:43 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...FormInjectionMiddleware`, `Romm\Formz\Middleware\It...ormValidationMiddleware`, `Romm\Formz\Middleware\It...tenceFetchingMiddleware`, `Romm\Formz\Middleware\It...epDispatchingMiddleware`. 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...
306			throw MissingArgumentException::signalNameArgumentMissing($this);
			0 ignored issues – show Documentation introduced 2017-04-18 15:17 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...
307			}
308
309			$signal = reset($this->getAllowedSignals());
			0 ignored issues – show Bug introduced 2017-04-18 15:17 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-07-06 12:43 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...FormInjectionMiddleware`, `Romm\Formz\Middleware\It...ormValidationMiddleware`, `Romm\Formz\Middleware\It...tenceFetchingMiddleware`, `Romm\Formz\Middleware\It...epDispatchingMiddleware`. 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...
310			}
311
312			if (false === in_array($signal, $this->getAllowedSignals())) {
			0 ignored issues – show Bug introduced 2017-07-06 12:43 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...FormInjectionMiddleware`, `Romm\Formz\Middleware\It...ormValidationMiddleware`, `Romm\Formz\Middleware\It...tenceFetchingMiddleware`, `Romm\Formz\Middleware\It...epDispatchingMiddleware`. 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...
313			throw InvalidArgumentValueException::signalNotAllowed($this);
			0 ignored issues – show Documentation introduced 2017-04-19 14:49 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...
314			}
315
316			return new SignalObject($this->processor, $signal, $type);
317			}
318
319			/**
320			* @return array
321			*/
322			public function __sleep()
323			{
324			return ['options', 'scopes'];
325			}
326			}
327

romm / formz

Push — wip/steps ( 593c83...eae10b )

AbstractMiddleware A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

21 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like