Spec-Zone.ru › Symfony 3.2

DefaultChoiceListFactory

class DefaultChoiceListFactory implements ChoiceListFactoryInterface

Стандартная реализация {@link ChoiceListFactoryInterface}.

Методы

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

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

ChoiceListInterface createListFromLoader(ChoiceLoaderInterface $loader, null|callable $value = null)

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

ChoiceListView createView(ChoiceListInterface $list, null|array|callable $preferredChoices = null, null|callable $label = null, null|callable $index = null, null|callable $groupBy = null, null|array|callable $attr = null)

Создаёт представление для данного списка вариантов.

Подробности

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

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

Варианты должны быть переданы в качестве значений массива вариантов.

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

Параметры

array|Traversable $choices Варианты
null|callable $value Вызываемый объект, генерирующий значения вариантов

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

ChoiceListInterface Список вариантов

ChoiceListInterface createListFromLoader(ChoiceLoaderInterface $loader, null|callable $value = null)

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

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

Параметры

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

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

ChoiceListInterface Список вариантов

ChoiceListView createView(ChoiceListInterface $list, null|array|callable $preferredChoices = null, null|callable $label = null, null|callable $index = null, null|callable $groupBy = null, null|array|callable $attr = null)

Создаёт представление для данного списка вариантов.

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

  • Вызываемый объект для метки и имени должен возвращать сгенерированную метку/имя варианта.
  • Вызываемый объект для предпочтительных вариантов должен возвращать true или false, в зависимости от того, должен ли вариант быть предпочтительным или нет.
  • Вызываемый объект для группировки должен возвращать имя группы или null, если вариант не должен быть сгруппирован.
  • Вызываемый объект для атрибутов должен возвращать массив HTML-атрибутов, которые будут вставлены в тег варианта.

Если вызываемый объект не передан, метки будут сгенерированы из ключей вариантов. Индексы представлений будут сгенерированы по умолчанию с использованием инкрементирующего целого числа.

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

Атрибуты могут быть переданы как многомерный массив. Ключи должны соответствовать ключам вариантов. Значения должны быть массивами HTML-атрибутов, которые должны быть добавлены к соответствующему варианту.

Параметры

ChoiceListInterface $list Список вариантов
null|array|callable $preferredChoices Предпочтительные варианты
null|callable $label Вызываемый объект, генерирующий метки вариантов
null|callable $index Вызываемый объект, генерирующий индексы представлений
null|callable $groupBy Вызываемый объект, генерирующий имена групп
null|array|callable $attr Вызываемый объект, генерирующий HTML-атрибуты

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

ChoiceListView Представление списка вариантов

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

Spec-Zone.ru

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