Romm\Formz\Form\FormObject\Service\Step\FormStepPersistence

Complexity

Total Complexity

10

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	markStepAsValidated()	0	4	1
A	stepWasValidated()	0	4	1
A	addStepFormValues()	0	4	1
A	hasStepFormValues()	0	4	1
A	getStepFormValues()	0	4	1
A	hasData()	0	5	2
A	getObjectHash()	0	4	1
A	refreshObjectHash()	0	5	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\Step;

use Romm\Formz\Configuration\Form\Step\Step\Step;

/**
 * This object is stored in a form metadata, and contains important information
 * about the form steps:
 * - Which steps were already validated;
 * - Form data that were submitted by the user at every step.
 *
 * Data consistency of this object is assured by the form object hash (which is
 * mainly calculated from the form configuration): if the hash changes (if the
 * form configuration changes), the steps that were validated are no longer
 * considered as valid, and will need to be validated again.
 */
class FormStepPersistence
{
    /**
     * @var string
     */
    protected $objectHash;

    /**
     * @var array
     */
    protected $validatedSteps = [];

    /**
     * @var array
     */
    protected $stepsFormValues = [];

    /**
     * @param string $configurationHash
     */
    public function __construct($configurationHash)
    {
        $this->objectHash = $configurationHash;
    }

    /**
     * @param Step $step
     */
    public function markStepAsValidated(Step $step)
    {
        $this->validatedSteps[] = $step->getName();
    }

    /**
     * @param Step $step
     * @return bool
     */
    public function stepWasValidated(Step $step)
    {
        return in_array($step->getName(), $this->validatedSteps);
    }

    /**
     * @param Step  $step
     * @param array $formValues
     */
    public function addStepFormValues(Step $step, array $formValues)
    {
        $this->stepsFormValues[$step->getName()] = $formValues;
    }

    /**
     * @param Step $step
     * @return bool
     */
    public function hasStepFormValues(Step $step)
    {
        return true === array_key_exists($step->getName(), $this->stepsFormValues);
    }

    /**
     * @param Step $step
     * @return array
     */
    public function getStepFormValues(Step $step)
    {
        return $this->stepsFormValues[$step->getName()];
    }

    /**
     * @return bool
     */
    public function hasData()
    {
        return false === empty($this->validatedSteps)
            && false === empty($this->stepsFormValues);
    }

    /**
     * @return string
     */
    public function getObjectHash()
    {
        return $this->objectHash;
    }

    /**
     * @param string $hash
     */
    public function refreshObjectHash($hash)
    {
        $this->objectHash = $hash;
        $this->validatedSteps = [];
    }
}