Класс yii\base\ActionFilter

Все классы | Свойства | Методы

Наследование	yii\base\ActionFilter » yii\base\Behavior » yii\base\Object
Реализует	yii\base\Configurable
Подклассы	yii\filters\AccessControl, yii\filters\ContentNegotiator, yii\filters\Cors, yii\filters\HostControl, yii\filters\HttpCache, yii\filters\PageCache, yii\filters\RateLimiter, yii\filters\auth\AuthMethod, yii\filters\auth\CompositeAuth, yii\filters\auth\HttpBasicAuth, yii\filters\auth\HttpBearerAuth, yii\filters\auth\QueryParamAuth
Доступен с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/base/ActionFilter.php

ActionFilter — базовый класс для фильтров действий.

Фильтр действия участвует в обработке выполнения действия, реагируя на события beforeAction и afterAction, которые генерируются модулями и контроллерами.

Обратите внимание на реализацию yii\filters\AccessControl, yii\filters\PageCache и yii\filters\HttpCache для примеров использования.

Дополнительную информацию и инструкции по использованию ActionFilter см. в статье руководства о фильтрах.

Публичные свойства

Свойство	Тип	Описание	Определено в
$except	массив	Список идентификаторов действий, к которым этот фильтр не должен применяться.	yii\base\ActionFilter
$only	массив	Список идентификаторов действий, к которым этот фильтр должен применяться.	yii\base\ActionFilter
$owner	yii\base\Component\|null	Владелец данного поведения	yii\base\Behavior

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т. е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в значение null.	yii\base\Object
afterAction()	Этот метод вызывается сразу после выполнения действия.	yii\base\ActionFilter
afterFilter()		yii\base\ActionFilter
attach()	Присоединяет объект поведения к компоненту.	yii\base\ActionFilter
beforeAction()	Этот метод вызывается непосредственно перед выполнением действия (после всех возможных фильтров). Вы можете переопределить этот метод, чтобы выполнить подготовку действия в последний момент.	yii\base\ActionFilter
beforeFilter()		yii\base\ActionFilter
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное квалифицированное имя этого класса.	yii\base\Object
detach()	Отсоединяет объект поведения от компонента.	yii\base\ActionFilter
events()	Объявляет обработчики событий для событий $owner.	yii\base\Behavior
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object

Защищенные методы

Метод	Описание	Определено в
getActionId()	Возвращает идентификатор действия, преобразуя yii\base\Action::$uniqueId в идентификатор, относящийся к модулю.	yii\base\ActionFilter
isActive()	Возвращает значение, указывающее, активен ли фильтр для данного действия.	yii\base\ActionFilter

Подробное описание свойств

$except публичное свойство

Список идентификаторов действий, к которым этот фильтр не должен применяться.

См. также $only.

public array $except = []

$only публичное свойство

Список идентификаторов действий, к которым этот фильтр должен применяться. Если это свойство не установлено, фильтр применяется ко всем действиям, за исключением тех, которые перечислены в $except. Если идентификатор действия присутствует как в $only, так и в $except, этот фильтр к нему НЕ применяется.

Обратите внимание, что если фильтр присоединён к модулю, идентификаторы действий также должны включать идентификаторы дочерних модулей (если таковые имеются) и контроллеров.

Начиная с версии 2.0.9, идентификаторы действий могут быть указаны с подстановками, например site/*.

См. также $except.

public array $only = null

Подробное описание методов

afterAction() public method

Этот метод вызывается сразу после выполнения действия.

Вы можете переопределить этот метод, чтобы выполнить некоторую постобработку действия.

public mixed afterAction ( $action, $result )
$action	yii\base\Action	Только что выполненное действие.
$result	mixed	Результат выполнения действия
return	mixed	Обработанный результат действия.

afterFilter() public method

public void afterFilter ( $event )
$event	yii\base\ActionEvent

attach() public method

Прикрепляет объект поведения к компоненту.

Реализация по умолчанию установит свойство $owner и подключит обработчики событий, как объявлено в events(). Убедитесь, что вы вызываете родительскую реализацию, если переопределяете этот метод.

public void attach ( $owner )
$owner	yii\base\Component	Компонент, к которому должен быть прикреплён этот компонент поведения.

beforeAction() public method

Этот метод вызывается непосредственно перед выполнением действия (после всех возможных фильтров). Вы можете переопределить этот метод, чтобы выполнить подготовку к действию в последний момент.

public boolean beforeAction ( $action )
$action	yii\base\Action	Действие, которое будет выполнено.
return	boolean	Продолжать ли выполнение действия.

beforeFilter() public method

public void beforeFilter ( $event )
$event	yii\base\ActionEvent

detach() public method

Открепляет объект поведения от компонента.

Реализация по умолчанию сбросит свойство $owner и отсоединит обработчики событий, объявленные в events(). Убедитесь, что вы вызываете родительскую реализацию, если переопределяете этот метод.

public void detach ( )

getActionId() protected method (available since version 2.0.7)

Возвращает идентификатор действия, преобразуя yii\base\Action::$uniqueId в идентификатор, относящийся к модулю

protected string getActionId ( $action )
$action	yii\base\Action

isActive() protected method

Возвращает значение, указывающее, активен ли фильтр для данного действия.

protected boolean isActive ( $action )
$action	yii\base\Action	Фильтруемое действие
return	boolean	Является ли фильтр активным для данного действия.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-actionfilter.html