Romm\Formz\ViewHelpers\Service\FormzViewHelperService

Complexity

Total Complexity

23

Size/Duplication

Total Lines	249
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	resetState()	0	8	1
A	activateFormContext()	0	11	2
A	formContextExists()	0	4	1
A	markFormAsSubmitted()	0	4	1
A	formWasSubmitted()	0	4	1
A	fieldContextExists()	0	4	1
A	getCurrentField()	0	4	1
A	setCurrentField()	0	4	1
A	setFieldOption()	0	4	1
A	getFieldOptions()	0	4	1
A	resetFieldOptions()	0	6	1
A	removeCurrentField()	0	6	1
A	checkIsInsideFormViewHelper()	0	9	2
A	checkIsInsideFieldViewHelper()	0	9	2
A	setFormInstance()	0	4	1
A	getFormInstance()	0	4	1
A	getFormResult()	0	4	1
A	setFormResult()	0	4	1
A	getFormObject()	0	4	1
A	setFormObject()	0	4	1

<?php
/*
 * 2016 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\ViewHelpers\Service;

use Romm\Formz\Configuration\Form\Field\Field;
use Romm\Formz\Error\FormResult;
use Romm\Formz\Form\FormInterface;
use Romm\Formz\Form\FormObject;
use Romm\Formz\ViewHelpers\FieldViewHelper;
use Romm\Formz\ViewHelpers\FormViewHelper;
use TYPO3\CMS\Core\SingletonInterface;

/**
 * This class contains methods that help view helpers to manipulate data and
 * know more things concerning the current form state.
 *
 * It is mainly configured inside the `FormViewHelper`, and used in other
 * view helpers.
 */
class FormzViewHelperService implements SingletonInterface
{
    /**
     * @var bool
     */
    protected $formContext;

    /**
     * @var array|FormInterface
     */
    protected $formInstance;

    /**
     * @var Field
     */
    protected $currentField;

    /**
     * @var bool
     */
    protected $formWasSubmitted;

    /**
     * @var FormResult
     */
    protected $formResult;

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

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

    /**
     * Reset every state that can be used by this service.
     */
    public function resetState()
    {
        $this->formContext = false;
        $this->formInstance = null;
        $this->formResult = null;
        $this->formWasSubmitted = false;
        $this->currentField = null;
    }

    /**
     * Will activate the form context, changing the result returned by the
     * function `formContextExists`.
     *
     * @throws \Exception
     */
    public function activateFormContext()
    {
        if (true === $this->formContext) {
            throw new \Exception(
                'You can not use a form view helper inside another one.',
                1465242575
            );
        }

        $this->formContext = true;
    }

    /**
     * Returns `true` if the `FormViewHelper` context exists.
     *
     * @return bool
     */
    public function formContextExists()
    {
        return $this->formContext;
    }

    /**
     * Will mark the form as submitted (change the result returned by the
     * function `formWasSubmitted()`).
     */
    public function markFormAsSubmitted()
    {
        $this->formWasSubmitted = true;
    }

    /**
     * Returns `true` if the form was submitted by the user.
     *
     * @return bool
     */
    public function formWasSubmitted()
    {
        return $this->formWasSubmitted;
    }

    /**
     * Checks that the `FieldViewHelper` has been called. If not, an exception
     * is thrown.
     *
     * @return bool
     */
    public function fieldContextExists()
    {
        return $this->currentField instanceof Field;
    }

    /**
     * Returns the current field which was defined by the `FieldViewHelper`.
     *
     * Returns null if no current field was found.
     *
     * @return Field|null
     */
    public function getCurrentField()
    {
        return $this->currentField;
    }

    /**
     * @param Field $field
     */
    public function setCurrentField(Field $field)
    {
        $this->currentField = $field;
    }

    /**
     * @param string $name
     * @param mixed  $value
     */
    public function setFieldOption($name, $value)
    {
        $this->fieldOptions[$name] = $value;
    }

    /**
     * @return array
     */
    public function getFieldOptions()
    {
        return $this->fieldOptions;
    }

    /**
     * @return $this
     */
    public function resetFieldOptions()
    {
        $this->fieldOptions = [];

        return $this;
    }

    /**
     * Unset the current field.
     *
     * @return $this
     */
    public function removeCurrentField()
    {
        $this->currentField = null;

        return $this;
    }

    /**
     * Checks that the current `FormViewHelper` exists. If not, an exception is
     * thrown.
     *
     * @throws \Exception
     */
    public function checkIsInsideFormViewHelper()
    {
        if (false === $this->formContextExists()) {
            throw new \Exception(
                'The view helper "' . get_called_class() . '" must be used inside the view helper "' . FormViewHelper::class . '".',
                1465243085
            );
        }
    }

    /**
     * Checks that the `FieldViewHelper` has been called. If not, an exception
     * is thrown.
     *
     * @throws \Exception
     */
    public function checkIsInsideFieldViewHelper()
    {
        if (false === $this->fieldContextExists()) {
            throw new \Exception(
                'The view helper "' . get_called_class() . '" must be used inside the view helper "' . FieldViewHelper::class . '".',
                1465243085
            );
        }
    }

    /**
     * If the form was submitted by the user, contains the array containing the
     * submitted values.
     *
     * @param array|FormInterface $formInstance
     */
    public function setFormInstance($formInstance)
    {
        $this->formInstance = $formInstance;
    }

    /**
     * @return array|FormInterface
     */
    public function getFormInstance()
    {
        return $this->formInstance;
    }

    /**
     * @return FormResult
     */
    public function getFormResult()
    {
        return $this->formResult;
    }

    /**
     * @param FormResult $formResult
     */
    public function setFormResult(FormResult $formResult)
    {
        $this->formResult = $formResult;
    }

    /**
     * @return FormObject
     */
    public function getFormObject()
    {
        return $this->formObject;
    }

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