Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper:

Public Member Functions
	initializeArguments ()

	render ($action=NULL, array $arguments=array(), $controller=NULL, $extensionName=NULL, $pluginName=NULL, $pageUid=NULL, $object=NULL, $pageType=0, $noCache=FALSE, $noCacheHash=FALSE, $section='', $format='', array $additionalParams=array(), $absolute=FALSE, $addQueryString=FALSE, array $argumentsToBeExcludedFromQueryString=array(), $fieldNamePrefix=NULL, $actionUri=NULL, $objectName=NULL, $hiddenFieldClassName=NULL)

Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	__construct ()

	initialize ()

Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	setArguments (array $arguments)

	setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)

	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)

	isEscapingInterceptorEnabled ()

	setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)

	setRenderChildrenClosure (\Closure $renderChildrenClosure)

	initializeArgumentsAndRender ()

	initialize ()

	renderChildren ()

	prepareArguments ()

	validateArguments ()

	initializeArguments ()

	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)

	resetState ()

Protected Member Functions
	setFormActionUri ()

	renderAdditionalIdentityFields ()

	renderHiddenReferrerFields ()

	renderHiddenSecuredReferrerField ()

	addFormObjectNameToViewHelperVariableContainer ()

	removeFormObjectNameFromViewHelperVariableContainer ()

	getFormObjectName ()

	addFormObjectToViewHelperVariableContainer ()

	removeFormObjectFromViewHelperVariableContainer ()

	addFieldNamePrefixToViewHelperVariableContainer ()

	getFieldNamePrefix ()

	removeFieldNamePrefixFromViewHelperVariableContainer ()

	addFormFieldNamesToViewHelperVariableContainer ()

	removeFormFieldNamesFromViewHelperVariableContainer ()

	addSecuredHiddenFieldsRenderedToViewHelperVariableContainer ()

	hasSecuredHiddenFieldsRendered ()

	removeSecuredHiddenFieldsRenderedFromViewHelperVariableContainer ()

	renderRequestHashField ()

	postProcessUriArgumentsForRequestHash ($arguments, &$results, $currentPrefix='', $level=0)

	getDefaultFieldNamePrefix ()

	removeCheckboxFieldNamesFromViewHelperVariableContainer ()

	renderTrustedPropertiesField ()

Protected Member Functions inherited from TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
	prefixFieldName ($fieldName)

	renderHiddenIdentityField ($object, $name)

	registerFieldNameForFormTokenGeneration ($fieldName)

Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	registerTagAttribute ($name, $type, $description, $required=FALSE, $default=NULL)

	registerUniversalTagAttributes ()

Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	registerArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)

	overrideArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)

	callRenderMethod ()

	buildRenderChildrenClosure ()

	hasArgument ($argumentName)

Protected Attributes
	$tagName = 'form'

	$requestHashService

	$hashService

	$mvcPropertyMappingConfigurationService

	$extensionService

	$formActionUriArguments

	$configurationManager

Protected Attributes inherited from TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
	$persistenceManager

Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	$tag = NULL

	$tagName = 'div'

Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments

	$templateVariableContainer

	$controllerContext

	$renderingContext

	$renderChildrenClosure = NULL

	$viewHelperVariableContainer

	$objectManager

	$escapingInterceptorEnabled = TRUE

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)

Detailed Description

Form view helper. Generates a <form> Tag.

= Basic usage =

Use <f:form> to output an 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 method="get" as an argument. <f:form action="...">...</f:form>

= A complex form with a specified encoding type =

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

= A Form which should render a domain object =

<f:form action="..." name="customer" object="{customer}"> <f:form.hidden property="id" /> <f:form.textbox property="name" /> </f:form> This automatically inserts the value of {customer.name} inside the textbox and adjusts the name of the textbox accordingly.

Definition at line 50 of file FormViewHelper.php.

Member Function Documentation

◆ addFieldNamePrefixToViewHelperVariableContainer()

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

protected

Adds the field name prefix to the ViewHelperVariableContainer

Returns: void

Definition at line 350 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

