Documentation

// ユーザ名とパスワードを検証
if ($user = Auth::validate_user($name, $pass))
{
	// $name と $pass との組み合わせが検証されたならユーザーの表示名を印字
	echo $user['username'];
}

// ログインを実行
if (Auth::login($name, $pass))
{
	// ユーザーは正常にログインされている
}

// ログインしていないのであればログインを
if ( ! Auth::check())
{
	Response::redirect('/login');
}

// ユーザー 12121 の強制ログインを実行
if (Auth::force_login(12121))
{
	// ユーザーは正常にログインされている。以前にログインしていたユーザーはログアウトされます！
}

// ログアウトを実行
Auth::logout();

// 新しいユーザーを作成
Auth::create_user(
	'anewuser',
	'thisismysecretpassword',
	'anewuser@example.org',
	1,
	array(
		'fullname' => 'A. New User',
	)
);

// 現在のユーザーのデータを更新
Auth::update_user(
	array(
		'email'        => 'anewemail@example.org',  // 新しいメールアドレスを設定する
		'password'     => 'thisismynewpassword',    // 新しいパスワードを設定
		'old_password' => 'thisismysecretpassword', // その為には現在のパスワードを与える！
		'phone'        => '+1 (555) 123-1212',	    // それから、メタデータに電話番号を追加
	)
);

// 現在のユーザのパスワードを変更
Auth::change_password('mycurrentpassword','mynewpassword');

// 現在のユーザーのパスワードをリセット
$new_password = Auth::reset_password('thisusername');

// ユーザーを削除
Auth::delete_user('thisusername');

// ランダムなハッシュを新たに生成
Auth::create_login_hash();

// ユーザの作成日を取得
$created_at = Auth::get('created_at');

// すべてのログインID情報を取得
$id_info = Auth::get_user_id();

// ドライバおよび id 情報を印字
if ($id_info)
{
	foreach ($id_info as $info)
	{
		echo 'Driver: ',$info[0],' with ID ',$info[1],'<br />';
	}
}
else
{
	echo 'Nobody is logged in!';
}

// ドライバを 1 つのみ使用する場合、次のようにできます。
list($driver, $userid) = Auth::get_user_id();

// または、ユーザー id のみ必要な場合
list(, $userid) = Auth::get_user_id();

// すべてのグループID情報を取得
$id_info = Auth::get_groups();

// ドライバおよび id 情報を印字
if ($id_info)
{
	foreach ($id_info as $info)
	{
		echo 'Driver: ',$info[0],' with group ID ',$info[1],'<br />';
	}
}
else
{
	echo 'Nobody is logged in!';
}

// ドライバを 1 つのみ使用する場合、次のようにできます。
list($driver, $groupid) = Auth::get_groups();

// 現在のユーザの電子メールアドレスを取得
$email = Auth::get_email();

// false と empty の間に差があることに注意:
if ($email === false)
{
	// 誰もログインしていない
}
if (empty($email))
{
	// ユーザーがログインしているが電子メールアドレスを持っていない
}

// 現在のユーザーの表示名を取得
$name = Auth::get_screen_name();

// 名前は必須、存在しないならば誰もログインしていないことを意味する
if (empty($name))
{
	// 誰もログインしていない
}

// すべてのプロフィールフィールドが定義される
$profile = Auth::get_profile_fields();

// 現在のユーザーが管理者であるかどうかを検査
if (Auth::member(100))
{
	// 管理者グループに属している！
}

// 定義済みのすべてのグループを取得 (すべてのロードされたグループドライバ用)
$groups = Auth::groups();

// デフォルトのグループドライバからすべてのグループを取得
$groups = Auth::group()->groups();

// 指定のドライバからすべてのグループを取得
$groups = Auth::group('Simplegroup')->groups();

// 定義済みのすべてのロールを取得 (すべてのロードされた ACL ドライバ用)
$roles = Auth::roles();

// デフォルトの ACL ドライバからすべてのロールを取得
$roles = Auth::acl()->roles();

// 指定のドライバからすべてのロールを取得
$roles = Auth::acl('Simpleacl')->roles();

// 現在ログインしているユーザーのグループのすべての名前を取得
$name = Auth::group()->get_name();

// 特定のドライバから特定のグループの名前を取得
$name = Auth::group('Simplegroup')->get_name(100);	// 'Administrators' が返る

// ユーザーがブログ記事を読むためのアクセス権を持っているかどうかを検査
if (Auth::has_access('blog.read'))
{
	// はい、ユーザーはアクセス権を持っています
}

// 複数のログインインスタンスがある場合、このメソッドを呼び出すためにはインスタンスを使用します。
// また、一度に複数の権限を検査することもできます
if (Auth::instance('simpleauth')->has_access('blog.[read,write,delete]'))
{
	// はい、ユーザーはアクセス権を持っており、読み取りも書き込みも削除も可能です
}

// また、配列として検査する権限を指定することもできます
if (Auth::has_access(array('blog' => array('read'), 'comments' => array('read')))
{
	// はい、ユーザーはブログとコメントの読み取りのアクセス権を持っています
}

// 複数のログインインスタンスがある場合、特定の ACL ドライバーを選ぶことができます
if (Auth::acl('simpleacl')->has_access('blog.[read,write,delete]'))
{
	// はい、ユーザーはアクセス権を持っており、読み取りも書き込みも削除も可能です
}

// ログインしておらずゲストユーザーも有効になっていない場合、 login にリダイレクト
if ( ! Auth::check() and ! Auth::guest_login())
{
	Response::redirect('/login');
}

// ログインフォームの POST を処理し、必要に応じて remember-me クッキーを設定
if (\Input::method() == 'POST')
{
	// 資格情報を検査
	if (\Auth::instance()->login(\Input::param('username'), \Input::param('password')))
	{
		// ユーザーを覚えてほしい？
		if (\Input::param('rememberme', false))
		{
			// remember-me クッキーを作成
			\Auth::remember_me();
		}
		else
		{
			// 存在する場合、 remember-me クッキーを削除
			\Auth::dont_remember_me();
		}

		// ログインしホームページに移動
		\Response::redirect('/');
	}
	else
	{
		// ログイン失敗、エラーメッセージを表示
		$data['username']    = \Input::param('username');
		$data['login_error'] = \Lang::get('login.failure');
	}
}