ChoiceList\LegacyChoiceListAdapter (Component\Form)
Symfony\Component\Form\ChoiceList\LegacyChoiceListAdapter
class LegacyChoiceListAdapter implements ChoiceListInterface
Adapts a legacy choice list implementation to {@link ChoiceListInterface}.
Methods
__construct(ChoiceListInterface $adaptedList) Adapts a legacy choice list to {@link ChoiceListInterface}. | ||
array | getChoices() Returns all selectable choices. | |
string[] | getValues() Returns the values for the choices. | |
string[] | getStructuredValues() Returns the values in the structure originally passed to the list. | |
int[]|string[] | getOriginalKeys() Returns the original keys of the choices. | |
array | getChoicesForValues(array $values) Returns the choices corresponding to the given values. | |
string[] | getValuesForChoices(array $choices) Returns the values corresponding to the given choices. | |
ChoiceListInterface | getAdaptedList() Returns the adapted choice list. |
Details
public __construct(ChoiceListInterface $adaptedList)
Adapts a legacy choice list to {@link ChoiceListInterface}.
public array getChoices()
Returns all selectable choices.
public string[] getValues()
Returns the values for the choices.
The values are strings that do not contain duplicates.
public string[] getStructuredValues()
Returns the values in the structure originally passed to the list.
Contrary to {@link getValues()}, the result is indexed by the original keys of the choices. If the original array contained nested arrays, these nested arrays are represented here as well:
$form->add('field', 'choice', array(
'choices' => array(
'Decided' => array('Yes' => true, 'No' => false),
'Undecided' => array('Maybe' => null),
),
));
In this example, the result of this method is:
array(
'Decided' => array('Yes' => '0', 'No' => '1'),
'Undecided' => array('Maybe' => '2'),
)
public int[]|string[] getOriginalKeys()
Returns the original keys of the choices.
The original keys are the keys of the choice array that was passed in the "choice" option of the choice type. Note that this array may contain duplicates if the "choice" option contained choice groups:
$form->add('field', 'choice', array(
'choices' => array(
'Decided' => array(true, false),
'Undecided' => array(null),
),
));
In this example, the original key 0 appears twice, once for true
and once for null
.
public array getChoicesForValues(array $values)
Returns the choices corresponding to the given values.
The choices are returned with the same keys and in the same order as the corresponding values in the given array.
public string[] getValuesForChoices(array $choices)
Returns the values corresponding to the given choices.
The values are returned with the same keys and in the same order as the corresponding choices in the given array.
public ChoiceListInterface getAdaptedList()
Returns the adapted choice list.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/ChoiceList/LegacyChoiceListAdapter.html