0 关注者

类 yii\base\ActionFilter

所有类 | 属性 | 方法
继承yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
实现yii\base\Configurable
子类yii\filters\AccessControl, yii\filters\AjaxFilter, 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\HttpHeaderAuth, 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 array 此过滤器不应应用于的动作 ID 列表。 yii\base\ActionFilter
$only array 此过滤器应应用于的动作 ID 列表。 yii\base\ActionFilter
$owner yii\base\Component|null 此行为的拥有者 yii\base\Behavior

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即已定义且不为空。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
afterAction() 此方法在执行动作后立即调用。 yii\base\ActionFilter
afterFilter() yii\base\ActionFilter
attach() 将行为对象附加到组件。 yii\base\ActionFilter
beforeAction() 此方法在要执行动作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法以对动作进行最后一分钟的准备。 yii\base\ActionFilter
beforeFilter() yii\base\ActionFilter
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
detach() 从组件中分离行为对象。 yii\base\ActionFilter
events() 声明 $owner 的事件的事件处理程序。 yii\base\Behavior
hasMethod() 返回一个值，指示是否定义了方法。 yii\base\BaseObject
hasProperty() 返回一个值，指示是否定义了属性。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject

受保护的方法

隐藏继承的方法

方法 描述 定义于
getActionId() 通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回动作 ID。 yii\base\ActionFilter
isActive() 返回一个值，指示过滤器对于给定动作是否处于活动状态。 yii\base\ActionFilter

属性详细信息

隐藏继承的属性

$except 公共属性

此过滤器不应应用于的动作 ID 列表。

另请参见 $only。

public array $except = []
$only 公共属性

此过滤器应应用于的动作 ID 列表。如果未设置此属性，则过滤器将应用于所有动作，除非它们列在 $except 中。如果动作 ID 同时出现在 $only 和 $except 中，则此过滤器将不应用于它。

请注意，如果过滤器附加到模块，则动作 ID 应还包括子模块 ID（如果有）和控制器 ID。

