AbstractFormFieldViewHelper.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\ViewHelpers\Form;

/*                                                                        *
 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid".   *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 *  of the License, or (at your option) any later version.                *
 *                                                                        *
 *                                                                        *
 * This script is distributed in the hope that it will be useful, but     *
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser       *
 * General Public License for more details.                               *
 *                                                                        *
 * You should have received a copy of the GNU Lesser General Public       *
 * License along with the script.                                         *
 * If not, see http://www.gnu.org/licenses/lgpl.html                      *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */
abstract class AbstractFormFieldViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper {

    protected $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.');
    }

    protected function getName() {
        $name = $this->getNameWithoutPrefix();
        return $this->prefixFieldName($name);
    }

    protected function getNameWithoutPrefix() {
        if ($this->isObjectAccessorMode()) {
            $formObjectName = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', '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 getValue($convertObjects = TRUE) {
        $value = NULL;
        if ($this->hasArgument('value')) {
            $value = $this->arguments['value'];
        } elseif ($this->configurationManager->isFeatureEnabled('rewrittenPropertyMapper') && $this->hasMappingErrorOccurred()) {
            $this->addAdditionalIdentityPropertiesIfNeeded();
            $value = $this->getLastSubmittedFormData();
        } elseif ($this->isObjectAccessorMode() && $this->viewHelperVariableContainer->exists('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'formObject')) {
            $this->addAdditionalIdentityPropertiesIfNeeded();
            $value = $this->getPropertyValue();
        }
        if ($convertObjects) {
            $value = $this->convertToPlainValue($value);
        }
        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->controllerContext->getRequest()->getOriginalRequest() !== NULL;
    }

    protected function getLastSubmittedFormData() {
        $propertyPath = rtrim(preg_replace('/(\\]\\[|\\[|\\])/', '.', $this->getNameWithoutPrefix()), '.');
        $value = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($this->controllerContext->getRequest()->getOriginalRequest()->getArguments(), $propertyPath);
        return $value;
    }

    protected function addAdditionalIdentityPropertiesIfNeeded() {
        $propertySegments = explode('.', $this->arguments['property']);
        if (count($propertySegments) >= 2) {
            // hierarchical property. If there is no "." inside (thus $propertySegments == 1), we do not need to do anything
            $formObject = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'formObject');
            $objectName = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'formObjectName');
            // If Count == 2 -> we need to go through the for-loop exactly once
            for ($i = 1; $i < count($propertySegments); $i++) {
                $object = \TYPO3\CMS\Extbase\Reflection\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 = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'additionalIdentityProperties');
                $additionalIdentityProperties[$objectName] = $hiddenIdentityField;
                $this->viewHelperVariableContainer->addOrUpdate('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'additionalIdentityProperties', $additionalIdentityProperties);
            }
        }
    }

    protected function getPropertyValue() {
        if (!$this->viewHelperVariableContainer->exists('TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper', 'formObject')) {
            return NULL;
        }
        $formObject = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'formObject');
        $propertyName = $this->arguments['property'];
        if (is_array($formObject)) {
            return isset($formObject[$propertyName]) ? $formObject[$propertyName] : NULL;
        }
        return \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($formObject, $propertyName);
    }

    protected function isObjectAccessorMode() {
        return $this->hasArgument('property') && $this->viewHelperVariableContainer->exists('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'formObjectName');
    }

    protected function setErrorClassAttribute() {
        if ($this->hasArgument('class')) {
            $cssClass = $this->arguments['class'] . ' ';
        } else {
            $cssClass = '';
        }
        if ($this->configurationManager->isFeatureEnabled('rewrittenPropertyMapper')) {
            $mappingResultsForProperty = $this->getMappingResultsForProperty();
            if ($mappingResultsForProperty->hasErrors()) {
                if ($this->hasArgument('errorClass')) {
                    $cssClass .= $this->arguments['errorClass'];
                } else {
                    $cssClass .= 'error';
                }
                $this->tag->addAttribute('class', $cssClass);
            }
        } else {
            // @deprecated since Fluid 1.4.0, will will be removed two versions after Fluid 6.1.
            $errors = $this->getErrorsForProperty();
            if (count($errors) > 0) {
                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->controllerContext->getRequest()->getOriginalRequestMappingResults();
        $formObjectName = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'formObjectName');
        return $originalRequestMappingResults->forProperty($formObjectName)->forProperty($this->arguments['property']);
    }

    protected function getErrorsForProperty() {
        if (!$this->isObjectAccessorMode()) {
            return array();
        }
        $errors = $this->controllerContext->getRequest()->getErrors();
        $formObjectName = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'formObjectName');
        $propertyName = $this->arguments['property'];
        foreach ($errors as $error) {
            if ($error instanceof \TYPO3\CMS\Extbase\Validation\PropertyError && $error->getPropertyName() === $formObjectName) {
                $formErrors = $error->getErrors();
                foreach ($formErrors as $formError) {
                    if ($formError instanceof \TYPO3\CMS\Extbase\Validation\PropertyError && $formError->getPropertyName() === $propertyName) {
                        return $formError->getErrors();
                    }
                }
            }
        }
        return array();
    }

    protected function renderHiddenFieldForEmptyValue() {
        $hiddenFieldNames = array();
        if ($this->viewHelperVariableContainer->exists('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'renderedHiddenFields')) {
            $hiddenFieldNames = $this->viewHelperVariableContainer->get('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'renderedHiddenFields');
        }
        $fieldName = $this->getName();
        if (substr($fieldName, -2) === '[]') {
            $fieldName = substr($fieldName, 0, -2);
        }
        if (!in_array($fieldName, $hiddenFieldNames)) {
            $hiddenFieldNames[] = $fieldName;
            $this->viewHelperVariableContainer->addOrUpdate('TYPO3\\CMS\\Fluid\\ViewHelpers\\FormViewHelper', 'renderedHiddenFields', $hiddenFieldNames);
            return '<input type="hidden" name="' . htmlspecialchars($fieldName) . '" value="" />';
        }
        return '';
    }
}