SelectViewHelper

final class \TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper

Extends
AbstractFormFieldViewHelper

ViewHelper which renders a `<select>` dropdown list for use within a form.

  <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" value="visa" />
  <f:form.select property="users" options="{userList}" optionValueField="id" optionLabelField="firstName" multiple="true" />

Tags

see
https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-form-select

Table of Contents

Properties

$configurationManager  : ConfigurationManagerInterface
$pageRenderer  : PageRenderer
$persistenceManager  : PersistenceManagerInterface
$respectSubmittedDataValue  : bool
$tagName  : string

Methods

getRespectSubmittedDataValue()  : bool
Getting the current configuration for respectSubmittedDataValue.
initializeArguments()  : void
injectConfigurationManager()  : void
injectPageRenderer()  : void
injectPersistenceManager()  : void
render()  : string
setRespectSubmittedDataValue()  : void
Define respectSubmittedDataValue to enable or disable the usage of the submitted values in the viewhelper.
addAdditionalIdentityPropertiesIfNeeded()  : void
Add additional identity properties in case the current property is hierarchical (of the form "bla.blubb").
convertToPlainValue()  : mixed
Converts an arbitrary value to a plain value
getLastSubmittedFormData()  : mixed
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!
getMappingResultsForProperty()  : Result
Get errors for the property and form name of this ViewHelper
getName()  : string
Get the name of this form element.
getNameWithoutPrefix()  : string
Get the name of this form element, without prefix.
getOptions()  : array
Render the option tags.
getOptionValueScalar()  : string
Get the option value for an object
getPropertyValue()  : mixed
Get the current property of the object bound to this form.
getRequest()  : RequestInterface
Shortcut for retrieving the request from the controller context
getSelectedValue()  : mixed
Retrieves the selected value(s)
getValueAttribute()  : mixed
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 * If a "value" attribute was specified, this value is used (preferring an "override" from integrators) * Else the bound property value is returned (only in objectAccessor-mode)
getValueFromSubmittedFormData()  : mixed
If property mapping errors occurred and the form is re-displayed, the *last submitted* value is returned by this method.
hasMappingErrorOccurred()  : bool
Checks if a property mapping error has occurred in the last request.
isObjectAccessorMode()  : bool
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.
isSelected()  : bool
Render the option tags.
prefixFieldName()  : string
Prefixes / namespaces the given name with the form field prefix
registerFieldNameForFormTokenGeneration()  : void
Register a field name for inclusion in the HMAC / Form Token generation
renderHiddenFieldForEmptyValue()  : string
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
renderHiddenIdentityField()  : string
Renders a hidden form field containing the technical identity of the given object.
renderOptionTag()  : string
Render one option tag
renderOptionTags()  : string
Render the option tags.
renderPrependOptionTag()  : string
Render prepended option tag
setErrorClassAttribute()  : void
Add a CSS class if this ViewHelper has errors
shouldUseXHtmlSlash()  : bool

Properties

$respectSubmittedDataValue

protected bool $respectSubmittedDataValue = false

$tagName

protected string $tagName = 'select'

Methods

getRespectSubmittedDataValue()

Getting the current configuration for respectSubmittedDataValue.

public getRespectSubmittedDataValue() : bool

Return values

bool

initializeArguments()

public initializeArguments() : void

render()

public render() : string

Return values

string

setRespectSubmittedDataValue()

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

public setRespectSubmittedDataValue(bool $respectSubmittedDataValue) : void

Parameters

$respectSubmittedDataValue : bool

addAdditionalIdentityPropertiesIfNeeded()

Add additional identity properties in case the current property is hierarchical (of the form "bla.blubb").

protected addAdditionalIdentityPropertiesIfNeeded() : void

Then, [bla][__identity] has to be generated as well.

convertToPlainValue()

Converts an arbitrary value to a plain value

protected convertToPlainValue(mixed $value) : mixed

Parameters

$value : mixed

The value to convert

getLastSubmittedFormData()

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!

protected getLastSubmittedFormData() : mixed

getMappingResultsForProperty()

Get errors for the property and form name of this ViewHelper

protected getMappingResultsForProperty() : Result

Return values

Result

getName()

Get the name of this form element.

protected getName() : string

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 values

string

getNameWithoutPrefix()

Get the name of this form element, without prefix.

protected getNameWithoutPrefix() : string

Return values

string

getOptions()

Render the option tags.

protected getOptions() : array

Return values

array —

An associative array of options, key will be the value of the option tag

getOptionValueScalar()

Get the option value for an object

protected getOptionValueScalar(mixed $valueElement) : string

Parameters

$valueElement : mixed

Return values

string —

@todo: Does not always return string ...

getPropertyValue()

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

protected getPropertyValue() : mixed

Return values

mixed —

Value

getRequest()

Shortcut for retrieving the request from the controller context

protected getRequest() : RequestInterface

Return values

RequestInterface —

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

getSelectedValue()

Retrieves the selected value(s)

protected getSelectedValue() : mixed

Return values

mixed —

value string or an array of strings

getValueAttribute()

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 * If a "value" attribute was specified, this value is used (preferring an "override" from integrators) * Else the bound property value is returned (only in objectAccessor-mode)

protected getValueAttribute() : mixed

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

Return values

mixed —

Value

getValueFromSubmittedFormData()

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

protected getValueFromSubmittedFormData(mixed $value) : mixed

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

$value : mixed

Return values

mixed —

Value

hasMappingErrorOccurred()

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

protected hasMappingErrorOccurred() : bool

Return values

bool

isObjectAccessorMode()

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.

protected isObjectAccessorMode() : bool

Return values

bool

isSelected()

Render the option tags.

protected isSelected(mixed $value) : bool

Parameters

$value : mixed

Value to check for

Return values

bool —

True if the value should be marked as selected.

prefixFieldName()

Prefixes / namespaces the given name with the form field prefix

protected prefixFieldName(string $fieldName) : string

Parameters

$fieldName : string

Return values

string

registerFieldNameForFormTokenGeneration()

Register a field name for inclusion in the HMAC / Form Token generation

protected registerFieldNameForFormTokenGeneration(string $fieldName) : void

Parameters

$fieldName : string

renderHiddenFieldForEmptyValue()

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

protected renderHiddenFieldForEmptyValue() : string

Return values

string

renderHiddenIdentityField()

Renders a hidden form field containing the technical identity of the given object.

protected renderHiddenIdentityField(mixed $object, string|null $name) : string

Parameters

$object : mixed

Object to create the identity field for. Non-objects are ignored.

$name : string|null

Name

Tags

see
Argument::setValue()

Return values

string —

A hidden field containing the Identity (uid) of the given object

renderOptionTag()

Render one option tag

protected renderOptionTag(string $value, string $label, bool $isSelected) : string

Parameters

$value : string

value attribute of the option tag (will be escaped)

$label : string

content of the option tag (will be escaped)

$isSelected : bool

specifies whether to add selected attribute

Return values

string —

the rendered option tag

renderOptionTags()

Render the option tags.

protected renderOptionTags(array $options) : string

Parameters

$options : array

Return values

string

renderPrependOptionTag()

Render prepended option tag

protected renderPrependOptionTag() : string

Return values

string

setErrorClassAttribute()

Add a CSS class if this ViewHelper has errors

protected setErrorClassAttribute() : void

shouldUseXHtmlSlash()

protected shouldUseXHtmlSlash() : bool

Return values

bool
On this page