从版本 2.0.9 开始，动作 ID 可以指定为通配符，例如 site/*。

另请参见 $except。

public array $only = []

方法详细信息

隐藏继承的方法

__call() 公共方法

定义于: yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时将隐式调用它。

public mixed __call ( $name, $params )
$name string

方法名称
$params array

方法参数
返回 mixed

方法返回值
抛出 yii\base\UnknownMethodException

当调用未知方法时

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()。

如果此方法在子类中被覆盖，建议

  • 构造函数的最后一个参数是配置数组，例如这里的 $config。
  • 在构造函数的末尾调用父实现。
public void __construct ( $config = [] )
$config array

将用于初始化对象属性的名称-值对

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public method

定义于: yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，将在执行 $value = $object->property; 时隐式调用。

另请参见 __set().

public mixed __get ( $name )
$name string

属性名称
返回 mixed

属性值
抛出 yii\base\UnknownPropertyException

如果未定义属性
抛出 yii\base\InvalidCallException

如果属性是只写

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() public method

定义于: yii\base\BaseObject::__isset()

检查属性是否已设置，即已定义且不为空。

不要直接调用此方法，因为它是一个 PHP 魔术方法，将在执行 isset($object->property) 时隐式调用。

请注意，如果未定义属性，将返回 false。

另请参见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称
返回 boolean

指定的属性是否已设置（非空）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

定义于: yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，将在执行 $object->property = $value; 时隐式调用。

另请参见 __get().

public void __set ( $name, $value )
$name string

属性名称或事件名称
$value mixed

属性值
抛出 yii\base\UnknownPropertyException

如果未定义属性
抛出 yii\base\InvalidCallException

如果属性是只读

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

定义于: yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是一个 PHP 魔术方法，将在执行 unset($object->property) 时隐式调用。

请注意，如果未定义属性，此方法将不做任何事情。如果属性是只读，它将抛出异常。

另请参见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name string

属性名称
抛出 yii\base\InvalidCallException

如果属性是只读。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
afterAction() public method

此方法在执行动作后立即调用。

您可以覆盖此方法来对操作进行一些后处理。

public mixed afterAction ( $action, $result )
$action yii\base\Action

刚刚执行的操作。
$result mixed

操作执行结果
返回 mixed

已处理的操作结果。

 

                public function afterAction($action, $result)
{
    return $result;
}
afterFilter() public method

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

                public function afterFilter($event)
{
    $event->result = $this->afterAction($event->action, $event->result);
    $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
attach() public method

将行为对象附加到组件。

默认实现将设置 $owner 属性并按 events() 中声明的附加事件处理程序。如果您覆盖此方法，请确保调用父实现。

public void attach ( $owner )
$owner yii\base\Component

要附加此行为的组件。

 

                public function attach($owner)
{
    $this->owner = $owner;
    $owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
beforeAction() public method

此方法在要执行动作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法以对动作进行最后一分钟的准备。

public boolean beforeAction ( $action )
$action yii\base\Action

要执行的操作。
返回 boolean

操作是否应继续执行。

 

                public function beforeAction($action)
{
    return true;
}
beforeFilter() public method

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

                public function beforeFilter($event)
{
    if (!$this->isActive($event->action)) {
        return;
    }
    $event->isValid = $this->beforeAction($event->action);
    if ($event->isValid) {
        // call afterFilter only if beforeFilter succeeds
        // beforeFilter and afterFilter should be properly nested
        $this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
    } else {
        $event->handled = true;
    }
}
canGetProperty() public method

定义于: yii\base\BaseObject::canGetProperty()

返回一个值，指示是否可以读取属性。

一个属性是可读的，如果

  • 该类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称匹配的成员变量（当 $checkVars 为 true 时）；

另请参见 canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回 boolean

属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

定义于: yii\base\BaseObject::canSetProperty()

返回一个值，指示是否可以设置属性。

一个属性是可写的，如果

  • 该类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称匹配的成员变量（当 $checkVars 为 true 时）；

另请参见 canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回 boolean

属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 中，请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detach() 公共方法

从组件中分离行为对象。

默认实现将取消设置 $owner 属性并分离在 events() 中声明的事件处理程序。如果您重写此方法，请确保调用父实现。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        $this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
        $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
        $this->owner = null;
    }
}
events() 公共方法

定义于: yii\base\Behavior::events()

声明 $owner 的事件的事件处理程序。

子类可以重写此方法来声明应附加到 $owner 组件事件的 PHP 回调函数。

当行为附加到所有者时，回调函数将附加到 $owner 的事件；当行为从组件中分离时，它们将从事件中分离。

回调函数可以是以下任何一种

  • 此行为中的方法：'handleClick'，等效于 [$this, 'handleClick']
  • 对象方法：[$object, 'handleClick']
  • 静态方法：['Page', 'handleClick']
  • 匿名函数：function ($event) { ... }

以下是一个示例

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
返回 array

事件（数组键）和相应的事件处理程序方法（数组值）。

 

                public function events()
{
    return [];
}
getActionId() 受保护方法 (自版本 2.0.7 起可用)

通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回动作 ID。

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

                protected function getActionId($action)
{
    if ($this->owner instanceof Module) {
        $mid = $this->owner->getUniqueId();
        $id = $action->getUniqueId();
        if ($mid !== '' && strpos($id, $mid) === 0) {
            $id = substr($id, strlen($mid) + 1);
        }
    } else {
        $id = $action->id;
    }
    return $id;
}
hasMethod() 公共方法

定义于: yii\base\BaseObject::hasMethod()

返回一个值，指示是否定义了方法。

默认实现是对 php 函数 method_exists() 的调用。当您实现 php 魔术方法 __call() 时，您可以重写此方法。

public boolean hasMethod ( $name )
$name string

方法名称
返回 boolean

该方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定义于: yii\base\BaseObject::hasProperty()

返回一个值，指示是否定义了属性。

如果属性已定义，则

  • 该类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 该类具有与指定名称匹配的成员变量（当 $checkVars 为 true 时）；

另请参阅

public boolean hasProperty ( $name, $checkVars = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
返回 boolean

该属性是否已定义

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

定义于: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束后调用，此时对象已使用给定的配置进行初始化。

public void init ( )

                public function init()
{
}
isActive() 受保护方法

返回一个值，指示过滤器对于给定动作是否处于活动状态。

protected boolean isActive ( $action )
$action yii\base\Action

正在过滤的操作
返回 boolean

过滤器对于给定操作是否处于活动状态。

 

                protected function isActive($action)
{
    $id = $this->getActionId($action);
    if (empty($this->only)) {
        $onlyMatch = true;
    } else {
        $onlyMatch = false;
        foreach ($this->only as $pattern) {
            if (StringHelper::matchWildcard($pattern, $id)) {
                $onlyMatch = true;
                break;
            }
        }
    }
    $exceptMatch = false;
    foreach ($this->except as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            $exceptMatch = true;
            break;
        }
    }
    return !$exceptMatch && $onlyMatch;
}