ArrayChoiceList
class ArrayChoiceList implements ChoiceListInterface
Список выборов с произвольными типами данных.
Пользователь этого класса отвечает за присвоение строковых значений выборам. И выбор, и их значения передаются в конструктор. Каждый выбор должен иметь соответствующее значение (с тем же ключом массива) в массиве значений.
Методы
| __construct(array|Traversable $choices, callable $value = null) Создаёт список с заданными выборами и значениями. | ||
| array | getChoices() Возвращает все выбираемые варианты. | |
| string[] | getValues() Возвращает значения для выборов. | |
| string[] | getStructuredValues() Возвращает значения в структуре, первоначально переданной в список. | |
| int[]|string[] | getOriginalKeys() Возвращает исходные ключи выборов. | |
| array | getChoicesForValues(array $values) Возвращает выборы, соответствующие заданным значениям. | |
| string[] | getValuesForChoices(array $choices) Возвращает значения, соответствующие заданным выборам. |
Подробности
__construct(array|Traversable $choices, callable $value = null)
Создаёт список с заданными выборами и значениями.
Переданный массив выборов должен иметь те же ключи массива, что и массив значений.
Параметры
| array|Traversable | $choices | Выбираемые варианты |
| callable | $value | Функция для создания значения для выбора. Если null передано, для значений используются инкрементирующие целые числа |
array getChoices()
Возвращает все выбираемые варианты.
Значение возврата
| array | Выбираемые варианты, индексированные соответствующими значениями |
string[] getValues()
Возвращает значения для выборов.
Значения являются строками, не содержащими дубликатов.
Значение возврата
| string[] | Значения выборов |
string[] 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'),
)
Значение возврата
| string[] | Значения выборов |
int[]|string[] getOriginalKeys()
Возвращает исходные ключи выборов.
Исходные ключи — это ключи массива выборов, который был передан в опции «выбор» типа выбора. Обратите внимание, что этот массив может содержать дубликаты, если опция «выбор» содержала группы выборов:
$form->add('field', 'choice', array(
'choices' => array(
'Decided' => array(true, false),
'Undecided' => array(null),
),
));
В этом примере ключ 0 появляется дважды, один раз для true и один раз для null.
Значение возврата
| int[]|string[] | Исходные ключи выборов, индексированные соответствующими значениями выборов |
array getChoicesForValues(array $values)
Возвращает выборы, соответствующие заданным значениям.
Выборы возвращаются с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| array | $values | Массив значений выборов. Отсутствующие значения в этом массиве игнорируются |
Значение возврата
| array | Массив выборов |
string[] getValuesForChoices(array $choices)
Возвращает значения, соответствующие заданным выборам.
Значения возвращаются с теми же ключами и в том же порядке, что и соответствующие выборы в заданном массиве.
Параметры
| array | $choices | Массив выборов. Отсутствующие выборы в этом массиве игнорируются |
Значение возврата
| string[] | Массив значений выборов |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Form/ChoiceList/ArrayChoiceList.html