Documentation

Auth_Group_Driver

このドライバは、すべての Auth Group ドライバの基底クラスです。抽象クラスとして定義されており、 すべての Group ドライバに汎用なメソッド、 Group ドライバが必ず実装しなければならないメソッドの 抽象メソッドの定義が含まれています。

ドライバの設定

Group ドライバは必要に応じて追加のドライバをロードできます。一般的には、 ACL ドライバがこれにあたります。 しかし、実装次第では、カスタムタイプのドライバを導入して利用することも可能です。そのためには、ドライバクラスに次の構造を追加してください：

// この Group ドライバが読み込まれたとき Simpleacl ACL ドライバはオートロードされる
	protected $config = array(
		'drivers' => array('acl' => array('Simpleacl'))
	);

静的インターフェイス

使いやすいように、汎用的な Auth 静的インターフェイスを通じて member() メソッドは公開されています。

静的インターフェースで使用するには

// もし 現在のユーザーがグループ 16 のメンバの場合 true を返す
$is_member = Auth::member(16);

汎用メソッド

汎用メソッドは、 Group 基底ドライバに定義されており、継承によりすべての Auth Group ドライバから使うことができます。 これらのメソッドが提供する関数には、グループ間のやり取りを行ったり、アクセス権を確認するものがあります。

クラスに定義されているメソッドのうち、ドキュメントに記載されていないものは内部で利用されてるものなので、直接呼び出さないようにしてください。

// 'simpleauth' を返す
$id = Auth::group()->get_id();

// simplegroup ドライバの config に値を設定する
Auth::group()->set_config('key', 'value');

// get a config value of the simplegroup driver, return false if it doesn't exist
$key = Auth::instance('simplegroup')->get_config('key', false);

抽象メソッド

どの自作 Group ドライバも、以下のメソッドを用意しなければなりません。また、ここで記載されたとおりに値を返さなければなりません。

if ( ! Auth::member(100) )
{
	Response::redirect('no_admin');
}

// 特定のドライバ
Auth::member(1, 'simplegroup');

// 複数のドライバ
Auth::member(0, array('simplegroup', 'genericgroup'));

// admin グループの表示名を取得
Auth::group()->get_name('admin');