1 追蹤者

抽象類別 yii\filters\auth\AuthMethod

所有類別 | 屬性 | 方法
繼承關係yii\filters\auth\AuthMethod » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
實作yii\base\Configurable, yii\filters\auth\AuthInterface
子類別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/filters/auth/AuthMethod.php

AuthMethod 是一個實作 yii\filters\auth\AuthInterface 介面的基礎類別。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$except 陣列 此篩選器不應套用的動作 ID 清單。 yii\base\ActionFilter
$only 陣列 此篩選器應套用的動作 ID 清單。 yii\base\ActionFilter
$optional 陣列 此篩選器將套用的動作 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() 檢查屬性是否已設定，即已定義且非 null。 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\AuthInterface
beforeAction() 此方法在動作即將執行前（在所有可能的篩選器之後）被調用。您可以覆寫此方法，以便為動作執行最後一刻的準備。 yii\filters\auth\AuthMethod
beforeFilter() yii\base\ActionFilter
canGetProperty() 傳回一個值，指示是否可以讀取屬性。 yii\base\BaseObject
canSetProperty() 傳回一個值，指示是否可以設定屬性。 yii\base\BaseObject
challenge() 在驗證失敗時產生質詢。 yii\filters\auth\AuthMethod
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

屬性詳情

隱藏繼承的屬性

$optional public 屬性 (自版本 2.0.7 起可用)

