抽象類別 yii\rbac\BaseManager
BaseManager 是一個基礎類別,為 RBAC 管理實作了 yii\rbac\ManagerInterface。
關於 DbManager 的更多細節和使用資訊,請參閱關於安全授權的指南文章。
公有屬性
屬性 | 類型 | 描述 | 定義於 |
---|---|---|---|
$behaviors | yii\base\Behavior[] | 附加到此組件的行為列表。 | yii\base\Component |
$defaultRoleInstances | yii\rbac\Role[] | 預設角色。 | yii\rbac\BaseManager |
$defaultRoles | array | 一個角色名稱列表,這些角色會自動分配給每個使用者,而無需呼叫 assign()。 | yii\rbac\BaseManager |
$permissions | yii\rbac\Permission[] | 系統中的所有權限。 | yii\rbac\BaseManager |
$roles | yii\rbac\Role[] | 系統中的所有角色。 | yii\rbac\BaseManager |
$rules | yii\rbac\Rule[] | 以規則名稱索引的規則 | yii\rbac\ManagerInterface |
公有方法
受保護的方法
方法 | 描述 | 定義於 |
---|---|---|
addItem() | 將授權項目新增到 RBAC 系統。 | yii\rbac\BaseManager |
addRule() | 將規則新增到 RBAC 系統。 | yii\rbac\BaseManager |
executeRule() | 執行與指定授權項目相關聯的規則。 | yii\rbac\BaseManager |
getItem() | 傳回指定名稱的授權項目。 | yii\rbac\BaseManager |
getItems() | 傳回指定類型的項目。 | yii\rbac\BaseManager |
hasNoAssignments() | 檢查 $assignments 陣列是否為空,以及 $defaultRoles 屬性是否也為空。 | yii\rbac\BaseManager |
removeItem() | 從 RBAC 系統中移除授權項目。 | yii\rbac\BaseManager |
removeRule() | 從 RBAC 系統中移除規則。 | yii\rbac\BaseManager |
updateItem() | 更新 RBAC 系統中的授權項目。 | yii\rbac\BaseManager |
updateRule() | 更新 RBAC 系統中的規則。 | yii\rbac\BaseManager |
屬性詳細資訊
自動指派給每個使用者的角色名稱列表,無需呼叫 assign()。請注意,無論使用者的驗證狀態如何,這些角色都會應用於使用者。
方法詳細資訊
定義於: 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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定義於: 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();
}
定義於: 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);
}
定義於: yii\base\Component::__isset()
檢查屬性是否已設定,即已定義且非 null。
此方法將依下列順序檢查並採取相應行動
- setter 定義的屬性:傳回屬性是否已設定
- 行為的屬性:傳回屬性是否已設定
- 針對不存在的屬性傳回
false
請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 isset($component->property)
時會隱式呼叫它。
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;
}
定義於: 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);
}
定義於: yii\base\Component::__unset()
將組件屬性設定為 null。
此方法將依下列順序檢查並採取相應行動
- setter 定義的屬性:將屬性值設定為 null
- 行為的屬性:將屬性值設定為 null
請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 unset($component->property)
時會隱式呼叫它。
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);
}
將角色、權限或規則新增到 RBAC 系統。
public boolean add ( $object ) | ||
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule | |
return | boolean |
角色、權限或規則是否成功新增到系統 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如角色或權限的名稱不唯一) |
public function add($object)
{
if ($object instanceof Item) {
if ($object->ruleName && $this->getRule($object->ruleName) === null) {
$rule = \Yii::createObject($object->ruleName);
$rule->name = $object->ruleName;
$this->addRule($rule);
}
return $this->addItem($object);
} elseif ($object instanceof Rule) {
return $this->addRule($object);
}
throw new InvalidArgumentException('Adding unsupported object type.');
}
定義於: yii\rbac\ManagerInterface::addChild()
將一個項目新增為另一個項目的子項目。
public abstract boolean addChild ( $parent, $child ) | ||
$parent | yii\rbac\Item | |
$child | yii\rbac\Item | |
return | boolean |
子項目是否成功新增 |
---|---|---|
throws | yii\base\Exception |
如果父子關係已存在,或偵測到迴圈。 |
public function addChild($parent, $child);
將授權項目新增到 RBAC 系統。
protected abstract boolean addItem ( $item ) | ||
$item | yii\rbac\Item |
要新增的項目 |
return | boolean |
授權項目是否成功新增到系統 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如角色或權限的名稱不唯一) |
abstract protected function addItem($item);
將規則新增到 RBAC 系統。
protected abstract boolean addRule ( $rule ) | ||
$rule | yii\rbac\Rule |
要新增的規則 |
return | boolean |
規則是否成功新增到系統 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如規則的名稱不唯一) |
abstract protected function addRule($rule);
定義於: yii\rbac\ManagerInterface::assign()
將角色指派給使用者。
public abstract yii\rbac\Assignment assign ( $role, $userId ) | ||
$role | yii\rbac\Role|yii\rbac\Permission | |
$userId | string|integer |
使用者 ID(請參閱 yii\web\User::$id) |
return | yii\rbac\Assignment |
角色指派資訊。 |
---|---|---|
throws | Exception |
如果角色已指派給使用者 |
public function assign($role, $userId);
定義於: 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);
}
定義於: 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);
}
}
定義於: 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 [];
}
定義於: yii\rbac\ManagerInterface::canAddChild()
檢查是否可以將子項目新增到父項目。
public abstract boolean canAddChild ( $parent, $child ) | ||
$parent | yii\rbac\Item |
父項目 |
$child | yii\rbac\Item |
要新增到階層結構的子項目 |
return | boolean |
新增的可能性 |
---|
public function canAddChild($parent, $child);
定義於: 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;
}
定義於: 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;
}
::class
。
定義於: yii\base\BaseObject::className()
傳回此類別的完整限定名稱。
public static string className ( ) | ||
return | string |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
建立新的 Permission 物件。
請注意,新建立的權限尚未新增到 RBAC 系統。您必須填寫所需的資料並呼叫 add() 以將其新增到系統。
public yii\rbac\Permission createPermission ( $name ) | ||
$name | string |
權限名稱 |
return | yii\rbac\Permission |
新的權限物件 |
---|
public function createPermission($name)
{
$permission = new Permission();
$permission->name = $name;
return $permission;
}
建立新的 Role 物件。
請注意,新建立的角色尚未加入 RBAC 系統。您必須填寫需要的資料並呼叫 add() 以將其加入系統。
public yii\rbac\Role createRole ( $name ) | ||
$name | string |
角色名稱 |
return | yii\rbac\Role |
新的角色物件 |
---|
public function createRole($name)
{
$role = new Role();
$role->name = $name;
return $role;
}
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;
}
定義於: yii\base\Component::detachBehaviors()
從組件中分離所有行為。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定義於: 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);
}
}
}
執行與指定授權項目相關聯的規則。
如果項目未指定規則,此方法將傳回 true。否則,它將傳回 yii\rbac\Rule::execute() 的值。
protected boolean executeRule ( $user, $item, $params ) | ||
$user | string|integer |
使用者 ID。這應該是代表使用者唯一識別碼的整數或字串。請參閱 yii\web\User::$id。 |
$item | yii\rbac\Item |
需要執行其規則的授權項目 |
$params | array |
傳遞至 yii\rbac\CheckAccessInterface::checkAccess() 並將傳遞至規則的參數 |
return | boolean |
yii\rbac\Rule::execute() 的傳回值。如果授權項目未指定規則,則會傳回 true。 |
---|---|---|
throws | yii\base\InvalidConfigException |
如果授權項目有不合法的規則。 |
protected function executeRule($user, $item, $params)
{
if ($item->ruleName === null) {
return true;
}
$rule = $this->getRule($item->ruleName);
if ($rule instanceof Rule) {
return $rule->execute($user, $item, $params);
}
throw new InvalidConfigException("Rule not found: {$item->ruleName}");
}
定義於: yii\rbac\ManagerInterface::getAssignment()
傳回關於角色和使用者的指派資訊。
public abstract yii\rbac\Assignment|null getAssignment ( $roleName, $userId ) | ||
$roleName | string |
角色名稱 |
$userId | string|integer |
使用者 ID(請參閱 yii\web\User::$id) |
return | yii\rbac\Assignment|null |
指派資訊。如果角色未指派給使用者,則傳回 Null。 |
---|
public function getAssignment($roleName, $userId);
定義於: yii\rbac\ManagerInterface::getAssignments()
傳回指定使用者的所有角色指派資訊。
public abstract yii\rbac\Assignment[] getAssignments ( $userId ) | ||
$userId | string|integer |
使用者 ID(請參閱 yii\web\User::$id) |
return | yii\rbac\Assignment[] |
依角色名稱索引的指派。如果沒有角色指派給使用者,則會傳回空陣列。 |
---|
public function getAssignments($userId);
定義於: 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;
}
定義於: yii\base\Component::getBehaviors()
傳回附加到此組件的所有行為。
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
附加到此元件的行為列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定義於: yii\rbac\ManagerInterface::getChildRoles()
傳回指定角色的子角色。深度不受限制。
public abstract yii\rbac\Role[] getChildRoles ( $roleName ) | ||
$roleName | string |
要尋找子角色的角色名稱 |
return | yii\rbac\Role[] |
子角色。陣列以角色名稱索引。第一個元素是父角色本身的實例。 |
---|---|---|
throws | yii\base\InvalidParamException |
如果找不到依 $roleName 取得的角色 |
public function getChildRoles($roleName);
定義於: yii\rbac\ManagerInterface::getChildren()
傳回子權限和/或角色。
public abstract yii\rbac\Item[] getChildren ( $name ) | ||
$name | string |
父名稱 |
return | yii\rbac\Item[] |
子權限和/或角色 |
---|
public function getChildren($name);
以 Role 物件陣列形式傳回 defaultRoles。
public yii\rbac\Role[] getDefaultRoleInstances ( ) | ||
return | yii\rbac\Role[] |
預設角色。陣列以角色名稱索引 |
---|
public function getDefaultRoleInstances()
{
$result = [];
foreach ($this->defaultRoles as $roleName) {
$result[$roleName] = $this->createRole($roleName);
}
return $result;
}
取得預設角色
public string[] getDefaultRoles ( ) | ||
return | string[] |
預設角色 |
---|
public function getDefaultRoles()
{
return $this->defaultRoles;
}
傳回指定名稱的授權項目。
protected abstract yii\rbac\Item|null getItem ( $name ) | ||
$name | string |
授權項目名稱。 |
return | yii\rbac\Item|null |
對應到指定名稱的授權項目。如果沒有此項目則傳回 Null。 |
---|
abstract protected function getItem($name);
傳回指定類型的項目。
protected abstract yii\rbac\Item[] getItems ( $type ) | ||
$type | integer |
授權項目類型(yii\rbac\Item::TYPE_ROLE 或 yii\rbac\Item::TYPE_PERMISSION) |
return | yii\rbac\Item[] |
指定類型的授權項目。 |
---|
abstract protected function getItems($type);
傳回指定的權限。
public yii\rbac\Permission|null getPermission ( $name ) | ||
$name | string |
權限名稱。 |
return | yii\rbac\Permission|null |
對應到指定名稱的權限。如果沒有此權限則傳回 Null。 |
---|
public function getPermission($name)
{
$item = $this->getItem($name);
return $item instanceof Item && $item->type == Item::TYPE_PERMISSION ? $item : null;
}
傳回系統中的所有權限。
public yii\rbac\Permission[] getPermissions ( ) | ||
return | yii\rbac\Permission[] |
系統中的所有權限。陣列以權限名稱索引。 |
---|
public function getPermissions()
{
return $this->getItems(Item::TYPE_PERMISSION);
}
定義於: yii\rbac\ManagerInterface::getPermissionsByRole()
傳回指定角色代表的所有權限。
public abstract yii\rbac\Permission[] getPermissionsByRole ( $roleName ) | ||
$roleName | string |
角色名稱 |
return | yii\rbac\Permission[] |
角色代表的所有權限。陣列以權限名稱索引。 |
---|
public function getPermissionsByRole($roleName);
定義於: yii\rbac\ManagerInterface::getPermissionsByUser()
傳回使用者擁有的所有權限。
public abstract yii\rbac\Permission[] getPermissionsByUser ( $userId ) | ||
$userId | string|integer |
使用者 ID(請參閱 yii\web\User::$id) |
return | yii\rbac\Permission[] |
使用者擁有的所有權限。陣列以權限名稱索引。 |
---|
public function getPermissionsByUser($userId);
傳回指定的角色。
public yii\rbac\Role|null getRole ( $name ) | ||
$name | string |
角色名稱。 |
return | yii\rbac\Role|null |
對應到指定名稱的角色。如果沒有此角色則傳回 Null。 |
---|
public function getRole($name)
{
$item = $this->getItem($name);
return $item instanceof Item && $item->type == Item::TYPE_ROLE ? $item : null;
}
傳回系統中的所有角色。
public yii\rbac\Role[] getRoles ( ) | ||
return | yii\rbac\Role[] |
系統中的所有角色。陣列以角色名稱索引。 |
---|
public function getRoles()
{
return $this->getItems(Item::TYPE_ROLE);
}
public abstract yii\rbac\Role[] getRolesByUser ( $userId ) | ||
$userId | string|integer |
使用者 ID(請參閱 yii\web\User::$id) |
return | yii\rbac\Role[] |
直接指派給使用者的所有角色。陣列以角色名稱索引。 |
---|
public function getRolesByUser($userId);
定義於: yii\rbac\ManagerInterface::getRule()
傳回指定名稱的規則。
public abstract yii\rbac\Rule|null getRule ( $name ) | ||
$name | string |
規則名稱 |
return | yii\rbac\Rule|null |
規則物件,如果指定的名稱未對應到規則,則為 null。 |
---|
public function getRule($name);
定義於: yii\rbac\ManagerInterface::getRules()
傳回系統中所有可用的規則。
public abstract yii\rbac\Rule[] getRules ( ) | ||
return | yii\rbac\Rule[] |
以規則名稱索引的規則 |
---|
public function getRules();
定義於: yii\rbac\ManagerInterface::getUserIdsByRole()
傳回指派給指定角色的所有使用者 ID。
public abstract array getUserIdsByRole ( $roleName ) | ||
$roleName | string | |
return | array |
使用者 ID 字串陣列 |
---|
public function getUserIdsByRole($roleName);
定義於: yii\rbac\ManagerInterface::hasChild()
傳回一個值,指示父項目是否已存在子項目。
public abstract boolean hasChild ( $parent, $child ) | ||
$parent | yii\rbac\Item | |
$child | yii\rbac\Item | |
return | boolean |
|
---|
public function hasChild($parent, $child);
定義於: 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);
}
定義於: 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;
}
檢查 $assignments 陣列是否為空,以及 $defaultRoles 屬性是否也為空。
protected boolean hasNoAssignments ( array $assignments ) | ||
$assignments | yii\rbac\Assignment[] |
使用者指派的陣列 |
return | boolean |
指派的陣列是否為空,且 $defaultRoles 屬性也為空 |
---|
protected function hasNoAssignments(array $assignments)
{
return empty($assignments) && empty($this->defaultRoles);
}
定義於: 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);
}
public void init ( ) |
public function init()
{
}
定義於: 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;
}
將事件處理常式附加到事件。
事件處理器必須是有效的 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]);
}
}
從 RBAC 系統中移除角色、權限或規則。
public boolean remove ( $object ) | ||
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule | |
return | boolean |
角色、權限或規則是否成功移除 |
---|
public function remove($object)
{
if ($object instanceof Item) {
return $this->removeItem($object);
} elseif ($object instanceof Rule) {
return $this->removeRule($object);
}
throw new InvalidArgumentException('Removing unsupported object type.');
}
定義於: yii\rbac\ManagerInterface::removeAll()
移除所有授權資料,包括角色、權限、規則和指派。
public abstract void removeAll ( ) |
public function removeAll();
定義於: yii\rbac\ManagerInterface::removeAllAssignments()
移除所有角色指派。
public abstract void removeAllAssignments ( ) |
public function removeAllAssignments();
public abstract void removeAllPermissions ( ) |
public function removeAllPermissions();
public abstract void removeAllRoles ( ) |
public function removeAllRoles();
public abstract void removeAllRules ( ) |
public function removeAllRules();
public abstract boolean removeChild ( $parent, $child ) | ||
$parent | yii\rbac\Item | |
$child | yii\rbac\Item | |
return | boolean |
移除是否成功 |
---|
public function removeChild($parent, $child);
public abstract boolean removeChildren ( $parent ) | ||
$parent | yii\rbac\Item | |
return | boolean |
移除是否成功 |
---|
public function removeChildren($parent);
從 RBAC 系統中移除授權項目。
protected abstract boolean removeItem ( $item ) | ||
$item | yii\rbac\Item |
要移除的項目 |
return | boolean |
角色或權限是否成功移除 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如角色或權限的名稱不唯一) |
abstract protected function removeItem($item);
從 RBAC 系統中移除規則。
protected abstract boolean removeRule ( $rule ) | ||
$rule | yii\rbac\Rule |
要移除的規則 |
return | boolean |
規則是否成功移除 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如規則的名稱不唯一) |
abstract protected function removeRule($rule);
定義於: yii\rbac\ManagerInterface::revoke()
從使用者撤銷角色。
public abstract boolean revoke ( $role, $userId ) | ||
$role | yii\rbac\Role|yii\rbac\Permission | |
$userId | string|integer |
使用者 ID(請參閱 yii\web\User::$id) |
return | boolean |
撤銷是否成功 |
---|
public function revoke($role, $userId);
定義於: yii\rbac\ManagerInterface::revokeAll()
從使用者撤銷所有角色。
public abstract boolean revokeAll ( $userId ) | ||
$userId | mixed |
使用者 ID(請參閱 yii\web\User::$id) |
return | boolean |
撤銷是否成功 |
---|
public function revokeAll($userId);
設定預設角色
public void setDefaultRoles ( $roles ) | ||
$roles | string[]|Closure |
角色陣列或傳回它的可調用項 |
throws | yii\base\InvalidArgumentException |
當 $roles 既不是陣列也不是 Closure 時 |
---|---|---|
throws | yii\base\InvalidValueException |
當 Closure 傳回值不是陣列時 |
public function setDefaultRoles($roles)
{
if (is_array($roles)) {
$this->defaultRoles = $roles;
} elseif ($roles instanceof \Closure) {
$roles = call_user_func($roles);
if (!is_array($roles)) {
throw new InvalidValueException('Default roles closure must return an array');
}
$this->defaultRoles = $roles;
} else {
throw new InvalidArgumentException('Default roles must be either an array or a callable');
}
}
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);
}
更新系統中指定的角色、權限或規則。
public boolean update ( $name, $object ) | ||
$name | string |
角色、權限或規則的舊名稱 |
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule | |
return | boolean |
更新是否成功 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如角色或權限的名稱不唯一) |
public function update($name, $object)
{
if ($object instanceof Item) {
if ($object->ruleName && $this->getRule($object->ruleName) === null) {
$rule = \Yii::createObject($object->ruleName);
$rule->name = $object->ruleName;
$this->addRule($rule);
}
return $this->updateItem($name, $object);
} elseif ($object instanceof Rule) {
return $this->updateRule($name, $object);
}
throw new InvalidArgumentException('Updating unsupported object type.');
}
更新 RBAC 系統中的授權項目。
protected abstract boolean updateItem ( $name, $item ) | ||
$name | string |
正在更新的項目的名稱 |
$item | yii\rbac\Item |
已更新的項目 |
return | boolean |
授權項目是否成功更新 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如角色或權限的名稱不唯一) |
abstract protected function updateItem($name, $item);
更新 RBAC 系統中的規則。
protected abstract boolean updateRule ( $name, $rule ) | ||
$name | string |
正在更新的規則的名稱 |
$rule | yii\rbac\Rule |
已更新的規則 |
return | boolean |
規則是否成功更新 |
---|---|---|
throws | Exception |
如果資料驗證或儲存失敗(例如規則的名稱不唯一) |
abstract protected function updateRule($name, $rule);
註冊 或 登入 以發表評論。