0 フォロワー

インターフェース yii\rbac\ManagerInterface

拡張	yii\rbac\CheckAccessInterface
実装者	yii\rbac\BaseManager、yii\rbac\DbManager、yii\rbac\PhpManager
利用可能バージョン	2.0
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/rbac/ManagerInterface.php

ManagerInterface の詳細と使用方法については、セキュリティ認証に関するガイド記事を参照してください。

パブリックメソッド

継承されたメソッドを隠す

メソッド	説明	定義者
add()	ロール、パーミッション、またはルールを RBAC システムに追加します。	yii\rbac\ManagerInterface
addChild()	あるアイテムを別のアイテムの子として追加します。	yii\rbac\ManagerInterface
assign()	ロールをユーザーに割り当てます。	yii\rbac\ManagerInterface
canAddChild()	親に子を追加できるかどうかを確認します。	yii\rbac\ManagerInterface
checkAccess()	ユーザーが指定されたパーミッションを持っているかどうかを確認します。	yii\rbac\CheckAccessInterface
createPermission()	新しいパーミッションオブジェクトを作成します。	yii\rbac\ManagerInterface
createRole()	新しいロールオブジェクトを作成します。	yii\rbac\ManagerInterface
getAssignment()	ロールとユーザーに関する割り当て情報を返します。	yii\rbac\ManagerInterface
getAssignments()	指定されたユーザーのすべてのロール割り当て情報を返します。	yii\rbac\ManagerInterface
getChildRoles()	指定されたロールの子ロールを返します。深さに制限はありません。	yii\rbac\ManagerInterface
getChildren()	子パーミッションおよび/またはロールを返します。	yii\rbac\ManagerInterface
getPermission()	指定された名前のパーミッションを返します。	yii\rbac\ManagerInterface
getPermissions()	システム内のすべてのパーミッションを返します。	yii\rbac\ManagerInterface
getPermissionsByRole()	指定されたロールが表す、すべてのパーミッションを返します。	yii\rbac\ManagerInterface
getPermissionsByUser()	ユーザーが持つすべてのパーミッションを返します。	yii\rbac\ManagerInterface
getRole()	指定された名前のロールを返します。	yii\rbac\ManagerInterface
getRoles()	システム内のすべてのロールを返します。	yii\rbac\ManagerInterface
getRolesByUser()	assign() を介してユーザーに割り当てられているロールを返します。	yii\rbac\ManagerInterface
getRule()	指定された名前のルールを返します。	yii\rbac\ManagerInterface
getRules()	システムで使用可能なすべてのルールを返します。	yii\rbac\ManagerInterface
getUserIdsByRole()	指定されたロールに割り当てられているすべてのユーザー ID を返します。	yii\rbac\ManagerInterface
hasChild()	親に対して子が既に存在するかどうかを示す値を返します。	yii\rbac\ManagerInterface
remove()	ロール、パーミッション、またはルールを RBAC システムから削除します。	yii\rbac\ManagerInterface
removeAll()	ロール、パーミッション、ルール、割り当てなど、すべての認証データを削除します。	yii\rbac\ManagerInterface
removeAllAssignments()	すべてのロール割り当てを削除します。	yii\rbac\ManagerInterface
removeAllPermissions()	すべてのパーミッションを削除します。	yii\rbac\ManagerInterface
removeAllRoles()	すべてのロールを削除します。	yii\rbac\ManagerInterface
removeAllRules()	すべてのルールを削除します。	yii\rbac\ManagerInterface
removeChild()	子を親から削除します。	yii\rbac\ManagerInterface
removeChildren()	すべての子供を親から削除しました。	yii\rbac\ManagerInterface
revoke()	ユーザーからロールを取り消します。	yii\rbac\ManagerInterface
revokeAll()	ユーザーからすべてのロールを取り消します。	yii\rbac\ManagerInterface
update()	システムで指定されたロール、パーミッション、またはルールを更新します。	yii\rbac\ManagerInterface

メソッド詳細

継承されたメソッドを隠す

add() public abstract method

ロール、パーミッション、またはルールを RBAC システムに追加します。

