0 follower

Class yii\filters\AjaxFilter

Inheritanceyii\filters\AjaxFilter » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0.13
Source Code https://github.com/yiisoft/yii2/blob/master/framework/filters/AjaxFilter.php

AjaxFilter allow to limit access only for ajax requests.

public function behaviors()
{
    return [
        [
            'class' => 'yii\filters\AjaxFilter',
            'only' => ['index']
        ],
    ];
}

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$errorMessage string The message to be displayed when request isn't ajax yii\filters\AjaxFilter
$except array List of action IDs that this filter should not apply to. yii\base\ActionFilter
$only array List of action IDs that this filter should apply to. yii\base\ActionFilter
$owner yii\base\Component|null The owner of this behavior yii\base\Behavior
$request yii\web\Request The current request. yii\filters\AjaxFilter

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
afterAction() This method is invoked right after an action is executed. yii\base\ActionFilter
afterFilter() yii\base\ActionFilter
attach() {@inheritdoc} yii\base\ActionFilter
beforeAction() {@inheritdoc} yii\filters\AjaxFilter
beforeFilter() yii\base\ActionFilter
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
detach() {@inheritdoc} yii\base\ActionFilter
events() Declares event handlers for the $owner's events. yii\base\Behavior
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() {@inheritdoc} yii\filters\AjaxFilter

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getActionId() Returns an action ID by converting yii\base\Action::$uniqueId into an ID relative to the module. yii\base\ActionFilter
isActive() Returns a value indicating whether the filter is active for the given action. yii\base\ActionFilter

Property Details

$errorMessage public property

The message to be displayed when request isn't ajax

public string $errorMessage 'Request must be XMLHttpRequest.'
$request public property

The current request. If not set, the request application component will be used.

public yii\web\Request $request null

Method Details

beforeAction() public method

{@inheritdoc}

public void beforeAction ( $action )
$action
init() public method

{@inheritdoc}

public void init ( )