Spec-Zone.ru › Symfony 3.4

SimpleChoiceList устаревшее

class SimpleChoiceList extends ChoiceList

устаревшее

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

Список вариантов для вариантов типа строка или целое число.

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

$choiceList = new SimpleChoiceList(array( 'creditcard' => 'Credit card payment', 'cash' => 'Cash payment', ));

Методы

__construct(array|Traversable $choices, array $preferredChoices = array())

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

массив getChoices()

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

из ChoiceList
массив getValues()

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

из ChoiceList
массив getPreferredViews()

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

из ChoiceList
массив getRemainingViews()

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

из ChoiceList
массив getChoicesForValues(array $values)

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

массив getValuesForChoices(array $choices)

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

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

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

из ChoiceList
массив getIndicesForValues(array $values) устаревшее

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

из ChoiceList

Подробности

__construct(array|Traversable $choices, array $preferredChoices = array())

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

Параметры

array|Traversable $choices Массив вариантов. Варианты также могут быть заданы в виде иерархии неограниченной глубины. Иерархии создаются путём создания вложенных массивов. Заголовок под-иерархии может быть сохранён в ключе массива, указывающем на вложенный массив. Верхний уровень иерархии также может быть объектом \Traversable.
массив $preferredChoices Плоский массив вариантов, которые должны быть представлены пользователю в приоритетном порядке.

массив getChoices()

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

Значение результата

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

массив getValues()

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

Значение результата

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

массив getPreferredViews()

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

Пример:

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

Значение результата

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

массив getRemainingViews()

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

Пример:

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

Значение результата

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

массив getChoicesForValues(array $values)

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

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

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

Параметры

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

Значение результата

массив Массив вариантов с возрастающими числовыми ключами с нулевого индекса

массив getValuesForChoices(array $choices)

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

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

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

Параметры

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

Значение результата

массив Массив значений вариантов с возрастающими числовыми ключами с нулевого индекса

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

устаревшее

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

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

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

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

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

Параметры

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

Значение результата

массив Массив индексов с возрастающими числовыми ключами с нулевого индекса

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

устаревшее

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

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

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

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

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

Параметры

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

Значение результата

массив Массив индексов с возрастающими числовыми ключами с нулевого индекса

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

Spec-Zone.ru

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