public abstract boolean add ( $object )
$object	yii\rbac\Role\|yii\rbac\Permission\|yii\rbac\Rule
戻り値	boolean	ロール、パーミッション、またはルールがシステムに正常に追加されたかどうか
throws	Exception	データの検証または保存に失敗した場合 (ロールまたはパーミッションの名前が一意ではない場合など)

ソースコード

                public function add($object);

addChild() public abstract method

あるアイテムを別のアイテムの子として追加します。

public abstract boolean addChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
戻り値	boolean	子を正常に追加できたかどうか
throws	yii\base\Exception	親子関係が既に存在する場合、またはループが検出された場合。

ソースコード

                public function addChild($parent, $child);

assign() public abstract method

ロールをユーザーに割り当てます。

public abstract yii\rbac\Assignment assign ( $role, $userId )
$role	yii\rbac\Role\|yii\rbac\Permission
$userId	string\|integer	ユーザーID ( yii\web\User::$id を参照)
戻り値	yii\rbac\Assignment	ロールの割り当て情報。
throws	Exception	ロールがすでにユーザーに割り当てられている場合

ソースコード

                public function assign($role, $userId);

canAddChild() public abstract メソッド (バージョン 2.0.8 から利用可能)

親に子を追加できるかどうかを確認します。

public abstract boolean canAddChild ( $parent, $child )
$parent	yii\rbac\Item	親アイテム
$child	yii\rbac\Item	階層に追加する子アイテム
戻り値	boolean	追加の可能性

ソースコード

                public function canAddChild($parent, $child);

checkAccess() public abstract メソッド

定義元: yii\rbac\CheckAccessInterface::checkAccess()

ユーザーが指定されたパーミッションを持っているかどうかを確認します。

public abstract boolean checkAccess ( $userId, $permissionName, $params = [] )
$userId	string\|integer	ユーザーID。これは、ユーザーの一意の識別子を表す整数または文字列のいずれかである必要があります。 yii\web\User::$idを参照してください。
$permissionName	string	チェック対象のパーミッションの名前
$params	array	ユーザーに割り当てられたロールおよびパーミッションに関連付けられたルールに渡される名前と値のペア。
戻り値	boolean	ユーザーが指定されたパーミッションを持っているかどうか。
throws	yii\base\InvalidParamException	$permissionName が既存のパーミッションを参照していない場合

ソースコード

                public function checkAccess($userId, $permissionName, $params = []);

createPermission() public abstract メソッド

新しいパーミッションオブジェクトを作成します。

新しく作成されたパーミッションは、まだ RBAC システムに追加されていないことに注意してください。必要なデータを入力し、add() を呼び出してシステムに追加する必要があります。

public abstract yii\rbac\Permission createPermission ( $name )
$name	string	パーミッションの名前
戻り値	yii\rbac\Permission	新しい Permission オブジェクト

ソースコード

                public function createPermission($name);

createRole() public abstract メソッド

新しいロールオブジェクトを作成します。

新しく作成されたロールは、まだ RBAC システムに追加されていないことに注意してください。必要なデータを入力し、add() を呼び出してシステムに追加する必要があります。

public abstract yii\rbac\Role createRole ( $name )
$name	string	ロール名
戻り値	yii\rbac\Role	新しい Role オブジェクト

ソースコード

                public function createRole($name);

getAssignment() public abstract メソッド

ロールとユーザーに関する割り当て情報を返します。

public abstract yii\rbac\Assignment\|null getAssignment ( $roleName, $userId )
$roleName	string	ロール名
$userId	string\|integer	ユーザーID ( yii\web\User::$id を参照)
戻り値	yii\rbac\Assignment\|null	割り当て情報。ロールがユーザーに割り当てられていない場合は Null が返されます。

ソースコード

                public function getAssignment($roleName, $userId);

getAssignments() public abstract メソッド

指定されたユーザーのすべてのロール割り当て情報を返します。

