TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper:

Public Member Functions
	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
	initializeArguments ()
	getRespectSubmittedDataValue ()
	setRespectSubmittedDataValue (bool $respectSubmittedDataValue)
‪Public Member Functions inherited from ‪TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
	injectPersistenceManager (PersistenceManagerInterface $persistenceManager)

Protected Member Functions
	getName ()
RequestInterface	getRequest ()
	getNameWithoutPrefix ()
mixed	getValueAttribute ()
mixed	getValueFromSubmittedFormData ($value)
mixed	convertToPlainValue ($value)
	hasMappingErrorOccurred ()
mixed	getLastSubmittedFormData ()
	addAdditionalIdentityPropertiesIfNeeded ()
mixed	getPropertyValue ()
	isObjectAccessorMode ()
	setErrorClassAttribute ()
	getMappingResultsForProperty ()
	renderHiddenFieldForEmptyValue ()
‪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
ConfigurationManagerInterface	$configurationManager
bool	$respectSubmittedDataValue = false
‪Protected Attributes inherited from ‪TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
PersistenceManagerInterface	$persistenceManager

Detailed Description

Abstract Form ViewHelper. 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.

Note this set of ViewHelpers is tailored to be used only in extbase context.

Definition at line 36 of file AbstractFormFieldViewHelper.php.

Member Function Documentation

addAdditionalIdentityPropertiesIfNeeded()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::addAdditionalIdentityPropertiesIfNeeded ( )

protected

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.

