Spec-Zone.ru › Symfony 3.0

SimpleChoiceList deprecated

class SimpleChoiceList extends ChoiceList

deprecated

since version 2.7, to be removed in 3.0. Use {@link \Symfony\Component\Form\ChoiceList\ArrayChoiceList} instead.

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

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

$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) deprecated

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

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

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

из 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 Массив значений выборов. Несуществующие значения в этом массиве игнорируются

Значение возврата

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

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

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

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

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

Параметры

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

Значение возврата

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

массив getIndicesForChoices(array $choices) deprecated

deprecated

since version 2.4, to be removed in 3.0.

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

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

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

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

Параметры

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

Значение возврата

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

массив getIndicesForValues(array $values) deprecated

deprecated

since version 2.4, to be removed in 3.0.

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

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

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

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

Параметры

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

Значение возврата

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

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

Spec-Zone.ru

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