Romm\Formz\Form\FormObject\Service\FormObjectSteps

Complexity

Total Complexity

31

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
D	fetchCurrentStep()	0	41	9
A	getCurrentStep()	0	8	3
B	getStepPersistence()	0	25	6
B	getCurrentSubstepDefinition()	0	14	5
A	setCurrentSubstepDefinition()	0	5	1
A	getSubstepsPath()	0	4	2
A	setSubstepsPath()	0	4	1
A	addSubstepToPath()	0	4	1
A	markLastSubstepAsValidated()	0	4	1
A	lastSubstepWasValidated()	0	4	1

<?php
/*
 * 2017 Romain CANON <romain.hydrocanon@gmail.com>
 *
 * 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\Form\FormObject\Service;

use Romm\Formz\Form\Definition\Step\Step\Step;
use Romm\Formz\Form\Definition\Step\Step\Substep\Substep;
use Romm\Formz\Form\Definition\Step\Step\Substep\SubstepDefinition;
use Romm\Formz\Form\FormObject\FormObject;
use Romm\Formz\Form\FormObject\Service\Step\FormStepPersistence;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\Web\Request;

class FormObjectSteps
{
    const METADATA_STEP_PERSISTENCE_KEY = 'core.formStepPersistence';

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

    /**
     * Step persistence is saved in the form metadata.
     *
     * It allows having essential information about the form steps whenever it
     * is needed: submitted form values, as well as steps that were already
     * validated.
     *
     * @var FormStepPersistence
     */
    protected $stepPersistence;

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

    /**
     * @var SubstepDefinition
     */
    protected $currentSubstepDefinition;

    /**
     * @var Substep[]
     */
    protected $substepsPath;

    /**
     * @var bool
     */
    protected $lastSubstepValidated = false;

    /**
     * @param FormObject $formObject
     */
    public function __construct(FormObject $formObject)
    {
        $this->formObject = $formObject;
    }

    /**
     * This function will search among the registered steps to find the one that
     * has the same controller parameters.
     *
     * It is also possible not to find any step, in this case `null` is
     * returned.
     *
     * @todo: memoization with request spl object storage
     *
     * @param Request $request
     */
    public function fetchCurrentStep(Request $request)
    {
        if (null !== $this->currentStep) {
            return;
        }

        $this->currentStep = false;

It seems like false of type false is incompatible with the declared type object<Romm\Formz\Form\Definition\Step\Step\Step> of property $currentStep.

        $configuration = $this->formObject->getDefinition();

        if ($configuration->hasSteps()) {
            foreach ($configuration->getSteps()->getEntries() as $step) {
                $data = [
                    // @todo: no page uid to fetch?
//                $step->getPageUid()    => Core::get()->getPageController()->id,
                    $step->getExtension()  => $request->getControllerExtensionName(),
                    $step->getController() => $request->getControllerName()
                ];

                foreach ($data as $stepData => $requestData) {
                    if (false === empty($stepData)
                        && $stepData !== $requestData
                    ) {
                        continue 2;
                    }
                }

                $actionList = GeneralUtility::trimExplode(',', $step->getAction());

                if (false === in_array($request->getControllerActionName(), $actionList)) {
                    continue;
                }

                if ($this->currentStep instanceof Step) {
                    throw new \Exception('todo'); // @todo
                }

                $this->currentStep = $step;
            }
        }
    }

    /**
     * @return Step|null
     */
    public function getCurrentStep()
    {
        if (null === $this->currentStep) {
            throw new \Exception('todo'); // @todo
        }

        return $this->currentStep ?: null;
    }

    /**
     * Fetches the step persistence object for the form, which may have been
     * stored in the form metadata.
     *
     * If the form object hash did change since the persistence object was saved
     * it is "refreshed" with the new hash (some data are also deleted as they
     * are no longer considered as valid).
     *
     * @return FormStepPersistence
     */
    public function getStepPersistence()
    {
        // @todo check configuration has steps or fatal error
        if (null === $this->stepPersistence) {
            $objectHash = $this->formObject->getObjectHash();
            $metadata = $this->formObject->getFormMetadata();

            if ($metadata->has(self::METADATA_STEP_PERSISTENCE_KEY)) {
                $this->stepPersistence = $metadata->get(self::METADATA_STEP_PERSISTENCE_KEY);

                if (false === $this->stepPersistence instanceof FormStepPersistence) {
                    unset($this->stepPersistence);
                } elseif ($objectHash !== $this->stepPersistence->getObjectHash()) {
                    $this->stepPersistence->refreshObjectHash($objectHash);
                }
            }

            if (null === $this->stepPersistence) {
                $this->stepPersistence = GeneralUtility::makeInstance(FormStepPersistence::class, $objectHash);
                $metadata->set(self::METADATA_STEP_PERSISTENCE_KEY, $this->stepPersistence);
            }
        }

        return $this->stepPersistence;
    }

    /**
     * @return SubstepDefinition|null
     */
    public function getCurrentSubstepDefinition()
    {
        // @todo check current step has been set?

        if (null === $this->currentSubstepDefinition) {
            $currentStep = $this->getCurrentStep();

            $this->currentSubstepDefinition = ($currentStep && $currentStep->hasSubsteps())

It seems like $currentStep && $currentStep->hasSubsteps() ? $currentStep->getSubsteps()->getFirstSubstepDefinition() : false can also be of type false. However, the property $currentSubstepDefinition is declared as type object<Romm\Formz\Form\Definition\Step\Step\Substep\SubstepDefinition>. Maybe add an additional type check?

                ? $currentStep->getSubsteps()->getFirstSubstepDefinition()
                : false;
        }

        return $this->currentSubstepDefinition ?: null;
    }

    /**
     * @param SubstepDefinition $currentSubstepDefinition
     */
    public function setCurrentSubstepDefinition(SubstepDefinition $currentSubstepDefinition)
    {
        // @todo check current step has been set?
        $this->currentSubstepDefinition = $currentSubstepDefinition;
    }

    /**
     * @return Substep[]
     */
    public function getSubstepsPath()
    {
        return $this->substepsPath ?: [$this->getCurrentStep()->getSubsteps()->getFirstSubstepDefinition()->getSubstep()];
    }

    /**
     * @param Substep[] $substepsPath
     */
    public function setSubstepsPath(array $substepsPath)
    {
        $this->substepsPath = $substepsPath;
    }

    /**
     * @param Substep $substep
     */
    public function addSubstepToPath(Substep $substep)
    {
        $this->substepsPath[] = $substep;
    }

    /**
     * @todo
     */
    public function markLastSubstepAsValidated()
    {
        $this->lastSubstepValidated = true;
    }

    /**
     * @return bool
     */
    public function lastSubstepWasValidated()
    {
        return $this->lastSubstepValidated;
    }
}