Список выборов массива
класс ArrayChoiceList реализует ChoiceListInterface
Список выборов с произвольными типами данных.
Пользователь этого класса отвечает за назначение строковых значений выборам. И сами выборы, и их значения передаются в конструктор. Каждый выбор должен иметь соответствующее значение (с тем же ключом массива) в массиве значений.
Методы
| __construct(array|Traversable $choices, callable $value = null) Создаёт список с заданными выборами и значениями. | ||
| массив | getChoices() Возвращает все выбираемые варианты. | |
| массив строк | getValues() Возвращает значения для выборов. | |
| массив строк | getStructuredValues() Возвращает значения в структуре, первоначально переданной в список. | |
| массив целых чисел или строк | getOriginalKeys() Возвращает исходные ключи выборов. | |
| массив | getChoicesForValues(array $values) Возвращает выборы, соответствующие заданным значениям. | |
| массив строк | getValuesForChoices(array $choices) Возвращает значения, соответствующие заданным выборам. |
Подробности
__construct(array|Traversable $choices, callable $value = null)
Создаёт список с заданными выборами и значениями.
Переданный массив выборов должен иметь те же ключи массива, что и массив значений.
Параметры
| array|Traversable | $choices | Выбираемые варианты |
| callable | $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 | Массив выборов. Отсутствующие выборы в этом массиве игнорируются |
Возвращаемое значение
| массив строк | Массив значений выборов |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Form/ChoiceList/ArrayChoiceList.html