‪TYPO3CMS  ‪main
TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper:
TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper TYPO3\CMS\Form\ViewHelpers\FormViewHelper

Public Member Functions

 injectHashService (HashService $hashService)
 
 injectMvcPropertyMappingConfigurationService (MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 injectExtensionService (ExtensionService $extensionService)
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 initializeArguments ()
 
 render ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
 injectPersistenceManager (PersistenceManagerInterface $persistenceManager)
 

Protected Member Functions

 setFormActionUri ()
 
string renderAdditionalIdentityFields ()
 
string renderHiddenReferrerFields ()
 
 addFormObjectNameToViewHelperVariableContainer ()
 
 removeFormObjectNameFromViewHelperVariableContainer ()
 
string getFormObjectName ()
 
 addFormObjectToViewHelperVariableContainer ()
 
 removeFormObjectFromViewHelperVariableContainer ()
 
 addFieldNamePrefixToViewHelperVariableContainer ()
 
 getFieldNamePrefix ()
 
 removeFieldNamePrefixFromViewHelperVariableContainer ()
 
 addFormFieldNamesToViewHelperVariableContainer ()
 
 removeFormFieldNamesFromViewHelperVariableContainer ()
 
 getDefaultFieldNamePrefix ()
 
 removeCheckboxFieldNamesFromViewHelperVariableContainer ()
 
 renderTrustedPropertiesField ()
 
 renderRequestTokenHiddenField ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
 prefixFieldName (string $fieldName)
 
string renderHiddenIdentityField (?object $object, ?string $name)
 
 registerFieldNameForFormTokenGeneration (string $fieldName)
 

Protected Attributes

string $tagName = 'form'
 
HashService $hashService
 
MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
ExtensionService $extensionService
 
ConfigurationManagerInterface $configurationManager
 
array $formActionUriArguments = []
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
PersistenceManagerInterface $persistenceManager
 

Detailed Description

Form ViewHelper. Generates a :html:<form> Tag. Tailored for extbase plugins, uses extbase Request.

Basic usage

Use :html:<f:form> to output an HTML :html:<form> tag which is targeted at the specified action, in the current controller and package. It will submit the form data via a POST request. If you want to change this, use :html:method="get" as an argument.

Examples

A complex form with a specified encoding type

Form with enctype set::

<f:form action=".." controller="..." package="..." enctype="multipart/form-data">...</f:form>

A Form which should render a domain object

Binding a domain object to a form::

<f:form action="..." name="customer" object="{customer}"> <f:form.hidden property="id" /> <f:form.textarea property="name" /> </f:form>

This automatically inserts the value of {customer.name} inside the textarea and adjusts the name of the textarea accordingly.

Definition at line 71 of file FormViewHelper.php.

Member Function Documentation

◆ addFieldNamePrefixToViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::addFieldNamePrefixToViewHelperVariableContainer ( )
protected

Adds the field name prefix to the ViewHelperVariableContainer.

Definition at line 361 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\getFieldNamePrefix().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ addFormFieldNamesToViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::addFormFieldNamesToViewHelperVariableContainer ( )
protected

Adds a container for form field names to the ViewHelperVariableContainer.

Definition at line 386 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ addFormObjectNameToViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::addFormObjectNameToViewHelperVariableContainer ( )
protected

Adds the form object name to the ViewHelperVariableContainer if "objectName" argument or "name" attribute is specified.

Definition at line 297 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\getFormObjectName().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ addFormObjectToViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::addFormObjectToViewHelperVariableContainer ( )
protected

Adds the object that is bound to this form to the ViewHelperVariableContainer if the formObject attribute is specified.

Definition at line 337 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ getDefaultFieldNamePrefix()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::getDefaultFieldNamePrefix ( )
protected

Retrieves the default field name prefix for this form

Definition at line 406 of file FormViewHelper.php.

References TYPO3\CMS\Core\Http\fromRequest.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\getFieldNamePrefix().

◆ getFieldNamePrefix()

◆ getFormObjectName()

string TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::getFormObjectName ( )
protected

Returns the name of the object that is bound to this form. If the "objectName" argument has been specified, this is returned. Otherwise the name attribute of this form. If neither objectName nor name arguments have been set, NULL is returned.

Returns
‪string specified Form name or NULL if neither $objectName nor $name arguments have been specified

Reimplemented in TYPO3\CMS\Form\ViewHelpers\FormViewHelper.

Definition at line 323 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\addFormObjectNameToViewHelperVariableContainer(), TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\removeFormObjectNameFromViewHelperVariableContainer(), and TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::initializeArguments ( )

Definition at line 108 of file FormViewHelper.php.

◆ injectConfigurationManager()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::injectConfigurationManager ( ConfigurationManagerInterface  $configurationManager)

◆ injectExtensionService()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::injectExtensionService ( ExtensionService  $extensionService)

◆ injectHashService()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::injectHashService ( HashService  $hashService)

◆ injectMvcPropertyMappingConfigurationService()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::injectMvcPropertyMappingConfigurationService ( MvcPropertyMappingConfigurationService  $mvcPropertyMappingConfigurationService)

◆ removeCheckboxFieldNamesFromViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::removeCheckboxFieldNamesFromViewHelperVariableContainer ( )
protected

Remove Checkbox field names from ViewHelper variable container, to start from scratch when a new form starts.

Definition at line 438 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ removeFieldNamePrefixFromViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::removeFieldNamePrefixFromViewHelperVariableContainer ( )
protected

Removes field name prefix from the ViewHelperVariableContainer.

Definition at line 378 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ removeFormFieldNamesFromViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::removeFormFieldNamesFromViewHelperVariableContainer ( )
protected

Removes the container for form field names from the ViewHelperVariableContainer.

Definition at line 394 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ removeFormObjectFromViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::removeFormObjectFromViewHelperVariableContainer ( )
protected

Removes the form object from the ViewHelperVariableContainer.

Definition at line 349 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ removeFormObjectNameFromViewHelperVariableContainer()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::removeFormObjectNameFromViewHelperVariableContainer ( )
protected

Removes the form name from the ViewHelperVariableContainer.

Definition at line 308 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\getFormObjectName().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ render()

◆ renderAdditionalIdentityFields()

string TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::renderAdditionalIdentityFields ( )
protected

Render additional identity fields which were registered by form elements. This happens if a form field is defined like property="bla.blubb" - then we might need an identity property for the sub-object "bla".

Returns
‪string HTML-string for the additional identity properties

Definition at line 248 of file FormViewHelper.php.

References $output.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ renderHiddenReferrerFields()

string TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::renderHiddenReferrerFields ( )
protected

Renders hidden form fields for referrer information about the current controller and action.

Returns
‪string Hidden fields with referrer information
Todo:
‪filter out referrer information that is equal to the target (e.g. same packageKey)

Reimplemented in TYPO3\CMS\Form\ViewHelpers\FormViewHelper.

Definition at line 269 of file FormViewHelper.php.

References TYPO3\CMS\Extbase\Security\prefix, and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\prefixFieldName().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

◆ renderRequestTokenHiddenField()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::renderRequestTokenHiddenField ( )
protected

◆ renderTrustedPropertiesField()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::renderTrustedPropertiesField ( )
protected

◆ setFormActionUri()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::setFormActionUri ( )
protected

Sets the "action" attribute of the form tag

Definition at line 202 of file FormViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\render().

Member Data Documentation

◆ $configurationManager

ConfigurationManagerInterface TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$configurationManager
protected

◆ $extensionService

ExtensionService TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$extensionService
protected

◆ $formActionUriArguments

array TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$formActionUriArguments = []
protected

We need the arguments of the formActionUri on request hash calculation therefore we will store them in here right after calling uriBuilder

Definition at line 86 of file FormViewHelper.php.

◆ $hashService

HashService TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$hashService
protected

◆ $mvcPropertyMappingConfigurationService

MvcPropertyMappingConfigurationService TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$mvcPropertyMappingConfigurationService
protected

◆ $tagName

string TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$tagName = 'form'
protected

Definition at line 75 of file FormViewHelper.php.