W3cubDocs

/Symfony 2.8

Symfony\Component\Form\Extension\Core\ChoiceList\SimpleChoiceList

class SimpleChoiceList extends ChoiceList

A choice list for choices of type string or integer.

Choices and their associated labels can be passed in a single array. Since choices are passed as array keys, only strings or integer choices are allowed. Choices may also be given as hierarchy of unlimited depth by creating nested arrays. The title of the sub-hierarchy can be stored in the array key pointing to the nested array.

$choiceList = new SimpleChoiceList(array( 'creditcard' => 'Credit card payment', 'cash' => 'Cash payment', ));

Methods

__construct(array $choices, array $preferredChoices = array())

Creates a new simple choice list.
array getChoices()

Returns the list of choices.

 from ChoiceList
array getValues()

Returns the values for the choices.

 from ChoiceList
array getPreferredViews()

Returns the choice views of the preferred choices as nested array with the choice groups as top-level keys.

 from ChoiceList
array getRemainingViews()

Returns the choice views of the choices that are not preferred as nested array with the choice groups as top-level keys.

 from ChoiceList
array getChoicesForValues(array $values)

Returns the choices corresponding to the given values.
array getValuesForChoices(array $choices)

Returns the values corresponding to the given choices.
array getIndicesForChoices(array $choices)

Returns the indices corresponding to the given choices.

 from ChoiceList
array getIndicesForValues(array $values)

Returns the indices corresponding to the given values.

 from ChoiceList

Details

public __construct(array $choices, array $preferredChoices = array())

Creates a new simple choice list.

Parameters

array $choices The array of choices with the choices as keys and the labels as values. Choices may also be given as hierarchy of unlimited depth by creating nested arrays. The title of the sub-hierarchy is stored in the array key pointing to the nested array.
array $preferredChoices A flat array of choices that should be presented to the user with priority.

public array getChoices()

Returns the list of choices.

Return Value

array The choices with their indices as keys

public array getValues()

Returns the values for the choices.

Return Value

array The values with the corresponding choice indices as keys

public array getPreferredViews()

Returns the choice views of the preferred choices as nested array with the choice groups as top-level keys.

Example:

array( 'Group 1' => array( 10 => ChoiceView object, 20 => ChoiceView object, ), 'Group 2' => array( 30 => ChoiceView object, ), )

Return Value

array A nested array containing the views with the corresponding choice indices as keys on the lowest levels and the choice group names in the keys of the higher levels

public array getRemainingViews()

Returns the choice views of the choices that are not preferred as nested array with the choice groups as top-level keys.

Example:

array( 'Group 1' => array( 10 => ChoiceView object, 20 => ChoiceView object, ), 'Group 2' => array( 30 => ChoiceView object, ), )

Return Value

array A nested array containing the views with the corresponding choice indices as keys on the lowest levels and the choice group names in the keys of the higher levels

public array getChoicesForValues(array $values)

Returns the choices corresponding to the given values.

The choices can have any data type.

The choices must be returned with the same keys and in the same order as the corresponding values in the given array.

Parameters

array $values An array of choice values. Not existing values in this array are ignored

Return Value

array An array of choices with ascending, 0-based numeric keys

public array getValuesForChoices(array $choices)

Returns the values corresponding to the given choices.

The values must be strings.

The values must be returned with the same keys and in the same order as the corresponding choices in the given array.

Parameters

array $choices An array of choices. Not existing choices in this array are ignored

Return Value

array An array of choice values with ascending, 0-based numeric keys

public array getIndicesForChoices(array $choices)

Returns the indices corresponding to the given choices.

The indices must be positive integers or strings accepted by {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.

The index "placeholder" is internally reserved.

The indices must be returned with the same keys and in the same order as the corresponding choices in the given array.

Parameters

array $choices An array of choices. Not existing choices in this array are ignored

Return Value

array An array of indices with ascending, 0-based numeric keys

public array getIndicesForValues(array $values)

Returns the indices corresponding to the given values.

The indices must be positive integers or strings accepted by {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.

The index "placeholder" is internally reserved.

The indices must be returned with the same keys and in the same order as the corresponding values in the given array.

Parameters

array $values An array of choice values. Not existing values in this array are ignored

Return Value

array An array of indices with ascending, 0-based numeric keys

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Form/Extension/Core/ChoiceList/SimpleChoiceList.html