Список выбора ключей массива

__construct(array|Traversable $choices, callable|null $value = null)

Создаёт список с заданными вариантами и значениями.

Переданный массив вариантов должен иметь те же ключи массива, что и массив значений. Каждый вариант должен быть преобразуем в целое число/строку в соответствии с правилами преобразования, описанными в {@link toArrayKey()}.

Если значения не заданы, варианты преобразуются в строки и используются в качестве значений.

Параметры

array|Traversable	$choices	Выбираемые варианты
callable|null	$value	Функция для создания значения для варианта. Если null передано, в качестве значений используются увеличивающиеся целые числа.

Исключения

Исключение неверного аргумента

Если ключи вариантов не совпадают с ключами значений или какой-либо вариант не является скалярным

массив 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(array $values)

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

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

Параметры

массив

$values

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

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

массив

Массив вариантов

массив строк getValuesForChoices(array $choices)

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

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

Параметры

массив

$choices

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

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

массив строк

Массив значений вариантов

статический int|string toArrayKey(mixed $choice)

Преобразует заданный вариант в ключ массива.

PHP-массивы принимают только строки и целые числа в качестве ключей. Строки целых чисел, такие как "42", автоматически преобразуются в целые числа. Логические значения "true" и "false" преобразуются в целые числа 1 и 0 соответственно. Все остальные скалярные значения преобразуются в строки.

Параметры

mixed

$choice

Вариант

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

int|string

Вариант как ключ PHP-массива

Исключения

Исключение неверного аргумента

Если вариант не является скалярным