class ChoiceList implements ChoiceListInterface
deprecated
since version 2.7, to be removed in 3.0. Use {@link \Symfony\Component\Form\ChoiceList\ArrayChoiceList} instead.
A choice list for choices of arbitrary data types.
Choices and labels are passed in two arrays. The indices of the choices and the labels should match. 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. The topmost level of the hierarchy may also be a \Traversable.
$choices = array(true, false);
$labels = array('Agree', 'Disagree');
$choiceList = new ArrayChoiceList($choices, $labels);
Methods
| __construct(array|Traversable $choices, array $labels, array $preferredChoices = array()) Creates a new choice list. | ||
| array | getChoices() Returns the list of choices. | |
| array | getValues() Returns the values for the choices. | |
| array | getPreferredViews() Returns the choice views of the preferred choices as nested array with the choice groups as top-level keys. | |
| array | getRemainingViews() Returns the choice views of the choices that are not preferred as nested array with the choice groups as top-level keys. | |
| 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) deprecated Returns the indices corresponding to the given choices. | |
| array | getIndicesForValues(array $values) deprecated Returns the indices corresponding to the given values. |
Details
__construct(array|Traversable $choices, array $labels, array $preferredChoices = array())
Creates a new choice list.
array getChoices()
Returns the list of choices.
array getValues()
Returns the values for the choices.
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, ), )
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, ), )
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.
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.
array getIndicesForChoices(array $choices) deprecated
deprecated
since version 2.4, to be removed in 3.0.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.
array getIndicesForValues(array $values) deprecated
deprecated
since version 2.4, to be removed in 3.0.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.
Please login to continue.