SubstepFetchingMiddleware::after() - Code Metrics - Inspection of "[TASK] Handle initial substeps" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — wip/steps ( b7e8e2...f18ed0 )

by Romain

created 2019-03-25 13:25 UTC

SubstepFetchingMiddleware::after() A

↳ Parent: SubstepFetchingMiddleware

Complexity

Conditions	5
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	9.2248
c	0
b	0
f	0
cc	5
nc	4
nop	1

<?php
declare(strict_types=1);

namespace Romm\Formz\Middleware\Item\Step;

use Romm\Formz\Form\Definition\Step\Step\Step;
use Romm\Formz\Form\FormObject\FormObjectFactory;
use Romm\Formz\Form\FormObject\Service\FormObjectSteps;
use Romm\Formz\Middleware\Argument\Arguments;
use Romm\Formz\Middleware\Item\AbstractMiddleware;
use Romm\Formz\Middleware\Item\FormInjection\FormInjectionSignal;
use Romm\Formz\Middleware\Item\Step\Service\StepMiddlewareService;
use Romm\Formz\Middleware\Processor\PresetMiddlewareInterface;
use Romm\Formz\Middleware\Signal\After;

class SubstepFetchingMiddleware extends AbstractMiddleware implements After, FormInjectionSignal, PresetMiddlewareInterface
{
    /**
     * @var int
     */
    protected $priority = self::PRIORITY_STEP_FETCHING + 150;

    /**
     * @var Step
     */
    protected $currentStep;

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

    /**
     * @var FormObjectSteps
     */
    protected $stepService;

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

    /**
     * @param Arguments $arguments
     */
    public function after(Arguments $arguments)
    {
        if ($this->getFormObject()->formWasSubmitted()) {
            return;
        }

        $formObject = $this->getFormObject();

        if (false === $formObject->getDefinition()->hasSteps()) {
            return;
        }

        $this->currentStep = $this->getCurrentStep();

        if (null === $this->currentStep
            || false === $this->currentStep->hasSubsteps()
        ) {
            return;
        }

        $this->stepService = FormObjectFactory::get()->getStepService($formObject);

        $this->fetchCurrentSubstep();
    }

    /**
     * Fetches the current substep that should be displayed (the first
     * substep(s) may have an activation condition).
     */
    private function fetchCurrentSubstep()
    {
        $this->service->reset($this->getFormObject(), $this->getRequest());

        $substepDefinition = $this->service->findFirstSubstepDefinition($this->currentStep);

        $this->stepService->setCurrentSubstepDefinition($substepDefinition);
/** @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);
    }
}
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Romm\Formz\Middleware\Item\Step;
5
6			use Romm\Formz\Form\Definition\Step\Step\Step;
7			use Romm\Formz\Form\FormObject\FormObjectFactory;
8			use Romm\Formz\Form\FormObject\Service\FormObjectSteps;
9			use Romm\Formz\Middleware\Argument\Arguments;
10			use Romm\Formz\Middleware\Item\AbstractMiddleware;
11			use Romm\Formz\Middleware\Item\FormInjection\FormInjectionSignal;
12			use Romm\Formz\Middleware\Item\Step\Service\StepMiddlewareService;
13			use Romm\Formz\Middleware\Processor\PresetMiddlewareInterface;
14			use Romm\Formz\Middleware\Signal\After;
15
16			class SubstepFetchingMiddleware extends AbstractMiddleware implements After, FormInjectionSignal, PresetMiddlewareInterface
17			{
18			/**
19			* @var int
20			*/
21			protected $priority = self::PRIORITY_STEP_FETCHING + 150;
22
23			/**
24			* @var Step
25			*/
26			protected $currentStep;
27
28			/**
29			* @var StepMiddlewareService
30			*/
31			protected $service;
32
33			/**
34			* @var FormObjectSteps
35			*/
36			protected $stepService;
37
38			/**
39			* Inject the step service.
40			*/
41			public function initializeMiddleware()
42			{
43			$this->service = StepMiddlewareService::get();
44			}
45
46			/**
47			* @param Arguments $arguments
48			*/
49			public function after(Arguments $arguments)
50			{
51			if ($this->getFormObject()->formWasSubmitted()) {
52			return;
53			}
54
55			$formObject = $this->getFormObject();
56
57			if (false === $formObject->getDefinition()->hasSteps()) {
58			return;
59			}
60
61			$this->currentStep = $this->getCurrentStep();
62
63			if (null === $this->currentStep
64			\|\| false === $this->currentStep->hasSubsteps()
65			) {
66			return;
67			}
68
69			$this->stepService = FormObjectFactory::get()->getStepService($formObject);
70
71			$this->fetchCurrentSubstep();
72			}
73
74			/**
75			* Fetches the current substep that should be displayed (the first
76			* substep(s) may have an activation condition).
77			*/
78			private function fetchCurrentSubstep()
79			{
80			$this->service->reset($this->getFormObject(), $this->getRequest());
81
82			$substepDefinition = $this->service->findFirstSubstepDefinition($this->currentStep);
83
84			$this->stepService->setCurrentSubstepDefinition($substepDefinition);
			0 ignored issues – show Bug introduced 2019-03-25 13:31 UTC by Report Bug Copy Issue Report It seems like `$substepDefinition` defined by `$this->service->findFirs...ion($this->currentStep)` on line `82` can be `null`; however, `Romm\Formz\Form\FormObje...rentSubstepDefinition()` 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...
85			}
86			}
87

romm / formz

Push — wip/steps ( b7e8e2...f18ed0 )

SubstepFetchingMiddleware::after() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like