class CachingFactoryDecorator implements ChoiceListFactoryInterface

Caches the choice lists created by the decorated factory.

Methods

static string
generateHash(mixed $value, string $namespace = '')

Generates a SHA-256 hash for the given value.

__construct(ChoiceListFactoryInterface $decoratedFactory)

No description

getDecoratedFactory()

Returns the decorated factory.

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

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 50
static string generateHash(mixed $value, string $namespace = '')

Generates a SHA-256 hash for the given value.

Optionally, a namespace string can be passed. Calling this method will the same values, but different namespaces, will return different hashes.

Parameters

mixed $value The value to hash
string $namespace Optional. The namespace

Return Value

string The SHA-256 hash

at line 65
__construct(ChoiceListFactoryInterface $decoratedFactory)

Parameters

ChoiceListFactoryInterface $decoratedFactory

at line 75
ChoiceListFactoryInterface getDecoratedFactory()

Returns the decorated factory.

Return Value

ChoiceListFactoryInterface The decorated factory

at line 83
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 104
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 118
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