Spec-Zone.ru › Symfony 2.8

ArrayChoiceList

class ArrayChoiceList implements ChoiceListInterface

Список вариантов с произвольными типами данных.

Пользователь этого класса отвечает за присвоение строковых значений вариантам. Как варианты, так и их значения передаются в конструктор. Каждый вариант должен иметь соответствующее значение (с тем же ключом массива) в массиве значений.

Методы

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

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

array getChoices()

Возвращает все выбираемые варианты.

string[] getValues()

Возвращает значения для вариантов.

string[] getStructuredValues()

Возвращает значения в структуре, первоначально переданной в список.

int[]|string[] getOriginalKeys()

Возвращает исходные ключи вариантов.

array getChoicesForValues(array $values)

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

string[] getValuesForChoices(array $choices)

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

Подробности

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

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

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

Параметры

array|Traversable $choices Выбираемые варианты
callable|null $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/2.8/Symfony/Component/Form/ChoiceList/ArrayChoiceList.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API