9.5/_abstract_form_field_view_helper_8php_source.html

<?php

namespace ‪TYPO3\CMS\Fluid\ViewHelpers\Form;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Extbase\Reflection\ObjectAccess;


abstract class ‪AbstractFormFieldViewHelper extends ‪AbstractFormViewHelper

{

    protected ‪$configurationManager;


    protected ‪$respectSubmittedDataValue = false;


    public function ‪injectConfigurationManager(\‪TYPO3\CMS\‪Extbase\Configuration\‪ConfigurationManagerInterface ‪$configurationManager)

    {

        $this->configurationManager = ‪$configurationManager;

    }


    public function ‪initializeArguments()

    {

        parent::initializeArguments();

        $this->registerArgument('name', 'string', 'Name of input tag');

        $this->registerArgument('value', 'mixed', 'Value of input tag');

        $this->registerArgument(

            'property',

            'string',

            'Name of Object Property. If used in conjunction with <f:form object="...">, "name" and "value" properties will be ignored.'

        );

    }


    public function ‪getRespectSubmittedDataValue()

    {

        return ‪$this->respectSubmittedDataValue;

    }


    public function ‪setRespectSubmittedDataValue(‪$respectSubmittedDataValue)

    {

        $this->respectSubmittedDataValue = ‪$respectSubmittedDataValue;

    }


    protected function ‪getName()

    {

        $name = $this->‪getNameWithoutPrefix();

        return $this->‪prefixFieldName($name);

    }


    protected function ‪getRequest()

    {

        return $this->renderingContext->getControllerContext()->getRequest();

    }


    protected function ‪getNameWithoutPrefix()

    {

        if ($this->‪isObjectAccessorMode()) {

            $formObjectName = $this->renderingContext->getViewHelperVariableContainer()->get(

                \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

                'formObjectName'

            );

            if (!empty($formObjectName)) {

                $propertySegments = explode('.', $this->arguments['property'] ?? '');

                $propertyPath = '';

                foreach ($propertySegments as $segment) {

                    $propertyPath .= '[' . $segment . ']';

                }

                $name = $formObjectName . $propertyPath;

            } else {

                $name = $this->arguments['property'] ?? '';

            }

        } else {

            $name = $this->arguments['name'] ?? '';

        }

        if ($this->hasArgument('value') && is_object($this->arguments['value'])) {

            // @todo Use  $this->persistenceManager->isNewObject() once it is implemented

            if (null !== $this->persistenceManager->getIdentifierByObject($this->arguments['value'])) {

                $name .= '[__identity]';

            }

        }

        return $name;

    }


    protected function ‪getValueAttribute()

    {

        $value = null;


        if ($this->respectSubmittedDataValue) {

            $value = $this->‪getValueFromSubmittedFormData($value);

        } elseif ($this->hasArgument('value')) {

            $value = $this->arguments['value'];

        } elseif ($this->‪isObjectAccessorMode()) {

            $value = $this->‪getPropertyValue();

        }


        $value = $this->‪convertToPlainValue($value);

        return $value;

    }


    protected function ‪getValueFromSubmittedFormData($value)

    {

        $submittedFormData = null;

        if ($this->‪hasMappingErrorOccurred()) {

            $submittedFormData = $this->‪getLastSubmittedFormData();

        }

        if ($submittedFormData !== null) {

            $value = $submittedFormData;

        } elseif ($this->hasArgument('value')) {

            $value = $this->arguments['value'];

        } elseif ($this->‪isObjectAccessorMode()) {

            $value = $this->‪getPropertyValue();

        }


        return $value;

    }


    protected function ‪convertToPlainValue($value)

    {

        if (is_object($value)) {

            $identifier = $this->persistenceManager->getIdentifierByObject($value);

            if ($identifier !== null) {

                $value = $identifier;

            }

        }

        return $value;

    }


    protected function ‪hasMappingErrorOccurred()

    {

        return $this->renderingContext->getControllerContext()->getRequest()->getOriginalRequest() !== null;

    }


    protected function ‪getLastSubmittedFormData()

    {

        $propertyPath = rtrim(preg_replace('/(\\]\\[|\\[|\\])/', '.', $this->‪getNameWithoutPrefix()), '.');

        $value = ‪ObjectAccess::getPropertyPath(

            $this->renderingContext->getControllerContext()->getRequest()->getOriginalRequest()->getArguments(),

            $propertyPath

        );

        return $value;

    }


