Spec-Zone.ru › Symfony 3.4

ObjectChoiceList устаревшее

class ObjectChoiceList extends ChoiceList

устаревшее

since Symfony 2.7, будет удалено в версии 3.0. Используйте {@link \Symfony\Component\Form\ChoiceList\ArrayChoiceList} вместо этого.

Список вариантов для выбора объектов.

Поддерживает генерацию меток вариантов, групп вариантов и значений вариантов, вызывая геттеры объекта (или связанных объектов).

$choices = array($user1, $user2);

// вызов getName() для определения меток вариантов $choiceList = new ObjectChoiceList($choices, 'name');

Методы

__construct(array|Traversable $choices, string $labelPath = null, array $preferredChoices = array(), string $groupPath = null, string $valuePath = null, PropertyAccessorInterface $propertyAccessor = null)

Создаёт новый список вариантов объектов.

array getChoices()

Возвращает список вариантов.

из ChoiceList
array getValues()

Возвращает значения для вариантов.

из ChoiceList
array getPreferredViews()

Возвращает представления выбранных по умолчанию вариантов в виде вложенного массива с группами вариантов в качестве ключей верхнего уровня.

из ChoiceList
array getRemainingViews()

Возвращает представления вариантов, которые не являются выбранными по умолчанию, в виде вложенного массива с группами вариантов в качестве ключей верхнего уровня.

из ChoiceList
array getChoicesForValues(array $values)

Возвращает варианты, соответствующие заданным значениям.

из ChoiceList
array getValuesForChoices(array $choices)

Возвращает значения, соответствующие заданным вариантам.

array getIndicesForChoices(array $choices) устаревшее

Возвращает индексы, соответствующие заданным вариантам.

array getIndicesForValues(array $values) устаревшее

Возвращает индексы, соответствующие заданным значениям.

из ChoiceList

Подробности

__construct(array|Traversable $choices, string $labelPath = null, array $preferredChoices = array(), string $groupPath = null, string $valuePath = null, PropertyAccessorInterface $propertyAccessor = null)

Создаёт новый список вариантов объектов.

Параметры

array|Traversable $choices Массив вариантов. Варианты также могут быть представлены иерархией неограниченной глубины. Иерархии создаются путём создания вложенных массивов. Название под-иерархии может храниться в ключе массива, указывающем на вложенный массив. Самый верхний уровень иерархии также может быть \Traversable.
string $labelPath Путь к свойству, используемому для меток вариантов. Значение получается путём вызова геттера объекта. Если путь NULL, вместо этого используется метод __toString() объекта.
array $preferredChoices Плоский массив вариантов, которые должны быть представлены пользователю в приоритетном порядке.
string $groupPath Путь к свойству, используемому для группировки вариантов. Допустимо только если варианты заданы в виде плоского массива.
string $valuePath Путь к свойству, используемому для значений вариантов. Если не задано, вместо этого генерируются целые числа.
PropertyAccessorInterface $propertyAccessor Граф рефлексии для чтения путей свойств.

array getChoices()

Возвращает список вариантов.

Значение

array Варианты с их индексами в качестве ключей

array getValues()

Возвращает значения для вариантов.

Значение

array Значения с соответствующими индексами вариантов в качестве ключей

array getPreferredViews()

Возвращает представления выбранных по умолчанию вариантов в виде вложенного массива с группами вариантов в качестве ключей верхнего уровня.

Пример:

array( 'Группа 1' => array( 10 => Объект ChoiceView, 20 => Объект ChoiceView, ), 'Группа 2' => array( 30 => Объект ChoiceView, ), )

Значение

array Вложенный массив, содержащий представления с соответствующими индексами вариантов в качестве ключей на нижних уровнях и именами групп вариантов в качестве ключей на более высоких уровнях

array getRemainingViews()

Возвращает представления вариантов, которые не являются выбранными по умолчанию, в виде вложенного массива с группами вариантов в качестве ключей верхнего уровня.

Пример:

array( 'Группа 1' => array( 10 => Объект ChoiceView, 20 => Объект ChoiceView, ), 'Группа 2' => array( 30 => Объект ChoiceView, ), )

Значение

array Вложенный массив, содержащий представления с соответствующими индексами вариантов в качестве ключей на нижних уровнях и именами групп вариантов в качестве ключей на более высоких уровнях

array getChoicesForValues(array $values)

Возвращает варианты, соответствующие заданным значениям.

Варианты могут иметь любой тип данных.

Варианты должны возвращаться с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.

Параметры

array $values Массив значений вариантов. Несуществующие значения в этом массиве игнорируются

Значение

array Массив вариантов с возрастающими числовыми ключами, начиная с 0

array getValuesForChoices(array $choices)

Возвращает значения, соответствующие заданным вариантам.

Значения должны быть строками.

Значения должны возвращаться с теми же ключами и в том же порядке, что и соответствующие варианты в заданном массиве.

Параметры

array $choices Массив вариантов. Несуществующие варианты в этом массиве игнорируются

Значение

array Массив значений вариантов с возрастающими числовыми ключами, начиная с 0

array getIndicesForChoices(array $choices) устаревшее

устаревшее

since версия 2.4, будет удалена в 3.0.

Возвращает индексы, соответствующие заданным вариантам.

Индексы должны быть целыми положительными числами или строками, допускаемыми {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.

Индекс "placeholder" зарезервирован во внутреннем использовании.

Индексы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие варианты в заданном массиве.

Параметры

array $choices Массив вариантов. Несуществующие варианты в этом массиве игнорируются

Значение

array Массив индексов с возрастающими числовыми ключами, начиная с 0

array getIndicesForValues(array $values) устаревшее

устаревшее

since версия 2.4, будет удалена в 3.0.

Возвращает индексы, соответствующие заданным значениям.

Индексы должны быть целыми положительными числами или строками, допускаемыми {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.

Индекс "placeholder" зарезервирован во внутреннем использовании.

Индексы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.

Параметры

array $values Массив значений вариантов. Несуществующие значения в этом массиве игнорируются

Значение

array Массив индексов с возрастающими числовыми ключами, начиная с 0

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Form/Extension/Core/ChoiceList/ObjectChoiceList.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API