StepDispatchingMiddleware::process() - Code Metrics - Inspection of "WIP" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — middleware-wip ( a29b16...4a8d7b )

by Romain

created 2017-05-23 14:18 UTC

StepDispatchingMiddleware::process() D

↳ Parent: StepDispatchingMiddleware

Complexity

Conditions	9
Paths	9

Size

Total Lines	43
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	43
rs	4.909
c	1
b	0
f	0
cc	9
eloc	21
nc	9
nop	0

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

use Romm\Formz\Exceptions\InvalidArgumentTypeException;
use Romm\Formz\Middleware\Item\DefaultMiddleware;
use Romm\Formz\Middleware\Item\Step\Service\StepMiddlewareService;
use Romm\Formz\Middleware\Processor\PresetMiddlewareInterface;

/**
 * This middleware should be the last one called, as it is used to dispatch the
 * request to the next step, if there is one.
 */
class StepDispatchingMiddleware extends DefaultMiddleware implements PresetMiddlewareInterface
{
    /**
     * @var int
     */
    protected $priority = self::PRIORITY_STEP;

    /**
     * @var StepMiddlewareService
     */
    protected $service;

    /**
     * Inject the step service.
     */
    public function initializeMiddleware()
    {
        $this->service = StepMiddlewareService::get();
    }

    /**
     * @see StepDispatchingMiddleware
     */
    protected function process()
    {
        $formObject = $this->getFormObject();
        
        if (false === $formObject->getDefinition()->hasSteps()) {
            return;
        }
        
        $formResult = $formObject->getFormResult();

        if ($formObject->formWasSubmitted()
            && false === $formResult->hasErrors()
        ) {
            if ($formObject->getCurrentSubstepDefinition()
                && false === $formObject->getCurrentSubstepDefinition()->isLast()
            ) {
                return;
            }

            /*
             * The form was submitted, and no error was found, we can safely
             * dispatch the request to the next step.
             */
            $currentStep = $this->getCurrentStep();
            $currentStepDefinition = $this->service->getStepDefinition($currentStep);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

            // Saving submitted form data for further usage.
            $this->service->markStepAsValidated($currentStepDefinition, $this->getFormRawValues());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $this->service->addValidatedFields($formResult->getValidatedFields());

            $nextStep = null;

            if ($currentStepDefinition->hasNextStep()) {
                $nextStep = $this->service->getNextStepDefinition($currentStepDefinition);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            } elseif ($currentStepDefinition->isInDetour()) {
                $nextStep = $currentStepDefinition->getDetourRootStep();
            }

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

    /**
     * Fetches the raw values sent in the request.
     *
     * @return array
     * @throws InvalidArgumentTypeException
     */
    protected function getFormRawValues()
    {
        $formName = $this->getFormObject()->getName();
        $formArray = null;

        if ($this->getRequest()->hasArgument($formName)) {
            /** @var array $formArray */
            $formArray = $this->getRequest()->getArgument($formName);
        }

        if (false === is_array($formArray)) {
            throw InvalidArgumentTypeException::formArgumentNotArray($this->getFormObject(), $formArray);
        }

        return $formArray;
    }
}


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\Step;
15
16			use Romm\Formz\Exceptions\InvalidArgumentTypeException;
17			use Romm\Formz\Middleware\Item\DefaultMiddleware;
18			use Romm\Formz\Middleware\Item\Step\Service\StepMiddlewareService;
19			use Romm\Formz\Middleware\Processor\PresetMiddlewareInterface;
20
21			/**
22			* This middleware should be the last one called, as it is used to dispatch the
23			* request to the next step, if there is one.
24			*/
25			class StepDispatchingMiddleware extends DefaultMiddleware implements PresetMiddlewareInterface
26			{
27			/**
28			* @var int
29			*/
30			protected $priority = self::PRIORITY_STEP;
31
32			/**
33			* @var StepMiddlewareService
34			*/
35			protected $service;
36
37			/**
38			* Inject the step service.
39			*/
40			public function initializeMiddleware()
41			{
42			$this->service = StepMiddlewareService::get();
43			}
44
45			/**
46			* @see StepDispatchingMiddleware
47			*/
48			protected function process()
49			{
50			$formObject = $this->getFormObject();
51
52			if (false === $formObject->getDefinition()->hasSteps()) {
53			return;
54			}
55
56			$formResult = $formObject->getFormResult();
57
58			if ($formObject->formWasSubmitted()
59			&& false === $formResult->hasErrors()
60			) {
61			if ($formObject->getCurrentSubstepDefinition()
62			&& false === $formObject->getCurrentSubstepDefinition()->isLast()
63			) {
64			return;
65			}
66
67			/*
68			* The form was submitted, and no error was found, we can safely
69			* dispatch the request to the next step.
70			*/
71			$currentStep = $this->getCurrentStep();
72			$currentStepDefinition = $this->service->getStepDefinition($currentStep);
			0 ignored issues – show Bug introduced 2017-04-19 14:49 UTC by Report Bug Copy Issue Report It seems like `$currentStep` defined by `$this->getCurrentStep()` on line `71` can be `null`; however, `Romm\Formz\Middleware\It...ce::getStepDefinition()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
73
74			// Saving submitted form data for further usage.
75			$this->service->markStepAsValidated($currentStepDefinition, $this->getFormRawValues());
			0 ignored issues – show Bug introduced 2017-05-23 14:30 UTC by Report Bug Copy Issue Report It seems like `$currentStepDefinition` defined by `$this->service->getStepDefinition($currentStep)` on line `72` can be `null`; however, `Romm\Formz\Middleware\It...::markStepAsValidated()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
76			$this->service->addValidatedFields($formResult->getValidatedFields());
77
78			$nextStep = null;
79
80			if ($currentStepDefinition->hasNextStep()) {
81			$nextStep = $this->service->getNextStepDefinition($currentStepDefinition);
			0 ignored issues – show Bug introduced 2017-05-23 14:30 UTC by Report Bug Copy Issue Report It seems like `$currentStepDefinition` defined by `$this->service->getStepDefinition($currentStep)` on line `72` can be `null`; however, `Romm\Formz\Middleware\It...getNextStepDefinition()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
82			} elseif ($currentStepDefinition->isInDetour()) {
83			$nextStep = $currentStepDefinition->getDetourRootStep();
84			}
85
86			if ($nextStep) {
87			$this->service->moveForwardToStep($nextStep, $this->redirect());
88			}
89			}
90			}
91
92			/**
93			* Fetches the raw values sent in the request.
94			*
95			* @return array
96			* @throws InvalidArgumentTypeException
97			*/
98			protected function getFormRawValues()
99			{
100			$formName = $this->getFormObject()->getName();
101			$formArray = null;
102
103			if ($this->getRequest()->hasArgument($formName)) {
104			/** @var array $formArray */
105			$formArray = $this->getRequest()->getArgument($formName);
106			}
107
108			if (false === is_array($formArray)) {
109			throw InvalidArgumentTypeException::formArgumentNotArray($this->getFormObject(), $formArray);
110			}
111
112			return $formArray;
113			}
114			}
115

romm / formz

Push — middleware-wip ( a29b16...4a8d7b )

StepDispatchingMiddleware::process() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like