Definition at line 241 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Extbase\Reflection\ObjectAccess\getPropertyPath(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\isObjectAccessorMode(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\renderHiddenIdentityField().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\HiddenViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextareaViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextfieldViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\PasswordViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\CountrySelectViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\render().

convertToPlainValue()

mixed TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::convertToPlainValue (   $value )

protected

Converts an arbitrary value to a plain value

Parameters

mixed

$value

‪The value to convert

Returns

‪mixed

Definition at line 198 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueAttribute(), TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper\render().

getLastSubmittedFormData()

mixed TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getLastSubmittedFormData ( )

protected

Get the form data which has last been submitted; only returns valid data in case a property mapping error has occurred. Check with hasMappingErrorOccurred() before!

Returns

‪mixed

Definition at line 225 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getNameWithoutPrefix(), TYPO3\CMS\Extbase\Reflection\ObjectAccess\getPropertyPath(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getRequest().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueFromSubmittedFormData(), TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper\render().

getMappingResultsForProperty()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getMappingResultsForProperty ( )

protected

Get errors for the property and form name of this ViewHelper

Definition at line 353 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getRequest(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\isObjectAccessorMode().

Referenced by TYPO3\CMS\Form\ViewHelpers\Form\UploadedResourceViewHelper\getUploadedResource(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\setErrorClassAttribute().

getName()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getName ( )

protected

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.

Definition at line 79 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getNameWithoutPrefix(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\prefixFieldName().

Referenced by TYPO3\CMS\Form\ViewHelpers\Form\TimePickerViewHelper\buildHourSelector(), TYPO3\CMS\Form\ViewHelpers\Form\TimePickerViewHelper\buildMinuteSelector(), TYPO3\CMS\Fluid\ViewHelpers\Form\UploadViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextareaViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextfieldViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\HiddenViewHelper\render(), TYPO3\CMS\Form\ViewHelpers\Form\TimePickerViewHelper\render(), TYPO3\CMS\Form\ViewHelpers\Form\UploadedResourceViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\SubmitViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\PasswordViewHelper\render(), TYPO3\CMS\Form\ViewHelpers\Form\DatePickerViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\ButtonViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\CountrySelectViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\renderHiddenFieldForEmptyValue().

getNameWithoutPrefix()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getNameWithoutPrefix ( )

protected

Get the name of this form element, without prefix.

Definition at line 107 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\isObjectAccessorMode().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getLastSubmittedFormData(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getName().

getPropertyValue()

mixed TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getPropertyValue ( )

protected

Get the current property of the object bound to this form.

Returns

‪mixed Value

Definition at line 296 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Extbase\Reflection\ObjectAccess\getPropertyPath().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueAttribute(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueFromSubmittedFormData(), TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper\render().

getRequest()

RequestInterface TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getRequest ( )

protected

Shortcut for retrieving the request from the controller context

Returns

‪RequestInterface The extbase (!) request. All these VH's are extbase-only.

Definition at line 90 of file AbstractFormFieldViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getLastSubmittedFormData(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getMappingResultsForProperty(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\hasMappingErrorOccurred().

getRespectSubmittedDataValue()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getRespectSubmittedDataValue

(

)

Getting the current configuration for respectSubmittedDataValue.

Definition at line 61 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\$respectSubmittedDataValue.

getValueAttribute()

mixed TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getValueAttribute ( )

protected

Returns the current value of this Form ViewHelper and converts it to an identifier string in case it's an object The value is determined as follows:

• ‪If property mapping errors occurred and the form is re-displayed, the last submitted value is returned
• ‪Else the bound property is returned (only in objectAccessor-mode)
• ‪As fallback the "value" argument of this ViewHelper is used

Note: This method should not be used for form elements that must not change the value attribute, e.g. (radio) buttons and checkboxes.

Returns

‪mixed Value

Definition at line 147 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\convertToPlainValue(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getPropertyValue(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueFromSubmittedFormData(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\isObjectAccessorMode().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\getSelectedValue(), TYPO3\CMS\Form\ViewHelpers\Form\UploadedResourceViewHelper\getUploadedResource(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextfieldViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextareaViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\HiddenViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\SubmitViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\PasswordViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\ButtonViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\CountrySelectViewHelper\render().

getValueFromSubmittedFormData()

mixed TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::getValueFromSubmittedFormData (   $value )

protected

If property mapping errors occurred and the form is re-displayed, the last submitted value is returned by this method.

Note: This method should not be used for form elements that must not change the value attribute, e.g. (radio) buttons and checkboxes. The default behaviour is not to use this method. You need to set respectSubmittedDataValue to TRUE to enable the form data handling for the viewhelper.

Parameters

mixed

$value

Returns

‪mixed Value

Definition at line 175 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getLastSubmittedFormData(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getPropertyValue(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\hasMappingErrorOccurred(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\isObjectAccessorMode().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueAttribute().

hasMappingErrorOccurred()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::hasMappingErrorOccurred ( )

protected

Checks if a property mapping error has occurred in the last request.

Definition at line 212 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getRequest().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueFromSubmittedFormData(), TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper\render().

initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::initializeArguments

(

)

Reimplemented in TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\CountrySelectViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper, TYPO3\CMS\Form\ViewHelpers\Form\DatePickerViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\SubmitViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\ButtonViewHelper, TYPO3\CMS\Form\ViewHelpers\Form\UploadedResourceViewHelper, TYPO3\CMS\Form\ViewHelpers\Form\TimePickerViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\HiddenViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\TextareaViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\UploadViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\PasswordViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\TextfieldViewHelper, TYPO3\CMS\Fluid\ViewHelpers\Form\Select\OptgroupViewHelper, and TYPO3\CMS\Fluid\ViewHelpers\Form\Select\OptionViewHelper.

Definition at line 46 of file AbstractFormFieldViewHelper.php.

injectConfigurationManager()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::injectConfigurationManager

(

ConfigurationManagerInterface

$configurationManager

)

Definition at line 41 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\$configurationManager.

isObjectAccessorMode()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::isObjectAccessorMode ( )

protected

Internal method which checks if we should evaluate a domain object or just output arguments['name'] and arguments['value']. Returns true if domoin object should be evaluated.

Definition at line 320 of file AbstractFormFieldViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\addAdditionalIdentityPropertiesIfNeeded(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getMappingResultsForProperty(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getNameWithoutPrefix(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueAttribute(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueFromSubmittedFormData().

renderHiddenFieldForEmptyValue()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::renderHiddenFieldForEmptyValue ( )

protected

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

Definition at line 372 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getName().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\render().

setErrorClassAttribute()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::setErrorClassAttribute ( )

protected

Add a CSS class if this ViewHelper has errors

Definition at line 331 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getMappingResultsForProperty().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\UploadViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextareaViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextfieldViewHelper\render(), TYPO3\CMS\Form\ViewHelpers\Form\TimePickerViewHelper\render(), TYPO3\CMS\Form\ViewHelpers\Form\UploadedResourceViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\PasswordViewHelper\render(), TYPO3\CMS\Form\ViewHelpers\Form\DatePickerViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\CheckboxViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\RadioViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\CountrySelectViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\render().

setRespectSubmittedDataValue()

TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::setRespectSubmittedDataValue

(

bool

$respectSubmittedDataValue

)

Define respectSubmittedDataValue to enable or disable the usage of the submitted values in the viewhelper.

Definition at line 69 of file AbstractFormFieldViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\$respectSubmittedDataValue.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\getSelectedValue(), TYPO3\CMS\Fluid\ViewHelpers\Form\HiddenViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextareaViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\TextfieldViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Form\PasswordViewHelper\render(), and TYPO3\CMS\Fluid\ViewHelpers\Form\CountrySelectViewHelper\render().

Member Data Documentation

$configurationManager

ConfigurationManagerInterface TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::$configurationManager

protected

Definition at line 38 of file AbstractFormFieldViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\injectConfigurationManager().

$respectSubmittedDataValue

bool TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper::$respectSubmittedDataValue = false

protected

Definition at line 39 of file AbstractFormFieldViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getRespectSubmittedDataValue(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\setRespectSubmittedDataValue().