public abstract yii\rbac\Assignment[] getAssignments ( $userId )
$userId	string\|integer	ユーザーID ( yii\web\User::$id を参照)
戻り値	yii\rbac\Assignment[]	ロール名でインデックス付けされた割り当て。ユーザーに割り当てられたロールがない場合は空の配列が返されます。

ソースコード

                public function getAssignments($userId);

getChildRoles() public abstract メソッド (バージョン 2.0.10 から利用可能)

指定されたロールの子ロールを返します。深さに制限はありません。

public abstract yii\rbac\Role[] getChildRoles ( $roleName )
$roleName	string	子ロールを取得するロールの名前
戻り値	yii\rbac\Role[]	子ロール。配列はロール名でインデックス付けされています。最初の要素は親ロール自体のインスタンスです。
throws	yii\base\InvalidParamException	$roleName で取得するロールが見つからなかった場合

ソースコード

                public function getChildRoles($roleName);

getChildren() public abstract メソッド

子パーミッションおよび/またはロールを返します。

public abstract yii\rbac\Item[] getChildren ( $name )
$name	string	親の名前
戻り値	yii\rbac\Item[]	子パーミッションおよび/またはロール

ソースコード

                public function getChildren($name);

getPermission() public abstract メソッド

指定された名前のパーミッションを返します。

public abstract yii\rbac\Permission\|null getPermission ( $name )
$name	string	パーミッションの名前。
戻り値	yii\rbac\Permission\|null	指定された名前に対応するパーミッション。そのようなパーミッションが存在しない場合は Null が返されます。

ソースコード

                public function getPermission($name);

getPermissions() public abstract メソッド

システム内のすべてのパーミッションを返します。

public abstract yii\rbac\Permission[] getPermissions ( )
戻り値	yii\rbac\Permission[]	システム内のすべてのパーミッション。配列はパーミッション名でインデックス付けされています。

ソースコード

                public function getPermissions();

getPermissionsByRole() public abstract メソッド

指定されたロールが表す、すべてのパーミッションを返します。

public abstract yii\rbac\Permission[] getPermissionsByRole ( $roleName )
$roleName	string	ロール名
戻り値	yii\rbac\Permission[]	ロールが表すすべてのパーミッション。配列はパーミッション名でインデックス付けされています。

ソースコード

                public function getPermissionsByRole($roleName);

getPermissionsByUser() public abstract メソッド

ユーザーが持つすべてのパーミッションを返します。

public abstract yii\rbac\Permission[] getPermissionsByUser ( $userId )
$userId	string\|integer	ユーザーID ( yii\web\User::$id を参照)
戻り値	yii\rbac\Permission[]	ユーザーが持つすべてのパーミッション。配列はパーミッション名でインデックス化されます。

ソースコード

                public function getPermissionsByUser($userId);

getRole() public abstract メソッド

指定された名前のロールを返します。

public abstract yii\rbac\Role\|null getRole ( $name )
$name	string	ロール名。
戻り値	yii\rbac\Role\|null	指定された名前に対応するロール。そのようなロールがない場合は Null が返されます。

ソースコード

                public function getRole($name);

getRoles() public abstract メソッド

システム内のすべてのロールを返します。

public abstract yii\rbac\Role[] getRoles ( )
戻り値	yii\rbac\Role[]	システム内のすべてのロール。配列はロール名でインデックス化されます。

ソースコード

                public function getRoles();

getRolesByUser() public abstract メソッド

assign() を介してユーザーに割り当てられているロールを返します。

ユーザーに直接割り当てられていない子ロールは返されないことに注意してください。

public abstract yii\rbac\Role[] getRolesByUser ( $userId )
$userId	string\|integer	ユーザーID ( yii\web\User::$id を参照)
戻り値	yii\rbac\Role[]	ユーザーに直接割り当てられたすべてのロール。配列はロール名でインデックス化されます。

ソースコード

                public function getRolesByUser($userId);

getRule() public abstract メソッド

指定された名前のルールを返します。

public abstract yii\rbac\Rule\|null getRule ( $name )
$name	string	ルール名。
戻り値	yii\rbac\Rule\|null	ルールオブジェクト。指定された名前がルールに対応しない場合は null。