Returns: void

Definition at line 382 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.

Returns: void

Definition at line 285 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.

Returns: void

Definition at line 326 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

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

◆ addSecuredHiddenFieldsRenderedToViewHelperVariableContainer()

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

protected

Adds flag to indicate the secured hidden fields have been rendered to the ViewHelperVariableContainer

Definition at line 401 of file FormViewHelper.php.

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

◆ getDefaultFieldNamePrefix()

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

protected

Retrieves the default field name prefix for this form

Returns: string default field name prefix

Definition at line 459 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

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

◆ getFieldNamePrefix()

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

protected

Get the field name prefix

Returns: string

Definition at line 360 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\getDefaultFieldNamePrefix(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\addFieldNamePrefixToViewHelperVariableContainer(), TYPO3\CMS\Extensionmanager\ViewHelpers\DownloadExtensionViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\renderRequestHashField(), and TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\renderTrustedPropertiesField().

◆ getFormObjectName()

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

Definition at line 311 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

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

◆ hasSecuredHiddenFieldsRendered()

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

protected

Checks whether the secured hidden fields have been rendered

Returns: bool

Definition at line 411 of file FormViewHelper.php.

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

◆ initializeArguments()

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

Initialize arguments.

Returns: void

Definition at line 100 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper\registerTagAttribute(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper\registerUniversalTagAttributes().

◆ postProcessUriArgumentsForRequestHash()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::postProcessUriArgumentsForRequestHash	(		$arguments,
		&	$results,
			$currentPrefix = `''`,
			$level = `0`
	)

protected

Add the URI arguments after postprocessing to the request hash as well.

Definition at line 440 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\$arguments.

◆ 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 481 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

Returns: void

Definition at line 373 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

Returns: void

Definition at line 391 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.

Returns: void

Definition at line 338 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

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

◆ removeFormObjectNameFromViewHelperVariableContainer()

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

protected

Removes the form name from the ViewHelperVariableContainer.

Returns: void

Definition at line 297 of file FormViewHelper.php.

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

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

◆ removeSecuredHiddenFieldsRenderedFromViewHelperVariableContainer()

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

protected

Removes flag to indicate the secured hidden fields have been rendered from the ViewHelperVariableContainer

Definition at line 419 of file FormViewHelper.php.

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

◆ render()

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::render	(		$action = `NULL`,
		array	$arguments = `array()`,
			$controller = `NULL`,
			$extensionName = `NULL`,
			$pluginName = `NULL`,
			$pageUid = `NULL`,
			$object = `NULL`,
			$pageType = `0`,
			$noCache = `FALSE`,
			$noCacheHash = `FALSE`,
			$section = `''`,
			$format = `''`,
		array	$additionalParams = `array()`,
			$absolute = `FALSE`,
			$addQueryString = `FALSE`,
		array	$argumentsToBeExcludedFromQueryString = `array()`,
			$fieldNamePrefix = `NULL`,
			$actionUri = `NULL`,
			$objectName = `NULL`,
			$hiddenFieldClassName = `NULL`
	)

Render the form.

Parameters

string	$action	Target action
array	$arguments	Arguments
string	$controller	Target controller
string	$extensionName	Target Extension Name (without "tx_" prefix and no underscores). If NULL the current extension name is used
string	$pluginName	Target plugin. If empty, the current plugin name is used
integer	$pageUid	Target page uid
mixed	$object	Object to use for the form. Use in conjunction with the "property" attribute on the sub tags
integer	$pageType	Target page type
boolean	$noCache	set this to disable caching for the target page. You should not need this.
boolean	$noCacheHash	set this to supress the cHash query parameter created by TypoLink. You should not need this.
string	$section	The anchor to be added to the action URI (only active if $actionUri is not set)
string	$format	The requested format (e.g. ".html") of the target page (only active if $actionUri is not set)
array	$additionalParams	additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set)
boolean	$absolute	If set, an absolute action URI is rendered (only active if $actionUri is not set)
boolean	$addQueryString	If set, the current query parameters will be kept in the action URI (only active if $actionUri is not set)
array	$argumentsToBeExcludedFromQueryString	arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set
string	$fieldNamePrefix	Prefix that will be added to all field names within this form. If not set the prefix will be tx_yourExtension_plugin
string	$actionUri	can be used to overwrite the "action" attribute of the form tag
string	$objectName	name of the object that is bound to this form. If this argument is not specified, the name attribute of this form is used to determine the FormObjectName
string	$hiddenFieldClassName

Returns: string rendered form

Definition at line 134 of file FormViewHelper.php.

◆ renderAdditionalIdentityFields()

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 198 of file FormViewHelper.php.

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

◆ renderHiddenReferrerFields()

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)

