0 追蹤者

類別 yii\filters\AccessRule

繼承關係yii\filters\AccessRule » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable
起始版本2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/filters/AccessRule.php

此類別代表由 yii\filters\AccessControl 行動過濾器定義的存取規則。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$actions array|null 此規則適用的行動 ID 清單。 yii\filters\AccessRule
$allow boolean 判斷此為「允許」規則或「拒絕」規則。 yii\filters\AccessRule
$behaviors yii\base\Behavior[] 附加到此元件的行為清單。 yii\base\Component
$controllers array|null 此規則適用的控制器 ID 清單。 yii\filters\AccessRule
$denyCallback callable|null 當此規則判定應拒絕存取目前行動時,將會呼叫的回呼函數。 yii\filters\AccessRule
$ips array|null 此規則適用的使用者 IP 位址清單。 yii\filters\AccessRule
$matchCallback callable 將被呼叫以判斷是否應套用此規則的回呼函數。 yii\filters\AccessRule
$permissions array|null 此規則適用的 RBAC(基於角色的存取控制)權限清單。 yii\filters\AccessRule
$roleParams array|Closure 傳遞給 yii\web\User::can() 函數的參數,用於評估 $roles 中的使用者權限。 yii\filters\AccessRule
$roles array|null 此規則適用的角色清單(需要正確設定 User 元件)。 yii\filters\AccessRule
$verbs array|null 此規則適用的請求方法清單(例如 GETPOST)。 yii\filters\AccessRule

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫指定的非類別方法。 yii\base\Component
__clone() 在物件透過複製現有物件建立後,會呼叫此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回元件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,即已定義且非 null。 yii\base\Component
__set() 設定元件屬性的值。 yii\base\Component
__unset() 將元件屬性設定為 null。 yii\base\Component
allows() 檢查 Web 使用者是否被允許執行指定的行動。 yii\filters\AccessRule
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為清單附加到此元件。 yii\base\Component
behaviors() 傳回此元件應表現為的行為清單。 yii\base\Component
canGetProperty() 傳回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 傳回一個值,指示是否可以設定屬性。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從元件分離行為。 yii\base\Component
detachBehaviors() 從元件分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
getBehavior() 傳回指定的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為。 yii\base\Component
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理器。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此元件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\base\BaseObject
off() 從此元件分離現有的事件處理器。 yii\base\Component
on() 將事件處理器附加到事件。 yii\base\Component
trigger() 觸發事件。 yii\base\Component

屬性詳細資訊

隱藏繼承的屬性

$actions 公開屬性

此規則適用的動作 ID 清單。 比較區分大小寫。 若未設定或為空,則表示此規則適用於所有動作。

public array|null $actions null
$allow 公開屬性

判斷此為「允許」規則或「拒絕」規則。

public boolean $allow false
$controllers 公開屬性

此規則適用的控制器 ID 清單。

比較使用 yii\base\Controller::$uniqueId,因此每個控制器 ID 都會加上模組 ID 作為前綴(如果有的話)。 對於應用程式中的 product 控制器,您會像 ['product'] 這樣指定此屬性,如果該控制器位於 shop 模組中,則會是 ['shop/product']

比較區分大小寫。

若未設定或為空,則表示此規則適用於所有控制器。

