Класс yii\debug\components\search\Filter
| Наследование | yii\debug\components\search\Filter » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-debug/blob/master/components/search/Filter.php |
Предоставляет возможности фильтрации массивов.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список прикрепленных к этому компоненту поведений | yii\base\Component |
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $rules | массив | Правила для сопоставления фильтров в формате: [:fieldName => [rule1, rule2,. | yii\debug\components\search\Filter |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в null. | yii\base\Component |
| addMatcher() | Добавляет правило фильтрации данных. | yii\debug\components\search\Filter |
| attachBehavior() | Присоединяет поведение к данному компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, которые должен иметь данный компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| filter() | Применяет фильтр к заданному массиву и возвращает отфильтрованные данные. | yii\debug\components\search\Filter |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик события к событию. | yii\base\Component |
| trigger() | Вызывает событие. | yii\base\Component |
Подробное описание свойств
$rules защищённое свойство
Правила для сопоставления фильтров в формате: [:fieldName => [rule1, rule2,..]]
protected array $rules = []
Подробное описание методов
addMatcher() публичный метод
Добавляет правило фильтрации данных.
| public void addMatcher ( $name, yii\debug\components\search\matchers\MatcherInterface $rule ) | ||
|---|---|---|
| $name | строка |
Имя атрибута |
| $rule | yii\debug\components\search\matchers\MatcherInterface | |
filter() публичный метод
Применяет фильтр к заданному массиву и возвращает отфильтрованные данные.
| public массив filter ( массив $data ) | ||
|---|---|---|
| $data | массив |
Данные для фильтрации |
| return | массив |
Отфильтрованные данные |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-components-search-filter.html
