ChoiceListInterface
интерфейс ChoiceListInterface
Список вариантов, которые можно выбрать в поле выбора.
Список вариантов присваивает уникальные строковые значения каждому из элементов списка. Эти строковые значения отображаются в атрибутах "value" в HTML и отправляются обратно на сервер.
Допустимые типы данных для вариантов зависят от реализации. Значения всегда должны быть строками и (в пределах списка) не должны содержать дубликатов.
Методы
| массив | getChoices() Возвращает все выбираемые варианты. | |
| массив строк | getValues() Возвращает значения для вариантов. | |
| массив строк | getStructuredValues() Возвращает значения в структуре, первоначально переданной в список. | |
| массив целых чисел или строк | getOriginalKeys() Возвращает исходные ключи вариантов. | |
| массив | getChoicesForValues(массив $values) Возвращает варианты, соответствующие заданным значениям. | |
| массив строк | getValuesForChoices(массив $choices) Возвращает значения, соответствующие заданным вариантам. |
Подробности
массив getChoices()
Возвращает все выбираемые варианты.
Значение результата
| массив | Выбираемые варианты, индексированные соответствующими значениями |
массив строк getValues()
Возвращает значения для вариантов.
Значения являются строками, не содержащими дубликатов.
Значение результата
| массив строк | Значения вариантов |
массив строк getStructuredValues()
Возвращает значения в структуре, первоначально переданной в список.
В отличие от {@link getValues()}, результат индексируется исходными ключами вариантов. Если исходный массив содержал вложенные массивы, эти вложенные массивы также представлены здесь:
$form->add('field', 'choice', array(
'choices' => array(
'Decided' => array('Yes' => true, 'No' => false),
'Undecided' => array('Maybe' => null),
),
));
В этом примере результат этого метода:
array(
'Decided' => array('Yes' => '0', 'No' => '1'),
'Undecided' => array('Maybe' => '2'),
)
Значение результата
| массив строк | Значения вариантов |
массив целых чисел или строк getOriginalKeys()
Возвращает исходные ключи вариантов.
Исходные ключи — это ключи массива вариантов, переданного в опции "choice" типа выбора. Обратите внимание, что этот массив может содержать дубликаты, если опция "choice" содержала группы вариантов:
$form->add('field', 'choice', array(
'choices' => array(
'Decided' => array(true, false),
'Undecided' => array(null),
),
));
В этом примере исходный ключ 0 появляется дважды, один раз для true и один раз для null.
Значение результата
| массив целых чисел или строк | Исходные ключи вариантов, индексированные соответствующими значениями вариантов |
массив getChoicesForValues(массив $values)
Возвращает варианты, соответствующие заданным значениям.
Варианты возвращаются с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| массив | $values | Массив значений вариантов. Несуществующие значения в этом массиве игнорируются |
Значение результата
| массив | Массив вариантов |
массив строк getValuesForChoices(массив $choices)
Возвращает значения, соответствующие заданным вариантам.
Значения возвращаются с теми же ключами и в том же порядке, что и соответствующие варианты в заданном массиве.
Параметры
| массив | $choices | Массив вариантов. Несуществующие варианты в этом массиве игнорируются |
Значение результата
| массив строк | Массив значений вариантов |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Form/ChoiceList/ChoiceListInterface.html