array getValues() Returns the values for the choices Return Value array The values with the corresponding choice indices as keys

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 leve

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 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 ch

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 Val

string getClass() Returns the class name of the model. Return Value string

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 getChoices() Returns the list of choices Return Value array The choices with their indices as keys

class ModelChoiceList extends ObjectChoiceList A choice list for object choices based on Propel model. Methods __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. array getChoices() Returns the list of choices array getValues() Returns the values

bool start() Starts the session. Return Value bool True if started Exceptions RuntimeException If something goes wrong starting the session.