ChoiceLoaderInterface
interface ChoiceLoaderInterface
Loads a choice list.
The methods {@link loadChoicesForValues()} and {@link loadValuesForChoices()} can be used to load the list only partially in cases where a fully-loaded list is not necessary.
Methods
ChoiceListInterface | loadChoiceList(null|callable $value = null) Loads a list of choices. | |
array | loadChoicesForValues(array $values, null|callable $value = null) Loads the choices corresponding to the given values. | |
string[] | loadValuesForChoices(array $choices, null|callable $value = null) Loads the values corresponding to the given choices. |
Details
ChoiceListInterface loadChoiceList(null|callable $value = null)
Loads a list of choices.
Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument.
Parameters
null|callable | $value | The callable which generates the values from choices |
Return Value
ChoiceListInterface | The loaded choice list |
array loadChoicesForValues(array $values, null|callable $value = null)
Loads 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.
Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument.
Parameters
array | $values | An array of choice values. Non-existing values in this array are ignored |
null|callable | $value | The callable generating the choice values |
Return Value
array | An array of choices |
string[] loadValuesForChoices(array $choices, null|callable $value = null)
Loads 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.
Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument.
Parameters
array | $choices | An array of choices. Non-existing choices in this array are ignored |
null|callable | $value | The callable generating the choice values |
Return Value
string[] | An array of choice values |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Form/ChoiceList/Loader/ChoiceLoaderInterface.html