AbstractFormFieldViewHelper.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Fluid\ViewHelpers\Form;
 
use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use ‪TYPO3\CMS\Extbase\Error\Result;
use ‪TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters;
use ‪TYPO3\CMS\Extbase\Mvc\RequestInterface;
use ‪TYPO3\CMS\Extbase\Reflection\ObjectAccess;
use ‪TYPO3\CMS\Fluid\Core\Rendering\RenderingContext;
use ‪TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper;
 
abstract class ‪AbstractFormFieldViewHelper extends ‪AbstractFormViewHelper
{
    protected ‪ConfigurationManagerInterface ‪$configurationManager;
    protected bool ‪$respectSubmittedDataValue = false;
 
    public function ‪injectConfigurationManager(‪ConfigurationManagerInterface ‪$configurationManager): void
    {
        $this->configurationManager = ‪$configurationManager;
    }
 
    public function ‪initializeArguments(): void
    {
        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="...">, the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value.'
        );
    }
 
    public function ‪getRespectSubmittedDataValue(): bool
    {
        return ‪$this->respectSubmittedDataValue;
    }
 
    public function ‪setRespectSubmittedDataValue(bool ‪$respectSubmittedDataValue): void
    {
        $this->respectSubmittedDataValue = ‪$respectSubmittedDataValue;
    }
 
    protected function ‪getName(): string
    {
        $name = $this->‪getNameWithoutPrefix();
        return $this->‪prefixFieldName($name);
    }
 
    protected function ‪getRequest(): ‪RequestInterface
    {
        $renderingContext = $this->renderingContext;
        $request = $renderingContext->getRequest();
        if (!$request instanceof ‪RequestInterface) {
            throw new \RuntimeException(
                'Form ViewHelpers are Extbase specific and need an Extbase Request to work',
                1663617170
            );
        }
        return $request;
    }
 
    protected function ‪getNameWithoutPrefix(): string
    {
        if ($this->‪isObjectAccessorMode()) {
            $formObjectName = $this->renderingContext->getViewHelperVariableContainer()->get(
                FormViewHelper::class,
                'formObjectName'
            );
            if (!empty($formObjectName)) {
                $propertySegments = explode('.', (string)($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 ($this->persistenceManager->getIdentifierByObject($this->arguments['value']) !== null) {
                $name .= '[__identity]';
            }
        }
        return (string)$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(): bool
    {
        $extbaseRequestParameters = $this->‪getRequest()->getAttribute('extbase');
        return $extbaseRequestParameters->getOriginalRequest() !== null;
    }
 
    protected function ‪getLastSubmittedFormData()
    {
        $propertyPath = rtrim(preg_replace('/(\\]\\[|\\[|\\])/', '.', $this->‪getNameWithoutPrefix()) ?? '', '.');
        $extbaseRequestParameters = $this->‪getRequest()->getAttribute('extbase');
        $value = ‪ObjectAccess::getPropertyPath(
            $extbaseRequestParameters->getOriginalRequest()->getArguments(),
            $propertyPath
        );
        return $value;
    }
 
    protected function ‪addAdditionalIdentityPropertiesIfNeeded(): void
    {
        if (!$this->‪isObjectAccessorMode()) {
            return;
        }
 
        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();
        if (!$viewHelperVariableContainer->exists(
            FormViewHelper::class,
            'formObject'
        )
        ) {
            return;
        }
        $propertySegments = explode('.', (string)($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(
            FormViewHelper::class,
            'formObject'
        );
        $objectName = $viewHelperVariableContainer->get(
            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)));
            if (!is_object($object)) {
                $object = null;
            }
            $objectName .= '[' . $propertySegments[$i - 1] . ']';
            $hiddenIdentityField = $this->‪renderHiddenIdentityField($object, $objectName);
            // Add the hidden identity field to the ViewHelperVariableContainer
            $additionalIdentityProperties = $viewHelperVariableContainer->get(
                FormViewHelper::class,
                'additionalIdentityProperties'
            );
            $additionalIdentityProperties[$objectName] = $hiddenIdentityField;
            $viewHelperVariableContainer->addOrUpdate(
                FormViewHelper::class,
                'additionalIdentityProperties',
                $additionalIdentityProperties
            );
        }
    }
 
    protected function ‪getPropertyValue()
    {
        if (!isset($this->arguments['property'])) {
            return null;
        }
        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();
        if (!$viewHelperVariableContainer->exists(
            FormViewHelper::class,
            'formObject'
        )
        ) {
            return null;
        }
        $formObject = $viewHelperVariableContainer->get(
            FormViewHelper::class,
            'formObject'
        );
        return ‪ObjectAccess::getPropertyPath($formObject, (string)$this->arguments['property']);
    }
 
    protected function ‪isObjectAccessorMode(): bool
    {
        return $this->hasArgument('property') && $this->renderingContext->getViewHelperVariableContainer()->exists(
            FormViewHelper::class,
            'formObjectName'
        );
    }
 
    protected function ‪setErrorClassAttribute(): void
    {
        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(): ‪Result
    {
        if (!$this->‪isObjectAccessorMode()) {
            return new ‪Result();
        }
        $extbaseRequestParameters = $this->‪getRequest()->getAttribute('extbase');
        $originalRequestMappingResults = $extbaseRequestParameters->getOriginalRequestMappingResults();
        $formObjectName = $this->renderingContext->getViewHelperVariableContainer()->get(
            FormViewHelper::class,
            'formObjectName'
        );
        return $originalRequestMappingResults->forProperty($formObjectName)->forProperty((string)$this->arguments['property']);
    }
 
    protected function ‪renderHiddenFieldForEmptyValue(): string
    {
        $hiddenFieldNames = [];
        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();
        if ($viewHelperVariableContainer->exists(
            FormViewHelper::class,
            'renderedHiddenFields'
        )
        ) {
            $hiddenFieldNames = $viewHelperVariableContainer->get(
                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(
                FormViewHelper::class,
                'renderedHiddenFields',
                $hiddenFieldNames
            );
            return '<input type="hidden" name="' . htmlspecialchars($fieldName) . '" value="" />';
        }
        return '';
    }
}