cvs: peardoc /ja/packages/authentication auth.xml auth_http.xml

hirokawa Mon Feb 11 18:16:22 2002 EDT Added files: /peardoc/ja/packages/authentication auth.xml auth_http.xml Log: added Auth in japanese manual.

Index: peardoc/ja/packages/authentication/auth.xml +++ peardoc/ja/packages/authentication/auth.xml <?xml encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry id="packages.Auth.Auth"> <refnamediv> <refname><classname>Auth</classname></refname> <refpurpose> PHPに基づく認証システム </refpurpose> </refnamediv> <refsect1 id="packages.Auth.Auth.tutorial"> <title>使用例</title> <simpara> この簡易チュートリアルの目的は、簡単に使える認証機構によりセキュア なサイトを構築するシステムを設定することです。 </simpara> <para> セキュアとするサイトの最上位に、以下の短いコードを置いてみましょう。 </para> <example> <title> <classname>PEAR::Auth</classname>の典型的な使用例 </title> <programlisting role="php"> <![CDATA[ require_once "Auth/Auth.php"; function loginFunction() { global $PHP_SELF; /** * Change the HTML output so that it fits to your * application. */ echo "<form method=\"post\" action=\"" . $PHP_SELF . "\">"; echo "<input type=\"text\" name=\"username\">"; echo "<input type=\"password\" name=\"password\">"; echo "<input type=\"submit\">"; echo "</form>"; } $dsn = "mysql://user:password@localhost/database"; $a = new Auth("DB", $dsn, "loginFunction"); $a->start(); if ($a->getAuth()) { /** * The output of your site goes here. */ } ]]> </programlisting> </example> <para> この短いコードは、認証システムのインスタンスを作成するものです。 以下では、上記のスクリプトの各手順について説明します。 </para> <para> 最初の行では、PEARディレクトリからファイルを読み込んでいます。 ここには、PEAR::Authを実行する際に必要なコードが全て含まれています。 この後、ログイン画面を表示する関数を1つ定義します。この関数は、この ページを閲覧する者がログインデータを入力するために使用されます。 この関数のHTMLフォーマットは自由に変更することが出来ます。 </para> <warning> <simpara> この関数のHTMLフォーマットは自由に変更できますが、inputボックスの nameは変更してはいけません。"username"および"password"とする必要が あります。 </simpara> </warning> <para> ログインデータを検証するためにデータベースを使用するため、ここで、 変数$dsnを作成します。この変数には、PEAR::DBによりデータベースと接 続する際に使用される有効なDSN文字列を指定します。その他のストレージ コンテナを使用したい場合は、後述する詳細な説明を参照下さい。 </para> <para> この後、認証オブジェクトを作成します。最初のパラメータは、ストレー ジコンテナの名前を定義します。データベースに基づくストレージコンテ ナを使用するため、ここには"DB"を指定します。2番目のパラメータは、コ ンテナドライバの接続パラメータです。ここには、先に定義したDSN文字列 を指定します。3番目のパラメータは、スクリプトの先頭で定義したログイ ン画面を表示する関数の名前です。 </para> <para> ここで、認証オブジェクトが初期化され、ユーザがログイン済みかどうか を確かめることが必要となります。これは、 <function>getAuth</function>により簡単に行うことができます。この関 数が&true;を返した場合、このページの内容をそのユーザに渡すことが出 来ます。 </para> <warning> <para> 現在、register_globals=onとして以下のようにすることはできません。 <programlisting role="php"> <![CDATA[ $auth = new Auth(...); ]]> </programlisting> これは、$authはPEAR::Authで使用されるセッション変数でもあるからで す。 </para> </warning> <para> 以下に、PEAR::Authの関数に関する詳細な情報が既述されています。 </para> </refsect1> <refsect1 id="packages.Auth.Auth.Auth"> <title>Auth::Auth</title> <funcsynopsis> <funcprototype> <funcdef><function>Auth::Auth</function></funcdef> <paramdef>string <parameter>storageDriver</parameter></paramdef> <paramdef>mixed <parameter>options</parameter></paramdef> <paramdef>string <parameter>loginFunction</parameter></paramdef> </funcprototype> </funcsynopsis> <para> 認証システムのコンストラクタです。最初のパラメータは、使用するスト レージコンテナの名前です。2番目のパラメータは、何らかのログイン情報 を含む文字列またはストレージドライバ用のオプションを含む配列のどち らかとします。 </para> <para> 3番目のパラメータは、ログイン画面を表示するユーザ定義関数の名前です。 </para> <example> <title>別のDBパラメータを使用する</title> <programlisting role="php"> require_once "Auth/Auth.php"; function myOutput($username, $status) { ... /** コードについては例1を参照 */ } $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 "認証に成功しました。"; } </programlisting> </example> <para> この例は、データベーステーブルの名前とカラム名を変更する方法を示し ています。この例では、テーブル myAuthを使用し、フィールド myUserColumnからusername、フィールドmyPasswordColumnからpasswordを selectしています。このフィールドのデフォルト値は、auth、username、 passwordです。 </para> <para> この機能は、PEAR::Authがデフォルトで使用するデータベース配置と異な るデータベースでPEAR::Authを使用したい場合に必要となります。 </para> </refsect1> <refsect1 id="packages.Auth.Auth.start"> <title>Auth::start</title> <funcsynopsis> <funcprototype> <funcdef><function>Auth::start</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> <para> 認証処理を開始します。 </para> </refsect1> <refsect1 id="packages.Auth.Auth.getAuth"> <title>Auth::getAuth</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>Auth::getAuth</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> <para> ユーザが認証済みかどうか確認します。 </para> <para> ユーザが認証済みの場合、この関数は&true;を返します。その他の場合は、 &false;を返します。 </para> <para> 使用例については、<function>Auth::Auth</function>を参照下さい。 </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/ja/packages/authentication/auth_http.xml +++ peardoc/ja/packages/authentication/auth_http.xml <?xml encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry id="packages.Auth.Auth_HTTP"> <refnamediv> <refname><classname>Auth_HTTP</classname></refname> <refpurpose> PHPでHTTP認証を行う </refpurpose> </refnamediv> <refsect1 id="packages.Auth.Auth_HTTP.Auth_HTTP"> <title>Auth_HTTP::Auth_HTTP</title> <funcsynopsis> <funcprototype> <funcdef><function>Auth::Auth</function></funcdef> <paramdef>string <parameter>storageDriver</parameter></paramdef> <paramdef>mixed <parameter>options</parameter></paramdef> </funcprototype> </funcsynopsis> <para> 認証システムのコンストラクタです。最初のパラメータは、使用するスト レージコンテナの名前です。2番目のパラメータは、何らかのログイン情報 を含む文字列またはストレージドライバ用のオプションを含む配列のどち らかとします。 </para> <para> コンストラクタのパラメータの使用法に関するより詳細な情報については、 <link linkend="packages.Auth.Auth">PEAR::Auth</link>のドキュメント を参照下さい。 </para> <example> <title>簡単な使用例</title> <programlisting role="php"> require_once "Auth_HTTP/Auth_HTTP.php"; $a = new Auth_HTTP("DB", "mysql://test:test@localhost/test"); $a->start(); </programlisting> </example> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->