此篩選器將應用於的動作 ID 列表，但驗證失敗不會導致錯誤。它可以用於允許公眾訪問但為已驗證使用者傳回一些額外資料的動作。預設為空，表示任何動作的驗證都不是選擇性的。自 2.0.10 版本起，動作 ID 可以指定為萬用字元，例如 site/*。

另請參閱 isOptional()。

public array $optional = []
$request public 屬性

目前的請求。如果未設定，將使用 request 應用程式元件。

public yii\web\Request|null $request = null
$response public 屬性

要傳送的回應。如果未設定，將使用 response 應用程式元件。

public yii\web\Response|null $response = null
$user public 屬性

使用者物件，代表使用者驗證狀態。如果未設定，將使用 user 應用程式元件。

public yii\web\User|null $user = null

方法詳情

隱藏繼承的方法

__call() public 方法

定義於： yii\base\BaseObject::__call()

呼叫指定的非類別方法。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當調用未知方法時，它將被隱式呼叫。

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

方法名稱
$params 陣列

方法參數
return mixed

方法傳回值
throws yii\base\UnknownMethodException

當呼叫未知方法時

 

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

定義於： yii\base\BaseObject::__construct()

建構子。

預設實作執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()。

如果此方法在子類別中被覆寫，建議

  • 建構子的最後一個參數是組態陣列，如這裡的 $config。
  • 在建構子的結尾呼叫父類別實作。
public void __construct ( $config = [] )
$config 陣列

將用於初始化物件屬性的名稱-值對

 

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

定義於： yii\base\BaseObject::__get()

傳回物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 $value = $object->property; 時，它將被隱式呼叫。

另請參閱 __set()。

public mixed __get ( $name )
$name string

屬性名稱
return mixed

屬性值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws 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 方法

定義於： yii\base\BaseObject::__isset()

檢查屬性是否已設定，即已定義且非 null。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 isset($object->property) 時，它將被隱式呼叫。

請注意，如果未定義屬性，將傳回 false。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱
return boolean

具名屬性是否已設定（非 null）。

 

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

定義於： yii\base\BaseObject::__set()

設定物件屬性的值。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 $object->property = $value; 時，它將被隱式呼叫。

另請參閱 __get()。

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

屬性名稱或事件名稱
$value mixed

屬性值
throws yii\base\UnknownPropertyException

如果未定義屬性
throws 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 方法

定義於： yii\base\BaseObject::__unset()

將物件屬性設定為 null。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 unset($object->property) 時，它將被隱式呼叫。

請注意，如果未定義屬性，此方法將不執行任何操作。如果屬性為唯讀，它將拋出例外。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php。

public void __unset ( $name )
$name string

屬性名稱
throws 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 方法

定義於： yii\base\ActionFilter::afterAction()

此方法在動作執行後立即調用。

您可以覆寫此方法，以便為動作執行一些後處理。

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

剛執行的動作。
$result mixed

動作執行結果
return mixed

已處理的動作結果。

 

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

定義於： yii\base\ActionFilter::afterFilter()

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 方法

定義於： 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 abstract 方法

定義於： yii\filters\auth\AuthInterface::authenticate()

驗證目前使用者。

public abstract yii\web\IdentityInterface|null authenticate ( $user, $request, $response )
$user yii\web\User
$request yii\web\Request
$response yii\web\Response
return yii\web\IdentityInterface|null

已驗證的使用者身分。如果未提供驗證資訊，將傳回 null。
throws yii\web\UnauthorizedHttpException

如果提供了驗證資訊但無效。

 

                public function authenticate($user, $request, $response);
beforeAction() public 方法

此方法在動作即將執行前（在所有可能的篩選器之後）被調用。您可以覆寫此方法，以便為動作執行最後一刻的準備。

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

要執行的動作。
return boolean

是否應繼續執行動作。

 

                public function beforeAction($action)
{
    $response = $this->response ?: Yii::$app->getResponse();
    try {
        $identity = $this->authenticate(
            $this->user ?: Yii::$app->getUser(),
            $this->request ?: Yii::$app->getRequest(),
            $response
        );
    } catch (UnauthorizedHttpException $e) {
        if ($this->isOptional($action)) {
            return true;
        }
        throw $e;
    }
    if ($identity !== null || $this->isOptional($action)) {
        return true;
    }
    $this->challenge($response);
    $this->handleFailure($response);
    return false;
}
beforeFilter() public 方法

定義於： yii\base\ActionFilter::beforeFilter()

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 方法

定義於： yii\base\BaseObject::canGetProperty()

傳回一個值，指示是否可以讀取屬性。

如果滿足以下條件，則屬性是可讀取的

  • 類別具有與指定名稱關聯的 getter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canSetProperty()。

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否可讀

 

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

定義於： yii\base\BaseObject::canSetProperty()

傳回一個值，指示是否可以設定屬性。

如果滿足以下條件，則屬性是可寫入的

  • 類別具有與指定名稱關聯的 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canGetProperty()。

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否可寫入

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
challenge() public 方法

在驗證失敗時產生質詢。

例如，可能會產生一些適當的 HTTP 標頭。

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

                public function challenge($response)
{
}
className() public static 方法
自 2.0.14 版本起已棄用。在 PHP >=5.5 上，請改用 ::class。

定義於： yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return string

此類別的完整限定名稱。

 

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

定義於： 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() public 方法

定義於： 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 ( )
return 陣列

事件（陣列索引鍵）和對應的事件處理器方法（陣列值）。

 

                public function events()
{
    return [];
}
getActionId() protected 方法 (自版本 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() public 方法

處理驗證失敗。

實作通常應拋出 UnauthorizedHttpException 以指示驗證失敗。

public void handleFailure ( $response )
$response yii\web\Response
throws yii\web\UnauthorizedHttpException 

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

定義於： yii\base\BaseObject::hasMethod()

傳回一個值，指示是否已定義方法。

預設實作是對 php 函式 method_exists() 的呼叫。當您實作了 php 魔術方法 __call() 時，您可以覆寫此方法。

public boolean hasMethod ( $name )
$name string

方法名稱
return boolean

方法是否已定義

 

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

定義於： yii\base\BaseObject::hasProperty()

傳回一個值，指示是否已定義屬性。

如果滿足以下條件，則定義了屬性

  • 類別具有與指定名稱關聯的 getter 或 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱

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

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否已定義

 

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

定義於： yii\base\BaseObject::init()

初始化物件。

在物件使用給定的組態初始化後，此方法在建構子的結尾被調用。

public void init ( )

                public function init()
{
}
isActive() protected 方法

定義於： yii\base\ActionFilter::isActive()

傳回一個值，指示篩選器是否對給定的動作處於活動狀態。

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

正在篩選的動作
return 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() protected 方法 (自版本 2.0.7 起可用)

檢查給定的動作是否為選擇性的驗證。

另請參閱 $optional。

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

要檢查的動作。
return boolean

驗證是否為選擇性的。

 

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