Romm\Formz\Service\ViewHelper\FieldViewHelperService

Complexity

Total Complexity

10

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	resetState()	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	checkIsInsideFieldViewHelper()	0	9	2

<?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\Service\ViewHelper;

use Romm\Formz\Configuration\Form\Field\Field;
use Romm\Formz\Exceptions\ContextNotFoundException;
use Romm\Formz\ViewHelpers\FieldViewHelper;
use TYPO3\CMS\Core\SingletonInterface;

/**
 * Contains methods to help view helpers to manipulate data concerning the
 * current field.
 */
class FieldViewHelperService implements SingletonInterface
{
    /**
     * @var Field
     */
    protected $currentField;

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

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

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