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

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

Public Member Functions
	initializeArguments ()
	render ()
Public Member Functions inherited from TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
	injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
	initializeArguments ()
	getRespectSubmittedDataValue ()
	setRespectSubmittedDataValue ($respectSubmittedDataValue)
Public Member Functions inherited from TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
	injectPersistenceManager (\TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager)
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)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	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
	renderOptionTags ($options)
	getOptions ()
	isSelected ($value)
	getSelectedValue ()
	getOptionValueScalar ($valueElement)
	renderOptionTag ($value, $label, $isSelected)
Protected Member Functions inherited from TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
	getName ()
	getRequest ()
	getNameWithoutPrefix ()
	getValue ($convertObjects=true)
	getValueAttribute ()
	getValueFromSubmittedFormData ($value)
	convertToPlainValue ($value)
	hasMappingErrorOccurred ()
	getLastSubmittedFormData ()
	addAdditionalIdentityPropertiesIfNeeded ()
	getPropertyValue ()
	isObjectAccessorMode ()
	setErrorClassAttribute ()
	getMappingResultsForProperty ()
	renderHiddenFieldForEmptyValue ()
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 ()
	getLogger ()
	buildRenderChildrenClosure ()
	hasArgument ($argumentName)

Protected Attributes
	$tagName = 'select'
	$selectedValue = null
Protected Attributes inherited from TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
	$configurationManager
	$respectSubmittedDataValue = false
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

This view helper generates a <select> dropdown list for the use with a form.

= Basic usage =

The most straightforward way is to supply an associative array as the "options" parameter. The array key is used as option key, and the value is used as human-readable name.

<f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" />

= Pre-select a value =

To pre-select a value, set "value" to the option key which should be selected. <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" value="visa" /> Generates a dropdown box like above, except that "VISA Card" is selected.

If the select box is a multi-select box (multiple="1"), then "value" can be an array as well.

= Usage on domain objects =

If you want to output domain objects, you can just pass them as array into the "options" parameter. To define what domain object value should be used as option key, use the "optionValueField" variable. Same goes for optionLabelField. If neither is given, the Identifier (UID/uid) and the __toString() method are tried as fallbacks.

If the optionValueField variable is set, the getter named after that value is used to retrieve the option key. If the optionLabelField variable is set, the getter named after that value is used to retrieve the option value.

If the prependOptionLabel variable is set, an option item is added in first position, bearing an empty string or - If provided, the value of the prependOptionValue variable as value.

<f:form.select name="users" options="{userArray}" optionValueField="id" optionLabelField="firstName" /> In the above example, the userArray is an array of "User" domain objects, with no array key specified.

So, in the above example, the method $user->getId() is called to retrieve the key, and $user->getFirstName() to retrieve the displayed value of each entry.

The "value" property now expects a domain object, and tests for object equivalence.

Definition at line 58 of file SelectViewHelper.php.

Member Function Documentation

getOptions()

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::getOptions ( )

protected

Render the option tags.

Returns

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

Definition at line 156 of file SelectViewHelper.php.

References TYPO3\CMS\Extbase\Reflection\ObjectAccess\getPropertyPath(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

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

getOptionValueScalar()

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::getOptionValueScalar (   $valueElement )

protected

Get the option value for an object

Parameters

mixed

$valueElement

Returns

string

Definition at line 253 of file SelectViewHelper.php.

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

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\getSelectedValue().

getSelectedValue()

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::getSelectedValue ( )

protected

Retrieves the selected value(s)

Returns

mixed value string or an array of strings

Definition at line 233 of file SelectViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\getOptionValueScalar(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getValueAttribute(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\setRespectSubmittedDataValue().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\isSelected().

initializeArguments()

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

(

)

Initialize arguments.

Returns

void

Definition at line 76 of file SelectViewHelper.php.

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

isSelected()

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::isSelected (   $value )

protected

Render the option tags.

Parameters

mixed

$value

Value to check for

Returns

bool TRUE if the value should be marked a s selected; FALSE otherwise

Definition at line 212 of file SelectViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\$selectedValue, TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\getSelectedValue(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

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

render()

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::render

(

)

Render the tag.

Returns

string rendered tag.

Definition at line 99 of file SelectViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\addAdditionalIdentityPropertiesIfNeeded(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\getName(), TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\getOptions(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper\registerFieldNameForFormTokenGeneration(), TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\renderHiddenFieldForEmptyValue(), TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\renderOptionTags(), and TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper\setErrorClassAttribute().

renderOptionTag()

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::renderOptionTag (   $value,   $label,   $isSelected  )

protected

Render one option tag

Parameters

string	$value	value attribute of the option tag (will be escaped)
string	$label	content of the option tag (will be escaped)
bool	$isSelected	specifies wheter or not to add selected attribute

Returns

string the rendered option tag

Definition at line 279 of file SelectViewHelper.php.

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

renderOptionTags()

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::renderOptionTags (   $options )

protected

Render the option tags.

Parameters

array

$options

the options for the form.

Returns

string rendered tags.

Definition at line 136 of file SelectViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument(), TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\isSelected(), and TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\renderOptionTag().

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

Member Data Documentation

$selectedValue

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::$selectedValue = null

protected

Definition at line 68 of file SelectViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper\isSelected().

$tagName

TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper::$tagName = 'select'

protected

Definition at line 63 of file SelectViewHelper.php.