Romm\Formz\Service\ViewHelper\Field\FieldViewHelperService

Complexity

Total Complexity

9

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setCurrentField()	0	4	1
A	fieldContextExists()	0	4	1
A	getCurrentField()	0	4	1
A	setFieldOption()	0	4	1
A	getFieldOptions()	0	4	1
A	getView()	0	14	2
A	resetState()	0	4	1
A	getCurrentContext()	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\Service\ViewHelper\Field;

use Romm\Formz\Configuration\Form\Field\Field;
use Romm\Formz\Configuration\View\Layouts\Layout;
use Romm\Formz\Core\Core;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Fluid\View\StandaloneView;

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

    /**
     * @var StandaloneView[]
     */
    protected $view;

    /**
     * @todo rename ?
     *
     * @param Field $field
     */
    public function setCurrentField(Field $field)
    {
        $this->contextEntries[] = GeneralUtility::makeInstance(FieldContextEntry::class, $field);
    }

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

    /**
     * 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->getCurrentContext()->getField();
    }

    /**
     * @param string $name
     * @param mixed  $value
     */
    public function setFieldOption($name, $value)
    {
        $this->getCurrentContext()->setOption($name, $value);
    }

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

    /**
     * Returns a view instance, based on the template file of the layout. The
     * view is stored in local cache, to improve performance: the template file
     * content will be fetched only once.
     *
     * @param Layout $layout
     * @return StandaloneView
     */
    public function getView(Layout $layout)
    {
        $identifier = $layout->getTemplateFile();

        if (null === $this->view[$identifier]) {
            /** @var StandaloneView $view */
            $view = Core::instantiate(StandaloneView::class);
            $view->setTemplatePathAndFilename($layout->getTemplateFile());

            $this->view[$identifier] = $view;
        }

        return $this->view[$identifier];
    }

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

    /**
     * @return FieldContextEntry
     */
    protected function getCurrentContext()
    {
        return end($this->contextEntries);

The expression end($this->contextEntries); of type Romm\Formz\Service\ViewHelper\Field\FieldContextEntry|false adds false to the return on line 125 which is incompatible with the return type documented by Romm\Formz\Service\ViewHelper\Field\FieldViewHelperService::getCurrentContext of type Romm\Formz\Service\ViewHelper\Field\FieldContextEntry. It seems like you forgot to handle an error condition.

    }
}