SimpleAuth グループ

Auth パッケージの はじめに で書いたように、 認証システムはシステムに付属する 3 つの異なったドライバによって成り立っています。

SimpleAuth グループドライバは、グループ定義情報を simpleauth.php 設定ファイルに保持しています。 これは、ユーザーがグループのメンバーであるかどうかやグループそのものの情報、またグループに定義されているロールを取得するためのロジックを提供します。

設定

SimpleAuth グループドライバは、グループ定義情報を simpleauth.php 設定ファイルに保持しています。 グループは多次元配列として定義され、以下の構造を持っていなければいけません： 

array(
	<id> => array(				//  <id> グループを識別するための番号
		'name' => 'name-of-this-group',		// グループを識別するための名前、'Administrators' や 'Guests' など
		'roles' => array('role', 'otherrole'),	// このグループに割り当てられたロール
	),
),

Authパッケージに含まれる simpleauth.php 設定ファイルには、使用可能ないくつかの例が含まれています。

Class メソッド

member($group, $user = null)

member メソッドは、ユーザーがそのグループのメンバーかどうかをチェックします。

静的 いいえ
パラメータ
パラメータ 規定値 説明
$group 必須 チェックしたいグループの id
$user 
null
 チェックしたいユーザー。get_user_id()の返されるユーザーidか、null の場合は現在ログインしているユーザー。
返り値 ユーザーがそのグループのメンバーならば true を、そうでなければ false を返します。

get_name($group = null)

get_name メソッドはグループ id からグループ名を返します。

静的 いいえ
パラメータ
パラメータ 規定値 説明
$group 
null
 グループ名を取得したいグループの id
返り値 mixed. もしグループが存在しなければ false、そうでなければグループ名が返ります。

グループ id が引数に渡されなかった時は、最初に定義されたグループの名前が返ります。

get_roles($group = null)

get_roles メソッドは、グループ id からそのグループ用に定義されたロールを返します。

静的 いいえ
パラメータ
パラメータ 規定値 説明
$group 
null
 ロールを知りたいグループの id
返り値 array. もし渡されたグループ id が存在しなければ空の配列が返ります。渡されたグループ id が null だったら、最初に定義されたグループのロールが返ります。