0 追蹤者

抽象類別 yii\rbac\Rule

所有類別 | 屬性 | 方法
繼承yii\rbac\Rule » yii\base\BaseObject
實作yii\base\Configurable
適用版本2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/rbac/Rule.php

Rule 代表一個業務約束，可能與角色、權限或指派相關。

關於 Rule 的更多詳細資訊和用法，請參閱安全授權指南文章。

公開屬性

隱藏繼承屬性

屬性 類型 說明 定義於
$createdAt 整數 表示規則建立時間的 UNIX 時間戳記 yii\rbac\Rule
$name 字串 規則名稱 yii\rbac\Rule
$updatedAt 整數 表示規則更新時間的 UNIX 時間戳記 yii\rbac\Rule

公開方法

隱藏繼承方法

方法 說明 定義於
__call() 呼叫指定的非類別方法。 yii\base\BaseObject
__construct() 建構函式。 yii\base\BaseObject
__get() 傳回物件屬性值。 yii\base\BaseObject
__isset() 檢查屬性是否已設定 (已定義且非空值)。 yii\base\BaseObject
__set() 設定物件屬性值。 yii\base\BaseObject
__unset() 將物件屬性設為空值。 yii\base\BaseObject
canGetProperty() 傳回值以指示屬性是否可讀。 yii\base\BaseObject
canSetProperty() 傳回值以指示屬性是否可設定。 yii\base\BaseObject
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
execute() 執行此規則。 yii\rbac\Rule
hasMethod() 傳回值以指示方法是否已定義。 yii\base\BaseObject
hasProperty() 傳回值以指示屬性是否已定義。 yii\base\BaseObject
init() 初始化此物件。 yii\base\BaseObject

屬性詳細資訊

隱藏繼承屬性

$createdAt 公開屬性

表示規則建立時間的 UNIX 時間戳記

public integer $createdAt = null
$name 公開屬性

規則名稱

public string $name = null
$updatedAt 公開屬性

表示規則更新時間的 UNIX 時間戳記

public integer $updatedAt = null

方法詳細資訊

隱藏繼承方法

__call() 公開方法

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

呼叫指定的非類別方法。

請勿直接呼叫此方法，因為這是 PHP 的魔術方法，會在呼叫未知方法時隱含地被呼叫。

public mixed __call ( $name, $params )
$name 字串

方法名稱
$params 陣列

方法參數
傳回 混合型別

方法傳回值
拋出 yii\base\UnknownMethodException

當呼叫不明方法時

 

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

定義於： 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 method

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

傳回物件屬性值。

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

另請參閱 __set()。

public mixed __get ( $name )
$name 字串

屬性名稱
傳回 混合型別

屬性值
拋出 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.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name 字串

屬性名稱或事件名稱
傳回 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 字串

屬性名稱或事件名稱
$value 混合型別

屬性值
拋出 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()

將物件屬性設為空值。

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

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

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

public void __unset ( $name )
$name 字串

屬性名稱
拋出 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);
    }
}
canGetProperty() public method

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

傳回值以指示屬性是否可讀。

如果符合以下條件，屬性為可讀的

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

另請參閱 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$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 字串

屬性名稱
$checkVars boolean

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

屬性是否可以被寫入

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
自 2.0.14 版本起已過時。 在 PHP >=5.5 上，請改用 ::class。

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

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

public static string className ( )
傳回 字串

這個類別的完整限定名稱。

 

                public static function className()
{
    return get_called_class();
}
execute() public abstract method

執行此規則。

public abstract boolean execute ( $user, $item, $params )
$user string|integer

使用者 ID。 這應該是代表使用者唯一識別碼的整數或字串。 請參閱 yii\web\User::$id。
$item yii\rbac\Item

與此規則關聯的角色或權限
$params 陣列

傳遞給 yii\rbac\CheckAccessInterface::checkAccess() 的參數。
傳回 boolean

一個值，指示規則是否允許與其關聯的授權項目。

 

                abstract public function execute($user, $item, $params);
hasMethod() public method

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

傳回值以指示方法是否已定義。

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

public boolean hasMethod ( $name )
$name 字串

方法名稱
傳回 boolean

方法是否已定義

 

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

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

傳回值以指示屬性是否已定義。

如果符合以下條件，則定義了屬性

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

另請參閱

public boolean hasProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars boolean

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

屬性是否已定義

 

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

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

初始化此物件。

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

public void init ( )

                public function init()
{
}