    protected function ‪addAdditionalIdentityPropertiesIfNeeded()

    {

        if (!$this->‪isObjectAccessorMode()) {

            return;

        }


        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();

        if (!$viewHelperVariableContainer->exists(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'formObject'

        )

        ) {

            return;

        }

        $propertySegments = explode('.', $this->arguments['property']);

        // hierarchical property. If there is no "." inside (thus $propertySegments == 1), we do not need to do anything

        if (count($propertySegments) < 2) {

            return;

        }

        $formObject = $viewHelperVariableContainer->get(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'formObject'

        );

        $objectName = $viewHelperVariableContainer->get(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'formObjectName'

        );

        // If count == 2 -> we need to go through the for-loop exactly once

        $propertySegmentsCount = count($propertySegments);

        for ($i = 1; $i < $propertySegmentsCount; $i++) {

            $object = ‪ObjectAccess::getPropertyPath($formObject, implode('.', array_slice($propertySegments, 0, $i)));

            $objectName .= '[' . $propertySegments[$i - 1] . ']';

            $hiddenIdentityField = $this->‪renderHiddenIdentityField($object, $objectName);

            // Add the hidden identity field to the ViewHelperVariableContainer

            $additionalIdentityProperties = $viewHelperVariableContainer->get(

                \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

                'additionalIdentityProperties'

            );

            $additionalIdentityProperties[$objectName] = $hiddenIdentityField;

            $viewHelperVariableContainer->addOrUpdate(

                \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

                'additionalIdentityProperties',

                $additionalIdentityProperties

            );

        }

    }


    protected function ‪getPropertyValue()

    {

        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();

        if (!$viewHelperVariableContainer->exists(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'formObject'

        )

        ) {

            return null;

        }

        $formObject = $viewHelperVariableContainer->get(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'formObject'

        );

        return ‪ObjectAccess::getPropertyPath($formObject, $this->arguments['property']);

    }


    protected function ‪isObjectAccessorMode()

    {

        return $this->hasArgument('property') && $this->renderingContext->getViewHelperVariableContainer()->exists(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'formObjectName'

        );

    }


    protected function ‪setErrorClassAttribute()

    {

        if ($this->hasArgument('class')) {

            $cssClass = $this->arguments['class'] . ' ';

        } else {

            $cssClass = '';

        }


        $mappingResultsForProperty = $this->‪getMappingResultsForProperty();

        if ($mappingResultsForProperty->hasErrors()) {

            if ($this->hasArgument('errorClass')) {

                $cssClass .= $this->arguments['errorClass'];

            } else {

                $cssClass .= 'error';

            }

            $this->tag->addAttribute('class', $cssClass);

        }

    }


    protected function ‪getMappingResultsForProperty()

    {

        if (!$this->‪isObjectAccessorMode()) {

            return new \TYPO3\CMS\Extbase\Error\Result();

        }

        $originalRequestMappingResults = $this->‪getRequest()->getOriginalRequestMappingResults();

        $formObjectName = $this->renderingContext->getViewHelperVariableContainer()->get(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'formObjectName'

        );

        return $originalRequestMappingResults->forProperty($formObjectName)->forProperty($this->arguments['property']);

    }


    protected function ‪renderHiddenFieldForEmptyValue()

    {

        $hiddenFieldNames = [];

        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();

        if ($viewHelperVariableContainer->exists(

            \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

            'renderedHiddenFields'

        )

        ) {

            $hiddenFieldNames = $viewHelperVariableContainer->get(

                \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

                'renderedHiddenFields'

            );

        }

        $fieldName = $this->‪getName();

        if (substr($fieldName, -2) === '[]') {

            $fieldName = substr($fieldName, 0, -2);

        }

        if (!in_array($fieldName, $hiddenFieldNames, true)) {

            $hiddenFieldNames[] = $fieldName;

            $viewHelperVariableContainer->addOrUpdate(

                \‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::class,

                'renderedHiddenFields',

                $hiddenFieldNames

            );

            return '<input type="hidden" name="' . htmlspecialchars($fieldName) . '" value="" />';

        }

        return '';

    }

}