ChoiceListInterface устаревшее
интерфейс ChoiceListInterface
устаревшее
Содержит варианты, которые можно выбрать в поле формы.
Каждый вариант имеет три различных свойства:
- Вариант: значение, которое должно быть возвращено приложению полем выбора. Может быть любым скалярным значением или объектом, но не массивом.
- Метка: текст, представляющий выбор, который отображается пользователю.
- Значение: уникальное идентифицирующее значение, которое может содержать произвольные символы, но не массивы или объекты. Это значение отображается в атрибуте HTML «value».
Методы
| массив | getChoices() Возвращает список вариантов. | |
| массив | getValues() Возвращает значения для вариантов. | |
| массив | getPreferredViews() Возвращает представления выбранных вариантов в виде вложенного массива, где ключами верхнего уровня являются группы вариантов. | |
| массив | getRemainingViews() Возвращает представления вариантов, которые не являются предпочтительными, в виде вложенного массива, где ключами верхнего уровня являются группы вариантов. | |
| массив | getChoicesForValues(массив $values) Возвращает варианты, соответствующие заданным значениям. | |
| массив | getValuesForChoices(массив $choices) Возвращает значения, соответствующие заданным вариантам. | |
| массив | getIndicesForChoices(массив $choices) устаревшее Возвращает индексы, соответствующие заданным вариантам. | |
| массив | getIndicesForValues(массив $values) устаревшее Возвращает индексы, соответствующие заданным значениям. |
Подробности
массив getChoices()
Возвращает список вариантов.
Значение, возвращаемое функцией
| массив | Варианты с их индексами в качестве ключей |
массив getValues()
Возвращает значения для вариантов.
Значение, возвращаемое функцией
| массив | Значения с соответствующими индексами вариантов в качестве ключей |
массив getPreferredViews()
Возвращает представления выбранных вариантов в виде вложенного массива, где ключами верхнего уровня являются группы вариантов.
Пример:
Значение, возвращаемое функцией
| массив | Вложенный массив, содержащий представления с соответствующими индексами вариантов в качестве ключей на нижних уровнях и названиями групп вариантов в качестве ключей на верхних уровнях |
массив getRemainingViews()
Возвращает представления вариантов, которые не являются предпочтительными, в виде вложенного массива, где ключами верхнего уровня являются группы вариантов.
Пример:
Значение, возвращаемое функцией
| массив | Вложенный массив, содержащий представления с соответствующими индексами вариантов в качестве ключей на нижних уровнях и названиями групп вариантов в качестве ключей на верхних уровнях |
См. также
| getPreferredValues() |
массив getChoicesForValues(массив $values)
Возвращает варианты, соответствующие заданным значениям.
Варианты могут иметь любой тип данных.
Варианты должны быть возвращены с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| массив | $values | Массив значений вариантов. Несуществующие значения в этом массиве игнорируются |
Значение, возвращаемое функцией
| массив | Массив вариантов с возрастающими числовыми ключами, начинающимися с 0 |
массив getValuesForChoices(массив $choices)
Возвращает значения, соответствующие заданным вариантам.
Значения должны быть строками.
Значения должны быть возвращены с теми же ключами и в том же порядке, что и соответствующие варианты в заданном массиве.
Параметры
| массив | $choices | Массив вариантов. Несуществующие варианты в этом массиве игнорируются |
Значение, возвращаемое функцией
| массив | Массив значений вариантов с возрастающими числовыми ключами, начинающимися с 0 |
массив getIndicesForChoices(массив $choices) устаревшее
устаревшее
Возвращает индексы, соответствующие заданным вариантам.
Индексы должны быть положительными целыми числами или строками, принятыми {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.
Индекс «заполнитель» зарезервирован внутри.
Индексы должны быть возвращены с теми же ключами и в том же порядке, что и соответствующие варианты в заданном массиве.
Параметры
| массив | $choices | Массив вариантов. Несуществующие варианты в этом массиве игнорируются |
Значение, возвращаемое функцией
| массив | Массив индексов с возрастающими числовыми ключами, начинающимися с 0 |
массив getIndicesForValues(массив $values) устаревшее
устаревшее
Возвращает индексы, соответствующие заданным значениям.
Индексы должны быть положительными целыми числами или строками, принятыми {@link \Symfony\Component\Form\FormConfigBuilder::validateName()}.
Индекс «заполнитель» зарезервирован внутри.
Индексы должны быть возвращены с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| массив | $values | Массив значений вариантов. Несуществующие значения в этом массиве игнорируются |
Значение, возвращаемое функцией
| массив | Массив индексов с возрастающими числовыми ключами, начинающимися с 0 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Form/Extension/Core/ChoiceList/ChoiceListInterface.html
