Spec-Zone.ru › Symfony 4.1

LazyChoiceList

class LazyChoiceList implements ChoiceListInterface

Список вариантов, загружаемый по требованию.

Варианты извлекаются с помощью экземпляра {@link ChoiceLoaderInterface}. Если вызываются только {@link getChoicesForValues()} или {@link getValuesForChoices()}, список вариантов загружается частично для повышения производительности.

После вызова {@link getChoices()} или {@link getValues()} список загружается полностью.

Методы

__construct(ChoiceLoaderInterface $loader, 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'),
)
int[]|строка[] getOriginalKeys()

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

Исходные ключи — это ключи массива вариантов, которые были переданы в опцию "choice" типа выбора. Обратите внимание, что этот массив может содержать дубликаты, если опция "choice" содержала группы вариантов:

$form->add('field', 'choice', array(
    'choices' => array(
        'Decided' => array(true, false),
        'Undecided' => array(null),
    ),
));

В этом примере исходный ключ 0 появляется дважды, один раз для true и один раз для null.

массив getChoicesForValues(массив $values)

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

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

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

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

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

Подробности

__construct(ChoiceLoaderInterface $loader, callable $value = null)

Создает список, загружаемый по требованию, с помощью заданного загрузчика.

Необязательно, можно передать вызываемый объект для генерации значений вариантов. Вызываемый объект получает вариант в качестве первого и индекс массива во втором аргументе.

Параметры

ChoiceLoaderInterface $loader Загрузчик вариантов
вызываемый объект $value Вызываемый объект, генерирующий значения вариантов

array 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'),
)

Возвращаемое значение

строка[] Значения вариантов

int[]|строка[] getOriginalKeys()

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

Исходные ключи — это ключи массива вариантов, которые были переданы в опцию "choice" типа выбора. Обратите внимание, что этот массив может содержать дубликаты, если опция "choice" содержала группы вариантов:

$form->add('field', 'choice', array(
    'choices' => array(
        'Decided' => array(true, false),
        'Undecided' => array(null),
    ),
));

В этом примере исходный ключ 0 появляется дважды, один раз для true и один раз для null.

Возвращаемое значение

int[]|строка[] Исходные ключи вариантов, индексированные соответствующими значениями вариантов

массив getChoicesForValues(массив $values)

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

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

Параметры

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

Возвращаемое значение

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

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

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

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

Параметры

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

Возвращаемое значение

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

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Form/ChoiceList/LazyChoiceList.html

Spec-Zone.ru

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