ソースコード

                public function getRule($name);

getRules() public abstract メソッド

システムで使用可能なすべてのルールを返します。

public abstract yii\rbac\Rule[] getRules ( )
戻り値	yii\rbac\Rule[]	ルール名でインデックス化されたルール

ソースコード

                public function getRules();

getUserIdsByRole() public abstract メソッド (バージョン 2.0.7 から利用可能)

指定されたロールに割り当てられているすべてのユーザー ID を返します。

public abstract array getUserIdsByRole ( $roleName )
$roleName	string
戻り値	array	ユーザーID文字列の配列

ソースコード

                public function getUserIdsByRole($roleName);

hasChild() public abstract メソッド

親に対して子が既に存在するかどうかを示す値を返します。

public abstract boolean hasChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
戻り値	boolean	`$child` が既に `$parent` の子であるかどうか

ソースコード

                public function hasChild($parent, $child);

remove() public abstract メソッド

ロール、パーミッション、またはルールを RBAC システムから削除します。

public abstract boolean remove ( $object )
$object	yii\rbac\Role\|yii\rbac\Permission\|yii\rbac\Rule
戻り値	boolean	ロール、パーミッション、またはルールが正常に削除されたかどうか

ソースコード

                public function remove($object);

removeAll() public abstract メソッド

ロール、パーミッション、ルール、割り当てなど、すべての認証データを削除します。

public abstract void removeAll ( )

ソースコード

                public function removeAll();

removeAllAssignments() public abstract メソッド

すべてのロール割り当てを削除します。

public abstract void removeAllAssignments ( )

ソースコード

                public function removeAllAssignments();

removeAllPermissions() public abstract メソッド

すべてのパーミッションを削除します。

すべての親子関係がそれに応じて調整されます。

public abstract void removeAllPermissions ( )

ソースコード

                public function removeAllPermissions();

removeAllRoles() public abstract メソッド

すべてのロールを削除します。

すべての親子関係がそれに応じて調整されます。

public abstract void removeAllRoles ( )

ソースコード

                public function removeAllRoles();

removeAllRules() public abstract メソッド

すべてのルールを削除します。

ルールを持つすべてのロールとパーミッションは、それに応じて調整されます。

public abstract void removeAllRules ( )

ソースコード

                public function removeAllRules();

removeChild() public abstract メソッド

子を親から削除します。

注意: 子アイテムは削除されません。親と子の関係のみが削除されます。

public abstract boolean removeChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
戻り値	boolean	削除が成功したかどうか

ソースコード

                public function removeChild($parent, $child);

removeChildren() public abstract メソッド

すべての子供を親から削除しました。

注意: 子アイテムは削除されません。親と子の関係のみが削除されます。

public abstract boolean removeChildren ( $parent )
$parent	yii\rbac\Item
戻り値	boolean	削除が成功したかどうか

ソースコード

                public function removeChildren($parent);

revoke() public abstract メソッド

ユーザーからロールを取り消します。

public abstract boolean revoke ( $role, $userId )
$role	yii\rbac\Role\|yii\rbac\Permission
$userId	string\|integer	ユーザーID ( yii\web\User::$id を参照)
戻り値	boolean	取り消しが成功したかどうか

ソースコード

                public function revoke($role, $userId);

revokeAll() public abstract メソッド

ユーザーからすべてのロールを取り消します。

public abstract boolean revokeAll ( $userId )
$userId	mixed	ユーザーID ( yii\web\User::$id を参照)
戻り値	boolean	取り消しが成功したかどうか

ソースコード

                public function revokeAll($userId);

update() public abstract メソッド

システムで指定されたロール、パーミッション、またはルールを更新します。

public abstract boolean update ( $name, $object )
$name	string	ロール、パーミッション、またはルールの古い名前
$object	yii\rbac\Role\|yii\rbac\Permission\|yii\rbac\Rule
戻り値	boolean	更新が成功したかどうか
throws	Exception	データの検証または保存に失敗した場合 (ロールまたはパーミッションの名前が一意ではない場合など)

ソースコード

                public function update($name, $object);