Класс: TwigFilter
Документация по плагину класс: twigfilter для DLE.
Краткое содержание:
Класс для создания и обработки фильтров данных, а также для работы с сортировкой и стандартными фильтрами для шаблонов.
Свойства
- private $repository
Методы
- public __construct()
- public createFilter()
- public createFilterChoices()
- public getDefaultFilters()
- public getRepository()
- public getSort()
- public setRepository()
Подробности
- Путь: engine/inc/maharder/_includes/classes/TwigFilter.php
Свойства
private $repository : \Cycle\ORM\RepositoryInterface
Тип: \Cycle\ORM\RepositoryInterface
Методы
__construct
public __construct(\RepositoryInterface repository) : mixedКраткое содержание
Конструктор класса.
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $repository | \RepositoryInterface |
Возвращает:
mixedcreateFilter
public createFilter(string column_name, string type, string label, string|null select_value = null, array|null choices = null) : arrayКраткое содержание
Создает фильтр для указанного столбца с заданным типом и ярлыком.
Смотри так-же:
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $column_name | string | |
| $type | string | |
| $label | string | |
| $select_value | string|null | null |
| $choices | array|null | null |
Ошибки:
| Тип | Описание |
|---|---|
| \InvalidArgumentException | Если значение $type не соответствует ожидаемым. |
Возвращает:
arrayВозвращает массив конфигурации фильтра.
createFilterChoices
public createFilterChoices(string name, string select) : arrayКраткое содержание
Создает массив вариантов для фильтра на основе переданных данных.
Смотри так-же:
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $name | string | |
| $select | string |
Ошибки:
| Тип | Описание |
|---|---|
| \Throwable |
Возвращает:
arrayАссоциативный массив, где ключи — значения фильтров, а значения — отображаемые имена фильтров.
getDefaultFilters
static public getDefaultFilters(array additionalFilters = []) : arrayКраткое содержание
Создает и возвращает массив стандартных фильтров для входящих данных.
Описание
Стандартные фильтры включают:
- 'page' — валидация целого числа.
- 'mod', 'action', 'sites', 'order' — очистка данных с помощью
FILTER_SANITIZE_FULL_SPECIAL_CHARSи возвратnull, если фильтрация не удалась. - 'sort' — очистка данных аналогично предыдущим, но с приведением к верхнему регистру.
Метод предоставляет возможность добавлять пользовательские фильтры с помощью аргумента $additionalFilters.
Если значение пользовательского фильтра равно null, используется стандартный фильтр
FILTER_SANITIZE_FULL_SPECIAL_CHARS.
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $additionalFilters | array | [] |
Возвращает:
arrayАссоциативный массив, содержащий объединенные стандартные и дополнительные фильтры.
getRepository
public getRepository() : \RepositoryInterfaceКраткое содержание
Возвращает используемый репозиторий.
Смотри так-же:
Возвращает:
\RepositoryInterfaceТекущий экземпляр репозитория, связанный с данным объектом.
getSort
static public getSort(string sort) : stringКраткое содержание
Определяет направление сортировки на основе переданной строки.
Описание
Возвращает значение константы, соответствующее направлению сортировки:
- Если передана строка 'asc' или 'ASC', возвращается SelectQuery::SORT_ASC.
- В остальных случаях возвращается SelectQuery::SORT_DESC.
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $sort | string |
Возвращает:
stringВозвращаемое значение сортировки: SelectQuery::SORT_ASC или SelectQuery::SORT_DESC.
setRepository
public setRepository(\RepositoryInterface repository) : voidКраткое содержание
Устанавливает репозиторий для использования в текущем экземпляре класса.
Смотри так-же:
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $repository | \RepositoryInterface |
Возвращает:
void