ModelChoiceList

__construct(string $class, string $labelPath = null, array|Traversable $choices = null, ModelCriteria $queryObject = null, string $groupPath = null, array|ModelCriteria $preferred = array(), PropertyAccessorInterface $propertyAccessor = null, string $useAsIdentifier = null)

Constructor.

Parameters

string	$class	The FQCN of the model class to be loaded.
string	$labelPath	A property path pointing to the property used for the choice labels. The value is obtained by calling the getter on the object. If the path is NULL, the object's __toString() method is used instead.
array|Traversable	$choices	The array of choices. Choices may also be given as hierarchy of unlimited depth. Hierarchies are created by creating nested arrays. The title of the sub-hierarchy can be stored in the array key pointing to the nested array. The topmost level of the hierarchy may also be a \Traversable.
ModelCriteria	$queryObject	The query to use retrieving model data from database.
string	$groupPath	A property path pointing to the property used to group the choices. Only allowed if the choices are given as flat array.
array|ModelCriteria	$preferred	The preferred items of this choice. Either an array if $choices is given, or a ModelCriteria to be merged with the $queryObject.
PropertyAccessorInterface	$propertyAccessor	The reflection graph for reading property paths.
string	$useAsIdentifier	a custom unique column (eg slug) to use instead of primary key.

Exceptions

MissingOptionsException	In case the class parameter is empty.
InvalidOptionsException	In case the query class is not found.

See also

\Symfony\Bridge\Propel1\Form\Type\ModelType

How to use the preferred choices.

array getChoices()

Returns the list of choices

Return Value

array

The choices with their indices as keys

array getValues()

Returns the values for the choices

Return Value

array

The values with the corresponding choice indices as keys

array getPreferredViews()

Returns the choice views of the preferred choices as nested array with the choice groups as top-level keys.

Example:

array( 'Group 1' => array( 10 => ChoiceView object, 20 => ChoiceView object, ), 'Group 2' => array( 30 => ChoiceView object, ), )

Return Value

array

A nested array containing the views with the corresponding choice indices as keys on the lowest levels and the choice group names in the keys of the higher levels

array getRemainingViews()

Returns the choice views of the choices that are not preferred as nested array with the choice groups as top-level keys.

Example:

array( 'Group 1' => array( 10 => ChoiceView object, 20 => ChoiceView object, ), 'Group 2' => array( 30 => ChoiceView object, ), )

Return Value

array

A nested array containing the views with the corresponding choice indices as keys on the lowest levels and the choice group names in the keys of the higher levels

array getChoicesForValues(array $values)

Returns the choices corresponding to the given values.

The choices can have any data type.

The choices must be returned with the same keys and in the same order as the corresponding values in the given array.

Parameters

array

$values

An array of choice values. Not existing values in this array are ignored

Return Value

array

An array of choices with ascending, 0-based numeric keys

array getValuesForChoices(array $models)

Returns the values corresponding to the given choices.

The values must be strings.

The values must be returned with the same keys and in the same order as the corresponding choices in the given array.

Parameters

array

$models

Return Value

array

An array of choice values with ascending, 0-based numeric keys

array getIndicesForChoices(array $models) ^deprecated

^deprecated

Deprecated since version 2.4, to be removed in 3.0.

Returns the indices corresponding to the given choices.

The indices must be positive integers or strings accepted by {@link FormConfigBuilder::validateName()}.

The index "placeholder" is internally reserved.

The indices must be returned with the same keys and in the same order as the corresponding choices in the given array.

Parameters

array

$models

Return Value

array

An array of indices with ascending, 0-based numeric keys

array getIndicesForValues(array $values) ^deprecated

^deprecated

Deprecated since version 2.4, to be removed in 3.0.

Returns the indices corresponding to the given values.

The indices must be positive integers or strings accepted by {@link FormConfigBuilder::validateName()}.

The index "placeholder" is internally reserved.

The indices must be returned with the same keys and in the same order as the corresponding values in the given array.

Parameters

array

$values

An array of choice values. Not existing values in this array are ignored

Return Value

array

An array of indices with ascending, 0-based numeric keys

string getClass()

Returns the class name of the model.

Return Value

string