cvs: peardoc /ja/api-doc Auth.fot Auth.xml

hirokawa Fri Feb 1 09:38:19 2002 EDT Added files: /peardoc/ja/api-doc Auth.fot Auth.xml Log: added api-doc/*.xml

Index: peardoc/ja/api-doc/Auth.fot +++ peardoc/ja/api-doc/Auth.fot <?xml version="1.0"?> <fot> </fot> Index: peardoc/ja/api-doc/Auth.xml +++ peardoc/ja/api-doc/Auth.xml <?xml version='1.0' encoding='UTF-8' ?> <!-- $Id: Auth.xml,v 1.1 2002/02/01 14:38:19 hirokawa Exp $ --> <!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V1.7//EN" "../../dbxml/docbookx.dtd" [ <article class="techreport"> <artheader> <title>Auth</title> </artheader> <section> <title>Auth_Auth</title> <para> <![CDATA[ ]]> </para> <para> <![CDATA[ PEAR::Auth PEAR::Authクラスは、PHPを使用して認証システムを作成するための手段を提 供します。 使用例: require_once "Auth/Auth.php"; // この例では、MySQLをストレージコンテナとして使用します。 $a = new Auth("DB","mysql://martin:test@localhost/test"); // ユーザがログイン済みかどうか確認し、ログインしていない場合はロ // グインフォームを表示します。 $a->start(); if ($a->getAuth()) { echo "Welcome user ".$a->getUsername()."!<br>\n"; // サイトの内容を出力します。この内容は、認証に成功しているユー // ザのみ見ることができます。 } ]]> </para> <refentry id="Auth.Auth.Auth"> <refmeta> <refentrytitle>Auth</refentrytitle> </refmeta> <refnamediv> <refname>Auth</refname> <refpurpose>コンストラクタ</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>Auth</function></funcdef> <paramdef>$storage_driver <parameter>文字列: ストレージドライバ</parameter> </paramdef> <paramdef>$storage_options <parameter>文字列: ストレージドライバ−オプション (例: ストレージドライバとしてDBを使用している場合、 DSN文字列をここで指定する必要があります。) </parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1> <title>説明</title> <para> <![CDATA[ Constructor ]]> </para> <para> <![CDATA[ Constructor ストレージドライバを設定する ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.assignData"> <refmeta> <refentrytitle>assignData</refentrytitle> </refmeta> <refnamediv> <refname>assignData</refname> <refpurpose>ログインフォームから内部変数にデータを代入する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>assignData</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ ログインフォームから内部変数にデータを代入する ]]> </para> <para> <![CDATA[ ログインフォームから内部変数にデータを代入します。 この関数は、$HTTP_POST_VARSからusernameおよびpasswordの値を取得し、内 部変数に代入します。$HTTP_POST_VARS以外のソースを使用したい場合には、 この関数の派生させる必要があります。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.drawLogin"> <refmeta> <refentrytitle>drawLogin</refentrytitle> </refmeta> <refnamediv> <refname>drawLogin</refname> <refpurpose>ログインフォームを出力する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>drawLogin</function></funcdef> <paramdef>$username <parameter>string 入力済みの場合のみ</parameter></paramdef> <paramdef>$password <parameter>string 入力済みの場合のみ</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ ログインフォームを出力する ]]> </para> <para> <![CDATA[ ログインフォームを出力します。 この関数は、適切なログインフォームを取得するためにプログラマにより上書 きされるべきです。上書きしない場合には、醜いものになるでしょう。:-) ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth._factory"> <refmeta> <refentrytitle>_factory</refentrytitle> </refmeta> <refnamediv> <refname>_factory</refname> <refpurpose>$driverおよび$optionsに基づくストレージドライバを返す</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>_factory</function></funcdef> <paramdef>$driver <parameter>string 返すストレージクラスの型</parameter> </paramdef> <paramdef>$options <parameter>string ストレージクラスのオプションパラメータ</parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ $driverおよび$optionsに基づくストレージドライバを返す ]]> </para> <para> <![CDATA[ $driverおよび$optionsに基づくストレージドライバを返します。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.start"> <refmeta> <refentrytitle>start</refentrytitle> </refmeta> <refnamediv> <refname>start</refname> <refpurpose>新規認証セッションを開始する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>start</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ 新規認証セッションを開始する ]]> </para> <para> <![CDATA[ 新規認証セッションを開始します。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.login"> <refmeta> <refentrytitle>login</refentrytitle> </refmeta> <refnamediv> <refname>login</refname> <refpurpose>ログイン関数</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>login</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ ログイン関数 ]]> </para> <para> <![CDATA[ ログイン関数 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.setExpire"> <refmeta> <refentrytitle>setExpire</refentrytitle> </refmeta> <refnamediv> <refname>setExpire</refname> <refpurpose>最大有効期限を設定する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>setExpire</function></funcdef> <paramdef>$time <parameter>integer 秒単位の時間</parameter></paramdef> <paramdef>$add <parameter>boolean カレントの有効時間に対する相対時間かどうか</parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ 最大有効期限を設定する ]]> </para> <para> <![CDATA[ 最大有効期限を設定します。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.checkAuth"> <refmeta> <refentrytitle>checkAuth</refentrytitle> </refmeta> <refnamediv> <refname>checkAuth</refname> <refpurpose>セッションが有効な認証情報を有しているかどうか確認する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>checkAuth</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ セッションが有効な認証情報を有しているかどうか確認する。 ]]> </para> <para> <![CDATA[ セッションが有効な認証情報を有しているかどうか確認します。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.setAuth"> <refmeta> <refentrytitle>setAuth</refentrytitle> </refmeta> <refnamediv> <refname>setAuth</refname> <refpurpose>ユーザ認証に関する変数をセッションに登録する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>setAuth</function></funcdef> <paramdef>$ <parameter>$ $</parameter></paramdef> <paramdef>s <parameter>s s</parameter></paramdef> <paramdef> <parameter> </parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ ユーザ認証に関する変数をセッションに登録します。 ]]> </para> <para> <![CDATA[ ログインに成功したユーザに関する変数をセッションに登録します。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.getAuth"> <refmeta> <refentrytitle>getAuth</refentrytitle> </refmeta> <refnamediv> <refname>getAuth</refname> <refpurpose>ユーザが認証済みかどうか確認する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>getAuth</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ ユーザが認証済みかどうか確認する。 ]]> </para> <para> <![CDATA[ ユーザが認証済みかどうか確認します。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.logout"> <refmeta> <refentrytitle>logout</refentrytitle> </refmeta> <refnamediv> <refname>logout</refname> <refpurpose>ログアウト関数</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>logout</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ Logout function ]]> </para> <para> <![CDATA[ Logout function この関数は、アクティブなカレントのセッションにおいて全ての認証をクリ アします。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.updateIdle"> <refmeta> <refentrytitle>updateIdle</refentrytitle> </refmeta> <refnamediv> <refname>updateIdle</refname> <refpurpose>待機時間を更新する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>updateIdle</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ 待機時間を更新する ]]> </para> <para> <![CDATA[ 待機時間を更新する。 ]]> </para> </refsect1> </refentry> <refentry id="Auth.Auth.getUsername"> <refmeta> <refentrytitle>getUsername</refentrytitle> </refmeta> <refnamediv> <refname>getUsername</refname> <refpurpose>ユーザ名を取得する</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcprototype> <funcdef> <function>getUsername</function></funcdef> <void></void> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1><title>説明</title> <para> <![CDATA[ ユーザ名を取得する ]]> </para> <para> <![CDATA[ ユーザ名を取得します。 ]]> </para> </refsect1> </refentry> </section> </article>