Auth::Auth()

PEAR マニュアル
前のページ		次のページ

説明

認証システムのコンストラクタです。

コンストラクタによって、session_start() で PHP のセッション管理が開始されることが保証されます。 Auth が正しく動作するためには、セッションが有効になっている必要があるからです。

パラメータ

string $storageDriver: 使用すべきストレージドライバーの名前、もしくは独自の Auth_Container オブジェクト
mixed $options: Auth 自身およびストレージドライバの両方についてのオプションを含む配列。グローバルなオプションについては Auth のオプション、各ドライバ固有のオプションについては個々のストレージドライバのドキュメントを参照ください。
string $loginFunction: ログイン画面を表示するユーザ定義関数の名前。この関数には三つのパラメータ $username、$status、&$auth を渡します。これらは、直近に試みられたユーザ名、直近の試みが失敗した際の状態コードそして Auth オブジェクト自身への参照となります。
boolean $showLogin: ログインがオプションかどうかの定義

注意

この関数は、スタティックにコールすることはできません。

参照

ストレージドライバ

例

例 34-1DB パラメータ

<?php
require_once "Auth/Auth.php";

function myOutput($username, $status, $auth)
{
    ...  /* See first example in introduction for the full listing */
}

$params = array(
            "dsn" => "mysql://martin:test@localhost/auth",
            "table" => "myAuth",
            "usernamecol" => "myUserColumn",
            "passwordcol" => "myPasswordColumn"
            );

$a = new Auth("DB", $params, "myOutput");

$a->start();

if ($a->getAuth()) {
    echo "You have been authenticated successfully.";
}
?>
    ;

データベーステーブル、およびカラム名の代替名を指定する方法について示します。この例では、テーブル myAuth を使用します。フィールド myUserColumn からユーザー名、フィールド myPasswordColumn からパスワードを選択します。デフォルトでは、テーブル名およびフィールド名はそれぞれ、auth および username、password となります。また、DSN の代わりに、DSN 引数を保持した DB のオブジェクトを渡すこともできます。

この機能は、デフォルトと異なるデータベースレイアウトで、 PEAR::Auth を使用したい場合に必要となります。

例

例 34-2独自ストレージコンテナ

<?php
require_once "Auth/Auth.php";

function myOutput($username, $status)
{
    ...  /* See first example in introduction for the full listing */
}

$a = new Auth(new CustomAuthContainer($options), null, "myOutput");

$a->start();

if ($a->getAuth()) {
    echo "You have been authenticated successfully.";
}
?>

この例は、独自のストレージコンテナを Auth に渡す方法について示しています。

Auth パッケージが提供するストレージコンテナが、自らの要求に合致しない場合は、独自のストレージコンテナを作成することができます。ストレージコンテナの詳細な情報については、ストレージドライバのセクションを参照してください。

前のページ	ホーム	次のページ
定数	上に戻る	Auth::addUser()

Auth::Auth()

概要

説明

パラメータ

注意

参照

例

例