Класс: FilterSchema¶
Краткое содержание:¶
Декларативная схема фильтра списковых страниц админки.
Свойства¶
- public $sections
- public $defaultOrder
- public $sortColumns
Методы¶
- public __construct()
- public fromArray()
- public toArray()
- public allFields()
- public resolvedSortColumns()
- public sortColumnKeys()
- public filterDbColumns()
Подробности¶
- Путь:
devcraft/src/classes/Types/FilterSchema.php
Детали¶
Свойства¶
$sections¶
Секции полей фильтра.
$defaultOrder¶
Колонка сортировки по умолчанию.
$sortColumns¶
Явная карта колонок сортировки.
Методы¶
__construct()¶
Создаёт схему фильтра.
С версии: 200.4.0
Параметры: - $sections — Секции полей фильтра. - $defaultOrder — Колонка сортировки по умолчанию. - $sortColumns — Явная карта колонок сортировки.
fromArray()¶
Создаёт схему фильтра из ассоциативного массива.
С версии: 200.4.0
Возвращает: static — Новый экземпляр схемы.
toArray()¶
Преобразует схему фильтра в ассоциативный массив.
С версии: 200.4.0
Возвращает: array<string, — mixed> Сериализованная схема.
allFields()¶
Возвращает плоский список всех полей фильтра.
С версии: 200.4.0
Возвращает: FormField[] — Все поля всех секций.
resolvedSortColumns()¶
Возвращает карту колонок сортировки с учётом явных и выведенных значений.
С версии: 200.4.0
Возвращает: array<string, — string> Карта column => label.
sortColumnKeys()¶
Возвращает ключи колонок сортировки.
С версии: 200.4.0
Возвращает: list<string> — Список имён колонок БД.
filterDbColumns()¶
Возвращает имена колонок БД, участвующих в фильтрации.
С версии: 200.4.0
Возвращает: list<string> — Список имён колонок.