Список выбора модели
класс ModelChoiceList расширяет ObjectChoiceList
Список выбора для выборов объектов на основе модели Propel.
Методы
| __construct(string $class, string $labelPath = null, array|Traversable $choices = null, ModelCriteria $queryObject = null, string $groupPath = null, array|ModelCriteria $preferred = array(), PropertyAccessorInterface $propertyAccessor = null, string $useAsIdentifier = null) Конструктор. | ||
| array | getChoices() Возвращает список выборов | |
| array | getValues() Возвращает значения для выборов | |
| array | getPreferredViews() Возвращает представления выборов предпочтительных вариантов в виде вложенного массива, где ключами верхнего уровня являются группы выборов. | |
| array | getRemainingViews() Возвращает представления выборов, которые не являются предпочтительными, в виде вложенного массива, где ключами верхнего уровня являются группы выборов. | |
| array | getChoicesForValues(array $values) Возвращает выборы, соответствующие заданным значениям. | |
| array | getValuesForChoices(array $models) Возвращает значения, соответствующие заданным выборам. | |
| array | getIndicesForChoices(array $models) устарело Возвращает индексы, соответствующие заданным выборам. | |
| array | getIndicesForValues(array $values) устарело Возвращает индексы, соответствующие заданным значениям. | |
| string | getClass() Возвращает имя класса модели. |
Подробности
__construct(string $class, string $labelPath = null, array|Traversable $choices = null, ModelCriteria $queryObject = null, string $groupPath = null, array|ModelCriteria $preferred = array(), PropertyAccessorInterface $propertyAccessor = null, string $useAsIdentifier = null)
Конструктор.
Параметры
| string | $class | FQCN класса модели, который должен быть загружен. |
| string | $labelPath | Путь к свойству, используемому для меток выбора. Значение получается путем вызова геттера объекта. Если путь равен NULL, используется метод __toString() объекта вместо него. |
| array|Traversable | $choices | Массив выборов. Выборы также могут быть заданы иерархией неограниченной глубины. Иерархии создаются путем создания вложенных массивов. Заголовок под-иерархии может быть сохранен в ключе массива, указывающем на вложенный массив. Верхний уровень иерархии также может быть \Traversable. |
| ModelCriteria | $queryObject | Запрос для извлечения данных модели из базы данных. |
| string | $groupPath | Путь к свойству, используемому для группировки выборов. Допускается только если выборы заданы как плоский массив. |
| array|ModelCriteria | $preferred | Предпочтительные элементы этого выбора. Либо массив, если заданы $choices, либо ModelCriteria для объединения с $queryObject. |
| PropertyAccessorInterface | $propertyAccessor | Граф рефлексии для чтения путей свойств. |
| string | $useAsIdentifier | Настраиваемый уникальный столбец (например, slug), который следует использовать вместо первичного ключа. |
Исключения
| MissingOptionsException | В случае, если параметр класса пустой. |
| InvalidOptionsException | В случае, если класс запроса не найден. |
См. также
| \Symfony\Bridge\Propel1\Form\Type\ModelType | Как использовать предпочтительные выборы. |
array getChoices()
Возвращает список выборов
Возвращаемое значение
| array | Выборы с их индексами в качестве ключей |
array getValues()
Возвращает значения для выборов
Возвращаемое значение
| array | Значения с соответствующими индексами выбора в качестве ключей |
array getPreferredViews()
Возвращает представления выборов предпочтительных вариантов в виде вложенного массива, где ключами верхнего уровня являются группы выборов.
Пример:
Возвращаемое значение
| array | Вложенный массив, содержащий представления с соответствующими индексами выбора в качестве ключей на нижних уровнях и именами групп выборов в качестве ключей на более высоких уровнях |
array getRemainingViews()
Возвращает представления выборов, которые не являются предпочтительными, в виде вложенного массива, где ключами верхнего уровня являются группы выборов.
Пример:
Возвращаемое значение
| array | Вложенный массив, содержащий представления с соответствующими индексами выбора в качестве ключей на нижних уровнях и именами групп выборов в качестве ключей на более высоких уровнях |
array getChoicesForValues(array $values)
Возвращает выборы, соответствующие заданным значениям.
Выборы могут иметь любой тип данных.
Выборы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| array | $values | Массив значений выбора. Несуществующие значения в этом массиве игнорируются |
Возвращаемое значение
| array | Массив выборов с возрастающими, нулевыми индексами |
array getValuesForChoices(array $models)
Возвращает значения, соответствующие заданным выборам.
Значения должны быть строками.
Значения должны возвращаться с теми же ключами и в том же порядке, что и соответствующие выборы в заданном массиве.
Параметры
| array | $models |
Возвращаемое значение
| array | Массив значений выбора с возрастающими, нулевыми индексами |
array getIndicesForChoices(array $models) устарело
устарело
Возвращает индексы, соответствующие заданным выборам.
Индексы должны быть положительными целыми числами или строками, которые принимаются {@link FormConfigBuilder::validateName()}.
Индекс "заполнитель" зарезервирован внутри.
Индексы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие выборы в заданном массиве.
Параметры
| array | $models |
Возвращаемое значение
| array | Массив индексов с возрастающими, нулевыми индексами |
array getIndicesForValues(array $values) устарело
устарело
Возвращает индексы, соответствующие заданным значениям.
Индексы должны быть положительными целыми числами или строками, которые принимаются {@link FormConfigBuilder::validateName()}.
Индекс "заполнитель" зарезервирован внутри.
Индексы должны возвращаться с теми же ключами и в том же порядке, что и соответствующие значения в заданном массиве.
Параметры
| array | $values | Массив значений выбора. Несуществующие значения в этом массиве игнорируются |
Возвращаемое значение
| array | Массив индексов с возрастающими, нулевыми индексами |
string getClass()
Возвращает имя класса модели.
Возвращаемое значение
| string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Bridge/Propel1/Form/ChoiceList/ModelChoiceList.html