Spec-Zone.ru › Symfony 2.8

ChoiceListFactoryInterface

интерфейс ChoiceListFactoryInterface

Создаёт экземпляры {@link ChoiceListInterface}.

Методы

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

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

ChoiceListInterface createListFromFlippedChoices(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 createListFromFlippedChoices(array|Traversable $choices, null|callable $value = null) устаревший

устаревший

Добавлен для обратной совместимости в Symfony 2.7, будет удален в Symfony 3.0.

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

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

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

Параметры

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

Spec-Zone.ru

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