Класс: TwigFilter

Краткое содержание:

Класс для создания и обработки фильтров данных, а также для работы с сортировкой и стандартными фильтрами для шаблонов.

Свойства

• 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

1

public __construct(\RepositoryInterface  repository) : mixed

Краткое содержание

Конструктор класса.

Свойства:

Возвращает:

1

mixed

createFilter

1

public createFilter(string  column_name, string  type, string  label, string|null  select_value = null, array|null  choices = null) : array

Краткое содержание

Создает фильтр для указанного столбца с заданным типом и ярлыком.

Смотри так-же:

• \createFilterChoices()
• \getRepository()

Свойства:

Ошибки:

Возвращает:

1

array

Возвращает массив конфигурации фильтра.

createFilterChoices

1

public createFilterChoices(string  name, string  select) : array

Краткое содержание

Создает массив вариантов для фильтра на основе переданных данных.

Смотри так-же:

• \translate
• \getRepository

Свойства:

Ошибки:

Возвращает:

1

array

Ассоциативный массив, где ключи — значения фильтров, а значения — отображаемые имена фильтров.

getDefaultFilters

1

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.

Свойства:

Возвращает:

1

array

Ассоциативный массив, содержащий объединенные стандартные и дополнительные фильтры.

getRepository

1

public getRepository() : \RepositoryInterface

Краткое содержание

Возвращает используемый репозиторий.

Смотри так-же:

• \TwigFilter::$repository
• \TwigFilter::setRepository()

Возвращает:

1

\RepositoryInterface

Текущий экземпляр репозитория, связанный с данным объектом.

getSort

1

static public getSort(string  sort) : string

Краткое содержание

Определяет направление сортировки на основе переданной строки.

Описание

Возвращает значение константы, соответствующее направлению сортировки:

• Если передана строка 'asc' или 'ASC', возвращается SelectQuery::SORT_ASC.
• В остальных случаях возвращается SelectQuery::SORT_DESC.

Свойства:

Возвращает:

1

string

Возвращаемое значение сортировки: SelectQuery::SORT_ASC или SelectQuery::SORT_DESC.

setRepository

1

public setRepository(\RepositoryInterface  repository) : void

Краткое содержание

Устанавливает репозиторий для использования в текущем экземпляре класса.

Смотри так-же:

• \TwigFilter::$repository

Свойства:

Возвращает:

1

void