ObjectChoiceList устаревшее
class ObjectChoiceList extends ChoiceList
устаревшее
Список выборов для выборов объектов.
Поддерживает генерацию меток выборов, групп выборов и значений выборов, вызывая геттеры объекта (или связанных объектов).
$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 | Вложенный массив, содержащий представления с соответствующими индексами выбора в качестве ключей на нижних уровнях и названиями групп выборов в ключах верхних уровней |
array getRemainingViews()
Возвращает представления выборов, которые не являются предпочтительными, в виде вложенного массива, где ключами верхнего уровня являются группы выборов.
Пример:
Возвращаемое значение
| array | Вложенный массив, содержащий представления с соответствующими индексами выбора в качестве ключей на нижних уровнях и названиями групп выборов в ключах верхних уровней |
array getChoicesForValues(array $values)
Возвращает выборы, соответствующие заданным значениям.
Выборы могут иметь любой тип данных.
Выборы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| array | $values | Массив значений выбора. Несуществующие значения в этом массиве игнорируются |
Возвращаемое значение
| array | Массив выборов с возрастающими числовыми ключами, начиная с 0 |
array getValuesForChoices(array $choices)
Возвращает значения, соответствующие заданным выборам.
Значения должны быть строками.
Значения должны возвращаться с теми же ключами и в том же порядке, что и соответствующие выборы в заданном массиве.
Параметры
| array | $choices | Массив выборов. Несуществующие выборы в этом массиве игнорируются |
Возвращаемое значение
| array | Массив значений выбора с возрастающими числовыми ключами, начиная с 0 |
array getIndicesForChoices(array $choices) устаревшее
устаревшее
Возвращает индексы, соответствующие заданным выборам.
Индексы должны быть положительными целыми числами или строками, принимаемыми {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.
Индекс "заполнитель" зарезервирован внутри.
Индексы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие выборы в заданном массиве.
Параметры
| array | $choices | Массив выборов. Несуществующие выборы в этом массиве игнорируются |
Возвращаемое значение
| array | Массив индексов с возрастающими числовыми ключами, начиная с 0 |
array getIndicesForValues(array $values) устаревшее
устаревшее
Возвращает индексы, соответствующие заданным значениям.
Индексы должны быть положительными целыми числами или строками, принимаемыми {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.
Индекс "заполнитель" зарезервирован внутри.
Индексы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| array | $values | Массив значений выбора. Несуществующие значения в этом массиве игнорируются |
Возвращаемое значение
| array | Массив индексов с возрастающими числовыми ключами, начиная с 0 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Form/Extension/Core/ChoiceList/ObjectChoiceList.html