自 2.0.12 版本起,控制器 ID 可以指定為萬用字元,例如 module/*

public array|null $controllers null
$denyCallback 公開屬性

如果此規則判斷應拒絕存取目前動作,則將呼叫的回呼。 當此規則符合且 $allow 設定為 false 時,就會發生這種情況。

若未設定,行為將由 yii\filters\AccessControl 決定,使用 yii\filters\AccessControl::denyAccess()yii\filters\AccessControl::$denyCallback(如果已設定)。

回呼的簽章應如下所示

function ($rule, $action)

其中 $rule 是此規則,而 $action 是目前的 action 物件。

另請參閱 yii\filters\AccessControl::$denyCallback

public callable|null $denyCallback null
$ips 公開屬性

此規則適用的使用者 IP 位址清單。 IP 位址的結尾可以包含萬用字元 *,以便符合具有相同前綴的 IP 位址。 例如,'192.168.*' 符合區段 '192.168.' 中的所有 IP 位址。 它也可能包含類似 '172.16.0.0/12' 的模式/遮罩,這將符合 RFC1918 中 20 位元私有網路區塊中的所有 IP。 若未設定或為空,則表示此規則適用於所有 IP 位址。

另請參閱

public array|null $ips null
$matchCallback 公開屬性

將呼叫回呼以判斷是否應套用規則。 回呼的簽章應如下所示

function ($rule, $action)

其中 $rule 是此規則,而 $action 是目前的 action 物件。 回呼應傳回布林值,指示是否應套用此規則。

public callable $matchCallback null
$permissions 公開屬性 (自 2.0.12 版本起可用)

此規則適用的 RBAC(角色基礎存取控制)權限清單。 將呼叫 yii\web\User::can() 以檢查存取權。

若未設定或為空,則表示此規則適用於所有權限。

另請參閱

public array|null $permissions null
$roleParams 公開屬性 (自 2.0.12 版本起可用)

傳遞給 yii\web\User::can() 函數的參數,用於評估 $roles 中的使用者權限。

如果這是一個陣列,它將直接傳遞至 yii\web\User::can()。 例如,為了從目前的請求傳遞 ID,您可以使用以下程式碼

['postId' => Yii::$app->request->get('id')]

您也可以指定傳回陣列的閉包。 這可以用於僅在需要時評估陣列值,例如當需要載入模型時,如下列程式碼所示

'rules' => [
    [
        'allow' => true,
        'actions' => ['update'],
        'roles' => ['updatePost'],
        'roleParams' => function($rule) {
            return ['post' => Post::findOne(Yii::$app->request->get('id'))];
        },
    ],
],

yii\filters\AccessRule 實例的參考將作為第一個參數傳遞給閉包。

另請參閱 $roles

$roles 公開屬性

此規則適用的角色清單(需要正確設定的使用者元件)。 辨識出兩個特殊角色,並透過 yii\web\User::$isGuest 檢查它們

  • ?:符合訪客使用者(尚未驗證身分)
  • @:符合已驗證身分的使用者

如果您使用 RBAC(角色基礎存取控制),您也可以指定角色名稱。 在這種情況下,將呼叫 yii\web\User::can() 以檢查存取權。

請注意,最好檢查權限而不是角色。

若未設定或為空,則表示此規則適用於所有角色。

另請參閱

public array|null $roles null
$verbs 公開屬性

此規則適用的請求方法清單(例如 GETPOST)。 若未設定或為空,則表示此規則適用於所有請求方法。

另請參閱 yii\web\Request::$method

public array|null $verbs null

方法詳細資訊

隱藏繼承的方法

__call() 公開方法

定義於: yii\base\Component::__call()

呼叫指定的非類別方法。

此方法將檢查是否有任何附加的行為具有指定的名稱方法,並在可用時執行它。

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

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

方法名稱

$params array

方法參數

return mixed

方法傳回值

throws yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公開方法

定義於: yii\base\Component::__clone()

在物件透過複製現有物件建立後,會呼叫此方法。

它會移除所有行為,因為它們附加到舊物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

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

定義於: yii\base\Component::__get()

傳回元件屬性的值。

此方法將依以下順序檢查並採取相應措施

  • 由 getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 $value = $component->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)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (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\Component::__isset()

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

此方法將依以下順序檢查並採取相應措施

  • 由 setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 對於不存在的屬性傳回 false

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

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return boolean

具名屬性是否已設定

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公開方法

定義於: yii\base\Component::__set()

設定元件屬性的值。

此方法將依以下順序檢查並採取相應措施

  • 由 setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 $component->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)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公開方法

定義於: yii\base\Component::__unset()

將元件屬性設定為 null。

此方法將依以下順序檢查並採取相應措施

  • 由 setter 定義的屬性:將屬性值設定為空值
  • 行為的屬性:將屬性值設定為空值

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 unset($component->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);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
allows() 公開方法

檢查 Web 使用者是否被允許執行指定的行動。

public boolean|null allows ( $action, $user, $request )
$action yii\base\Action

要執行的動作

$user yii\web\User|false

使用者物件或 false(如果 User 元件已分離)

$request yii\web\Request
return boolean|null

true 如果允許使用者,false 如果拒絕使用者,null 如果規則不適用於使用者

                public function allows($action, $user, $request)
{
    if (
        $this->matchAction($action)
        && $this->matchRole($user)
        && $this->matchIP($request->getUserIP())
        && $this->matchVerb($request->getMethod())
        && $this->matchController($action->controller)
        && $this->matchCustom($action)
    ) {
        return $this->allow ? true : false;
    }
    return null;
}

            
attachBehavior() 公開方法

定義於: yii\base\Component::attachBehavior()

將行為附加到此元件。

此方法將根據給定的設定建立行為物件。 之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為的名稱。

$behavior string|array|yii\base\Behavior

行為設定。 這可以是下列其中一項

return yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公開方法

定義於: yii\base\Component::attachBehaviors()

將行為清單附加到此元件。

每個行為都以其名稱索引,並且應該是 yii\base\Behavior 物件、指定行為類別的字串,或是用於建立行為的設定陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到元件的行為清單

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() 公開方法

定義於: yii\base\Component::behaviors()

傳回此元件應表現為的行為清單。

子類別可以覆寫此方法,以指定他們想要表現為的行為。

此方法的傳回值應該是以行為名稱索引的行為物件或設定陣列。 行為設定可以是指定行為類別的字串,或是以下結構的陣列

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意,行為類別必須繼承自 yii\base\Behavior。 行為可以使用名稱或匿名方式附加。 當使用名稱作為陣列索引鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。 匿名行為無法檢索或分離。

在此方法中宣告的行為將自動(按需)附加到元件。

public array behaviors ( )
return array

行為設定。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公開方法

定義於: yii\base\Component::canGetProperty()

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

如果符合以下條件,則可以讀取屬性

  • 類別具有與指定名稱關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否可以讀取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公開方法

定義於: yii\base\Component::canSetProperty()

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

如果符合以下條件,則可以寫入屬性

  • 類別具有與指定名稱關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否可以寫入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
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();
}

            
detachBehavior() 公開方法

定義於: yii\base\Component::detachBehavior()

從元件分離行為。

將調用行為的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為的名稱。

return yii\base\Behavior|null

分離的行為。 如果行為不存在,則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公開方法

定義於: yii\base\Component::detachBehaviors()

從元件分離所有行為。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public 方法

定義於: yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的行為已附加到此元件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() public 方法

定義於: yii\base\Component::getBehavior()

傳回指定的行為物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為名稱

return yii\base\Behavior|null

行為物件,如果行為不存在則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public 方法

定義於: yii\base\Component::getBehaviors()

傳回附加到此元件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此組件的行為列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
hasEventHandlers() public 方法

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有名稱事件附加任何處理器。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

是否有任何處理器附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public 方法

定義於: yii\base\Component::hasMethod()

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

如果滿足以下條件,則定義方法

  • 類別具有指定名稱的方法
  • $checkBehaviors 為 true 時,附加的行為具有給定名稱的方法。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors boolean

是否將行為的方法視為此組件的方法

return boolean

方法是否已定義

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public 方法

定義於: yii\base\Component::hasProperty()

傳回一個值,指示是否為此元件定義了屬性。

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

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • $checkBehaviors 為 true 時,附加的行為具有給定名稱的屬性。

另請參閱

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否已定義

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

            
init() public 方法

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

初始化物件。

在以給定配置初始化物件後,此方法會在建構函式的結尾被調用。

public void init ( )

                public function init()
{
}

            
matchAction() protected 方法

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

動作

return boolean

規則是否適用於動作

                protected function matchAction($action)
{
    return empty($this->actions) || in_array($action->id, $this->actions, true);
}

            
matchController() protected 方法

protected boolean matchController ( $controller )
$controller yii\base\Controller

控制器

return boolean

規則是否適用於控制器

                protected function matchController($controller)
{
    if (empty($this->controllers)) {
        return true;
    }
    $id = $controller->getUniqueId();
    foreach ($this->controllers as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            return true;
        }
    }
    return false;
}

            
matchCustom() protected 方法

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

要執行的動作

return boolean

是否應套用規則

                protected function matchCustom($action)
{
    return empty($this->matchCallback) || call_user_func($this->matchCallback, $this, $action);
}

            
matchIP() protected 方法

protected boolean matchIP ( $ip )
$ip string|null

IP 位址

return boolean

規則是否適用於 IP 位址

                protected function matchIP($ip)
{
    if (empty($this->ips)) {
        return true;
    }
    foreach ($this->ips as $rule) {
        if (
            $rule === '*'
            || $rule === $ip
            || (
                $ip !== null
                && ($pos = strpos($rule, '*')) !== false
                && strncmp($ip, $rule, $pos) === 0
            )
            || (
                strpos($rule, '/') !== false
                && IpHelper::inRange($ip, $rule) === true
            )
        ) {
            return true;
        }
    }
    return false;
}

            
matchRole() protected 方法

protected boolean matchRole ( $user )
$user yii\web\User

使用者物件

return boolean

規則是否適用於角色

throws yii\base\InvalidConfigException

如果 User 組件已分離

                protected function matchRole($user)
{
    $items = empty($this->roles) ? [] : $this->roles;
    if (!empty($this->permissions)) {
        $items = array_merge($items, $this->permissions);
    }
    if (empty($items)) {
        return true;
    }
    if ($user === false) {
        throw new InvalidConfigException('The user application component must be available to specify roles in AccessRule.');
    }
    foreach ($items as $item) {
        if ($item === '?') {
            if ($user->getIsGuest()) {
                return true;
            }
        } elseif ($item === '@') {
            if (!$user->getIsGuest()) {
                return true;
            }
        } else {
            if (!isset($roleParams)) {
                $roleParams = !is_array($this->roleParams) && is_callable($this->roleParams) ? call_user_func($this->roleParams, $this) : $this->roleParams;
            }
            if ($user->can($item, $roleParams)) {
                return true;
            }
        }
    }
    return false;
}

            
matchVerb() protected 方法

protected boolean matchVerb ( $verb )
$verb string

請求方法。

return boolean

規則是否適用於請求

                protected function matchVerb($verb)
{
    return empty($this->verbs) || in_array(strtoupper($verb), array_map('strtoupper', $this->verbs), true);
}

            
off() public 方法

定義於: yii\base\Component::off()

從此元件分離現有的事件處理器。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理器,而使用與此萬用字元匹配的純名稱註冊的處理器將會保留。

另請參閱 on()

public boolean off ( $name, $handler null )
$name string

事件名稱

$handler callable|null

要移除的事件處理器。 如果為 null,則會移除附加到具名事件的所有處理器。

return boolean

如果找到並分離處理器

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public 方法

定義於: yii\base\Component::on()

將事件處理器附加到事件。

事件處理器必須是有效的 PHP 回呼。 以下是一些範例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理器必須使用以下簽章定義,

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件相關聯的參數。

自 2.0.14 版起,您可以將事件名稱指定為萬用字元模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名稱

$handler callable

事件處理器

$data mixed

當事件被觸發時,要傳遞給事件處理器的資料。 當調用事件處理器時,可以通過 yii\base\Event::$data 訪問此資料。

$append boolean

是否將新的事件處理器附加到現有處理器列表的末尾。 如果為 false,則新的處理器將插入到現有處理器列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
trigger() public 方法

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。 它會調用事件的所有附加處理器,包括類別級處理器。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名稱

$event yii\base\Event|null

事件實例。 如果未設定,將會建立預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}