0 关注者

类 yii\filters\auth\CompositeAuth

继承关系yii\filters\auth\CompositeAuth » yii\filters\auth\AuthMethod » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
实现接口yii\base\Configurable, yii\filters\auth\AuthInterface
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/filters/auth/CompositeAuth.php

CompositeAuth 是一个支持同时使用多种身份验证方法的操作过滤器。

CompositeAuth 包含的身份验证方法通过 $authMethods 配置,它是一个支持的身份验证类配置列表。

以下示例展示了如何支持三种身份验证方法

public function behaviors()
{
    return [
        'compositeAuth' => [
            'class' => \yii\filters\auth\CompositeAuth::class,
            'authMethods' => [
                \yii\filters\auth\HttpBasicAuth::class,
                \yii\filters\auth\QueryParamAuth::class,
            ],
        ],
    ];
}

公共属性

隐藏继承的属性

属性 类型 描述 定义位置
$authMethods array 支持的身份验证方法。 yii\filters\auth\CompositeAuth
$except array 此过滤器不应应用于的操作 ID 列表。 yii\base\ActionFilter
$only array 此过滤器应应用于的操作 ID 列表。 yii\base\ActionFilter
$optional array 此过滤器将应用于的操作 ID 列表,但身份验证失败不会导致错误。 yii\filters\auth\AuthMethod
$owner yii\base\Component|null 此行为的拥有者 yii\base\Behavior
$request yii\web\Request|null 当前请求。 yii\filters\auth\AuthMethod
$response yii\web\Response|null 要发送的响应。 yii\filters\auth\AuthMethod
$user yii\web\User|null 表示用户身份验证状态的用户对象。 yii\filters\auth\AuthMethod

公共方法

隐藏继承的方法

方法 描述 定义位置
__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
authenticate() 验证当前用户。 yii\filters\auth\CompositeAuth
beforeAction() 此方法在操作要执行之前立即调用(在所有可能的过滤器之后)。您可以覆盖此方法来对操作进行最后时刻的准备。 yii\filters\auth\CompositeAuth
beforeFilter() yii\base\ActionFilter
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\BaseObject
challenge() 在身份验证失败时生成挑战。 yii\filters\auth\CompositeAuth
className() 返回此类的完全限定名称。 yii\base\BaseObject
detach() 从组件中分离行为对象。 yii\base\ActionFilter
events() 声明 $owner 事件的事件处理程序。 yii\base\Behavior
handleFailure() 处理身份验证失败。 yii\filters\auth\AuthMethod
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
isOptional() 检查对于给定操作身份验证是否为可选的。 yii\filters\auth\AuthMethod

属性详细信息

隐藏继承的属性

$authMethods 公共属性

支持的身份验证方法。此属性应采用支持的身份验证方法列表,每个方法由身份验证类或配置表示。

如果此属性为空,则不会执行身份验证。

请注意,身份验证方法类必须实现 yii\filters\auth\AuthInterface 接口。

public array $authMethods = []

方法详细信息

隐藏继承的方法

__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

命名的属性是否已设置(非 null)。

                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

定义于: yii\base\ActionFilter::afterAction()

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

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

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

定义于: yii\base\ActionFilter::attach()

将行为对象附加到组件。

默认实现将设置 $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']);
}

            
authenticate() public method

验证当前用户。

public yii\web\IdentityInterface|null authenticate ( $user, $request, $response )
$user yii\web\User
$request yii\web\Request
$response yii\web\Response
返回值 yii\web\IdentityInterface|null

经过身份验证的用户身份。如果没有提供身份验证信息,将返回 null。

抛出异常 yii\web\UnauthorizedHttpException

如果提供了身份验证信息,但无效。

                public function authenticate($user, $request, $response)
{
    foreach ($this->authMethods as $i => $auth) {
        if (!$auth instanceof AuthInterface) {
            $this->authMethods[$i] = $auth = Yii::createObject($auth);
            if (!$auth instanceof AuthInterface) {
                throw new InvalidConfigException(get_class($auth) . ' must implement yii\filters\auth\AuthInterface');
            }
        }
        if (
            $this->owner instanceof Controller
            && (
                !isset($this->owner->action)
                || (
                    $auth instanceof ActionFilter
                    && !$auth->isActive($this->owner->action)
                )
            )
        ) {
            continue;
        }
        $identity = $auth->authenticate($user, $request, $response);
        if ($identity !== null) {
            return $identity;
        }
    }
    return null;
}

            
beforeAction() public method

此方法在操作要执行之前立即调用(在所有可能的过滤器之后)。您可以覆盖此方法来对操作进行最后时刻的准备。

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

要执行的动作。

返回值 boolean

动作是否应该继续执行。

                public function beforeAction($action)
{
    return empty($this->authMethods) ? true : parent::beforeAction($action);
}

            
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() 公共方法

定义于: 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);
}

            
challenge() 公共方法

在身份验证失败时生成挑战。

例如,可能会生成一些适当的 HTTP 标头。

public void challenge ( $response )
$response yii\web\Response

                public function challenge($response)
{
    foreach ($this->authMethods as $method) {
        /** @var AuthInterface $method */
        $method->challenge($response);
    }
}

            
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() 公共方法

定义于: yii\base\ActionFilter::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 事件的事件处理程序。

子类可以覆盖此方法来声明应将哪些 PHP 回调附加到 $owner 组件的事件。

当行为附加到所有者时,回调将附加到 $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\ActionFilter::getActionId()

通过将 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;
}

            
handleFailure() 公共方法

定义于: yii\filters\auth\AuthMethod::handleFailure()

处理身份验证失败。

实现通常应抛出 UnauthorizedHttpException 以指示身份验证失败。

public void handleFailure ( $response )
$response yii\web\Response
抛出异常 yii\web\UnauthorizedHttpException

                public function handleFailure($response)
{
    throw new UnauthorizedHttpException('Your request was made with invalid credentials.');
}

            
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() 受保护方法

定义于: yii\base\ActionFilter::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;
}

            
isOptional() 受保护方法(从 2.0.7 版开始可用)

定义于: yii\filters\auth\AuthMethod::isOptional()

检查对于给定操作身份验证是否为可选的。

另请参见 $optional.

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

要检查的操作。

返回值 boolean

身份验证是可选的还是必需的。

                protected function isOptional($action)
{
    $id = $this->getActionId($action);
    foreach ($this->optional as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            return true;
        }
    }
    return false;
}