Spec-Zone.ru › Symfony 3.4

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.1/Symfony/Component/Form/ChoiceList/Factory/DefaultChoiceListFactory.html

Spec-Zone.ru

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