Definition at line 217 of file FormViewHelper.php.

References $result, TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\prefixFieldName(), and TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\renderHiddenSecuredReferrerField().

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

◆ renderHiddenSecuredReferrerField()

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

protected

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

This method is called twice, to deal with subclasses of this class in a most compatible way

Returns: string Hidden field with secured referrer information

Definition at line 249 of file FormViewHelper.php.

References $result, TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\addSecuredHiddenFieldsRenderedToViewHelperVariableContainer(), TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\hasSecuredHiddenFieldsRendered(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\prefixFieldName().

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

◆ renderRequestHashField()

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

protected

Render the request hash field

Returns: string the hmac field

Definition at line 429 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\getFieldNamePrefix(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\prefixFieldName().

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

◆ renderTrustedPropertiesField()

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

protected

Render the request hash field

Returns: string The hmac field

Definition at line 492 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper\getFieldNamePrefix(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\prefixFieldName().

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

◆ setFormActionUri()

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

protected

Sets the "action" attribute of the form tag

Returns: void

Definition at line 181 of file FormViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

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

Member Data Documentation

◆ $configurationManager

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

protected

Definition at line 93 of file FormViewHelper.php.

◆ $extensionService

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

protected

Definition at line 79 of file FormViewHelper.php.

◆ $formActionUriArguments

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$formActionUriArguments

protected

Definition at line 87 of file FormViewHelper.php.

◆ $hashService

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

protected

Definition at line 67 of file FormViewHelper.php.

◆ $mvcPropertyMappingConfigurationService

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

protected

Definition at line 73 of file FormViewHelper.php.

◆ $requestHashService

TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper::$requestHashService

protected

Definition at line 61 of file FormViewHelper.php.

◆ $tagName

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

protected

Definition at line 55 of file FormViewHelper.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addFieldNamePrefixToViewHelperVariableContainer()

◆ addFormFieldNamesToViewHelperVariableContainer()

◆ addFormObjectNameToViewHelperVariableContainer()

◆ addFormObjectToViewHelperVariableContainer()

◆ addSecuredHiddenFieldsRenderedToViewHelperVariableContainer()

◆ getDefaultFieldNamePrefix()

◆ getFieldNamePrefix()

◆ getFormObjectName()

◆ hasSecuredHiddenFieldsRendered()

◆ initializeArguments()

◆ postProcessUriArgumentsForRequestHash()

◆ removeCheckboxFieldNamesFromViewHelperVariableContainer()

◆ removeFieldNamePrefixFromViewHelperVariableContainer()

◆ removeFormFieldNamesFromViewHelperVariableContainer()

◆ removeFormObjectFromViewHelperVariableContainer()

◆ removeFormObjectNameFromViewHelperVariableContainer()

◆ removeSecuredHiddenFieldsRenderedFromViewHelperVariableContainer()

◆ render()

◆ renderAdditionalIdentityFields()

◆ renderHiddenReferrerFields()

◆ renderHiddenSecuredReferrerField()

◆ renderRequestHashField()

◆ renderTrustedPropertiesField()

◆ setFormActionUri()

Member Data Documentation

◆ $configurationManager

◆ $extensionService

◆ $formActionUriArguments

◆ $hashService

◆ $mvcPropertyMappingConfigurationService

◆ $requestHashService

◆ $tagName