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 是 action filter 的基礎類別。

Action filter 將通過響應模組和控制器觸發的 beforeAction 和 afterAction 事件，參與 action 執行工作流程。

查看 yii\filters\AccessControl、yii\filters\PageCache 和 yii\filters\HttpCache 的實作範例，以了解如何使用。

有關 ActionFilter 的更多詳細資訊和使用方法，請參閱關於 filter 的指南文章。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$except 陣列 此篩選器不應套用的動作 ID 清單。 yii\base\ActionFilter
$only 陣列 此篩選器應套用的動作 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() 檢查屬性是否已設定，亦即已定義且非 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
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 陣列

方法參數
return mixed

方法傳回值
throws 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 陣列

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

 

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

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

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

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

定義於： 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 mixed afterAction ( $action, $result )
$action yii\base\Action

剛執行的動作。
$result mixed

動作執行結果
return mixed

已處理的動作結果。

 

                public function afterAction($action, $result)
{
    return $result;
}
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() 公共方法

將行為物件附加到元件。

預設實作將會設定 $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 boolean beforeAction ( $action )
$action yii\base\Action

要執行的動作。
return boolean

動作是否應繼續執行。

 

                public function beforeAction($action)
{
    return true;
}
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() 公共方法

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

定義於： 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);
}
className() 公共靜態方法
自 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() 公共方法

從元件卸載行為物件。

預設實作將會取消設定 $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 ( )
return 陣列

事件（陣列鍵）和對應的事件處理常式方法（陣列值）。

 

                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

方法名稱
return 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

是否將成員變數視為屬性
return 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

正在篩選的動作
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;
}