class DefaultChoiceListFactory implements ChoiceListFactoryInterface

Default implementation of {@link ChoiceListFactoryInterface}.

Methods

createListFromChoices(iterable $choices, callable|null $value = null)

Creates a choice list for the given choices.

createListFromFlippedChoices(array|Traversable $choices, callable|null $value = null, $triggerDeprecationNotice = true) deprecated

Creates a choice list for the given choices.

createListFromLoader(ChoiceLoaderInterface $loader, callable|null $value = null)

Creates a choice list that is loaded with the given loader.

createView(ChoiceListInterface $list, array|callable|null $preferredChoices = null, callable|null $label = null, callable|null $index = null, callable|null $groupBy = null, array|callable|null $attr = null)

Creates a view for the given choice list.

Details

at line 35
ChoiceListInterface createListFromChoices(iterable $choices, callable|null $value = null)

Creates a choice list for the given choices.

The choices should be passed in the values of the choices 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

iterable $choices The choices
callable|null $value The callable generating the choice values

Return Value

ChoiceListInterface The choice list

at line 46
ChoiceListInterface createListFromFlippedChoices(array|Traversable $choices, callable|null $value = null, $triggerDeprecationNotice = true) deprecated

deprecated Added for backwards compatibility in Symfony 2.7, to be removed in Symfony 3.0.

Creates a choice list for the given choices.

The choices should be passed in the keys of the choices array. Since the choices array will be flipped, the entries of the array must be strings or integers.

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|Traversable $choices The choices
callable|null $value The callable generating the choice values
$triggerDeprecationNotice

Return Value

ChoiceListInterface The choice list

at line 58
ChoiceListInterface createListFromLoader(ChoiceLoaderInterface $loader, callable|null $value = null)

Creates a choice list that is loaded with the given loader.

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

ChoiceLoaderInterface $loader The choice loader
callable|null $value The callable generating the choice values

Return Value

ChoiceListInterface The choice list

at line 66
ChoiceListView createView(ChoiceListInterface $list, array|callable|null $preferredChoices = null, callable|null $label = null, callable|null $index = null, callable|null $groupBy = null, array|callable|null $attr = null)

Creates a view for the given choice list.

Callables may be passed for all optional arguments. The callables receive the choice as first and the array key as the second argument.

  • The callable for the label and the name should return the generated label/choice name.
  • The callable for the preferred choices should return true or false, depending on whether the choice should be preferred or not.
  • The callable for the grouping should return the group name or null if a choice should not be grouped.
  • The callable for the attributes should return an array of HTML attributes that will be inserted in the tag of the choice.

If no callable is passed, the labels will be generated from the choice keys. The view indices will be generated using an incrementing integer by default.

The preferred choices can also be passed as array. Each choice that is contained in that array will be marked as preferred.

The attributes can be passed as multi-dimensional array. The keys should match the keys of the choices. The values should be arrays of HTML attributes that should be added to the respective choice.

Parameters

ChoiceListInterface $list The choice list
array|callable|null $preferredChoices The preferred choices
callable|null $label The callable generating the choice labels
callable|null $index The callable generating the view indices
callable|null $groupBy The callable generating the group names
array|callable|null $attr The callable generating the HTML attributes

Return Value

ChoiceListView The choice list view