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