AbstractFormFieldViewHelper.php

Go to the documentation of this file.

<?php

/*                                                                        *
 * This script belongs to the FLOW3 package "Fluid".                      *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License as published by the *
 * Free Software Foundation, 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 Form View Helper. Bundles functionality related to direct property access of objects in other Form ViewHelpers.
 *
 * If you set the "property" attribute to the name of the property to resolve from the object, this class will
 * automatically set the name and value of a form element.
 *
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
 * @api
 */
abstract class Tx_Fluid_ViewHelpers_Form_AbstractFormFieldViewHelper extends Tx_Fluid_ViewHelpers_Form_AbstractFormViewHelper {

    /**
     * Initialize arguments.
     *
     * @return void
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @api
     */
    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.');
    }

    /**
     * Get the name of this form element.
     * Either returns arguments['name'], or the correct name for Object Access.
     *
     * In case property is something like bla.blubb (hierarchical), then [bla][blubb] is generated.
     *
     * @return string Name
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Robert Lemke <robert@typo3.org>
     * @author Karsten Dambekalns <karsten@typo3.org>
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function getName() {
        if ($this->isObjectAccessorMode()) {
            $formObjectName = $this->viewHelperVariableContainer->get('Tx_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->arguments->hasArgument('value') && is_object($this->arguments['value'])) {
            if (NULL !== $this->persistenceManager->getBackend()->getIdentifierByObject($this->arguments['value'])
                && (!$this->persistenceManager->getBackend()->isNewObject($this->arguments['value']))) {
                $name .= '[__identity]';
            }
        }
        return $this->prefixFieldName($name);
    }

    /**
     * Get the value of this form element.
     * Either returns arguments['value'], or the correct value for Object Access.
     *
     * @return mixed Value
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Robert Lemke <robert@typo3.org>
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function getValue() {
        $value = NULL;
        if ($this->arguments->hasArgument('value')) {
            $value = $this->arguments['value'];
        } elseif ($this->isObjectAccessorMode() && $this->viewHelperVariableContainer->exists('Tx_Fluid_ViewHelpers_FormViewHelper', 'formObject')) {
            $this->addAdditionalIdentityPropertiesIfNeeded();
            $value = $this->getPropertyValue();
        }
        if (is_object($value)) {
            $identifier = $this->persistenceManager->getBackend()->getIdentifierByObject($value);
            if ($identifier !== NULL) {
                $value = $identifier;
            }
        }
        return $value;
    }

    /**
     * Add additional identity properties in case the current property is hierarchical (of the form "bla.blubb").
     * Then, [bla][__identity] has to be generated as well.
     *
     * @author Sebastian Kurfuerst <sebastian@typo3.org>
     * @return void
     */
    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('Tx_Fluid_ViewHelpers_FormViewHelper', 'formObject');

            $objectName = $this->viewHelperVariableContainer->get('Tx_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 = Tx_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('Tx_Fluid_ViewHelpers_FormViewHelper', 'additionalIdentityProperties');
                $additionalIdentityProperties[$objectName] = $hiddenIdentityField;
                $this->viewHelperVariableContainer->addOrUpdate('Tx_Fluid_ViewHelpers_FormViewHelper', 'additionalIdentityProperties', $additionalIdentityProperties);
            }
        }
    }

    /**
     * Get the current property of the object bound to this form.
     *
     * @return mixed Value
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function getPropertyValue() {
        $formObject = $this->viewHelperVariableContainer->get('Tx_Fluid_ViewHelpers_FormViewHelper', 'formObject');
        $propertyName = $this->arguments['property'];

        if (is_array($formObject)) {
            return isset($formObject[$propertyName]) ? $formObject[$propertyName] : NULL;
        }
        return Tx_Extbase_Reflection_ObjectAccess::getPropertyPath($formObject, $propertyName);
    }

    /**
     * Internal method which checks if we should evaluate a domain object or just output arguments['name'] and arguments['value']
     *
     * @return boolean TRUE if we should evaluate the domain object, FALSE otherwise.
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     */
    protected function isObjectAccessorMode() {
        return $this->arguments->hasArgument('property')
            && $this->viewHelperVariableContainer->exists('Tx_Fluid_ViewHelpers_FormViewHelper', 'formObjectName');
    }

    /**
     * Add an CSS class if this view helper has errors
     *
     * @return void
     * @author Christopher Hlubek <hlubek@networkteam.com>
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function setErrorClassAttribute() {
        if ($this->arguments->hasArgument('class')) {
            $cssClass = $this->arguments['class'] . ' ';
        } else {
            $cssClass = '';
        }
        $errors = $this->getErrorsForProperty();
        if (count($errors) > 0) {
            if ($this->arguments->hasArgument('errorClass')) {
                $cssClass .= $this->arguments['errorClass'];
            } else {
                $cssClass .= 'error';
            }
            $this->tag->addAttribute('class', $cssClass);
        }
    }

    /**
     * Get errors for the property and form name of this view helper
     *
     * @return array An array of Tx_Fluid_Error_Error objects
     * @author Christopher Hlubek <hlubek@networkteam.com>
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function getErrorsForProperty() {
        if (!$this->isObjectAccessorMode()) {
            return array();
        }
        $errors = $this->controllerContext->getRequest()->getErrors();
        $formObjectName = $this->viewHelperVariableContainer->get('Tx_Fluid_ViewHelpers_FormViewHelper', 'formObjectName');
        $propertyName = $this->arguments['property'];
        $formErrors = array();
        foreach ($errors as $error) {
            if ($error instanceof Tx_Extbase_Validation_PropertyError && $error->getPropertyName() === $formObjectName) {
                $formErrors = $error->getErrors();
                foreach ($formErrors as $formError) {
                    if ($formError instanceof Tx_Extbase_Validation_PropertyError && $formError->getPropertyName() === $propertyName) {
                        return $formError->getErrors();
                    }
                }
            }
        }
        return array();
    }

    /**
     * Renders a hidden field with the same name as the element, to make sure the empty value is submitted
     * in case nothing is selected. This is needed for checkbox and multiple select fields
     *
     * @return string the hidden field.
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function renderHiddenFieldForEmptyValue() {
        $hiddenFieldNames = array();
        if ($this->viewHelperVariableContainer->exists('Tx_Fluid_ViewHelpers_FormViewHelper', 'renderedHiddenFields')) {
            $hiddenFieldNames = $this->viewHelperVariableContainer->get('Tx_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('Tx_Fluid_ViewHelpers_FormViewHelper', 'renderedHiddenFields', $hiddenFieldNames);

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

?>