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

loadChoiceList(callable$value =null)

Loads a list of choices.

array
loadChoicesForValues(array$values,callable$value =null)

Loads the choices corresponding to the given values.

array
loadValuesForChoices(array$choices,callable$value =null)

Loads the values corresponding to the given choices.

Details

ChoiceListInterface loadChoiceList(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 only argument. Null may be passed when the choice list contains the empty value.

Parameters

callable $value The callable which generates the values from choices

Return Value

ChoiceListInterface

array loadChoicesForValues(array$values,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 only argument. Null may be passed when the choice list contains the empty value.

Parameters

array $values An array of choice values. Non-existing values in this array are ignored
callable $value The callable generating the choice values

Return Value

array

array loadValuesForChoices(array$choices,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 only argument. Null may be passed when the choice list contains the empty value.

Parameters

array $choices An array of choices. Non-existing choices in this array are ignored
callable $value The callable generating the choice values

Return Value

array