php/archived-doc-ja
1
0
Fork 0
mirror of https://github.com/php/doc-ja.git synced 2026-03-23 22:52:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

oauth : fix XML by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-19 03:21:44 +00:00
parent 6ce2ae43e1
commit d3ac951bca
51 changed files with 437 additions and 502 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
reference/oauth/book.xml
View File

@@ -1,31 +1,29 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 68c2c871505aadf983f16113c5b077b335ce8d76 Maintainer: takagi Status: ready -->
<book xml:id="book.oauth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.oauth">
<?phpdoc extension-membership="pecl" ?>
<title>OAuth</title>
<preface xml:id="intro.oauth">
&reftitle.intro;
<para>
<simpara>
この拡張モジュールは、OAuth 1.0a コンシューマおよびプロバイダの機能を提供します。
OAuth は HTTP 上に構築された認証プロトコルで、
アプリケーションからデータへのアクセスが安全にできるようになります。
アプリケーション側でユーザー名やパスワードを保存する必要はありません。
</para>
</simpara>
</preface>
&reference.oauth.setup;
&reference.oauth.constants;
&reference.oauth.examples;
&reference.oauth.reference;
&reference.oauth.oauth;
&reference.oauth.oauth;
&reference.oauth.oauthprovider;
&reference.oauth.oauthexception;
&reference.oauth.oauthexception;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -46,4 +44,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

11
reference/oauth/configure.xml
View File

@@ -1,16 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: af4410a7e15898c3dbe83d6ea38246745ed9c6fb Maintainer: takagi Status: ready -->
<section xml:id="oauth.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pear.package;oauth">&url.pear.package;oauth</link>
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

42
reference/oauth/constants.xml
View File

@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.constants">
&reftitle.constants;
&extension.constants;
<para>
<simpara>
これらの定数の大半には何らかの問題があります。問題点については OAuth の公式ページにも
<link xlink:href="&url.oauth.problemreporting;">問題一覧</link> があります。
ここで扱う定数名は PHP 固有のものですが、命名方式は似ています。
</para>
</simpara>
<variablelist>
<!-- TODO: Ensure each constant mentions the exact oauth API name/value pair. -->
<varlistentry xml:id="constant.oauth-sig-method-rsasha1">
@@ -28,9 +28,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
OAuth <emphasis>HMAC-SHA1</emphasis> 署名方式。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-sig-method-hmacsha256">
@@ -50,10 +50,10 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
この定数は、OAuth パラメータを
<literal>Authorization</literal> ヘッダ内に記述することを表します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-auth-type-none">
@@ -62,9 +62,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
この定数は、NoAuth OAuth リクエストを表します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-auth-type-uri">
@@ -73,9 +73,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
この定数は、OAuth パラメータをリクエスト <acronym>URI</acronym> に記述することを表します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-auth-type-form">
@@ -84,9 +84,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
この定数は、OAuth パラメータを HTTP POST の本文の一部として記述することを表します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-get">
@@ -95,9 +95,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
<acronym>GET</acronym> メソッドを OAuth リクエストで使用します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-post">
@@ -106,9 +106,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
<acronym>POST</acronym> メソッドを OAuth リクエストで使用します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-put">
@@ -117,9 +117,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
<acronym>PUT</acronym> メソッドを OAuth リクエストで使用します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-head">
@@ -128,9 +128,9 @@
(<type>string</type>)
</term>
<listitem>
<para>
<simpara>
<acronym>HEAD</acronym> メソッドを OAuth リクエストで使用します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-delete">

22
reference/oauth/functions/oauth-get-sbs.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: mumumu Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: mumumu Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-get-sbs">
<refnamediv>
<refname>oauth_get_sbs</refname>
@@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>request_parameters</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
pecl/oauth に関するSBSを生成します
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,25 +26,25 @@
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
<para>
<simpara>
HTTPメソッド
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
<simpara>
エンコードするURI
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>request_parameters</parameter></term>
<listitem>
<para>
<simpara>
リクエストパラメータの配列
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
SBSを返します
</para>
</simpara>
</refsect1>
</refentry>

14
reference/oauth/functions/oauth-urlencode.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-urlencode">
<refnamediv>
<refname>oauth_urlencode</refname>
@@ -13,9 +13,9 @@
<type>string</type><methodname>oauth_urlencode</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
URI を <link xlink:href="&url.rfc;3686">RFC 3686</link> 形式でエンコードします。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
<simpara>
エンコードしたい URI。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<link xlink:href="&url.rfc;3686">RFC 3686</link> 形式でエンコードした文字列を返します。
</para>
</simpara>
</refsect1>
</refentry>

16
reference/oauth/oauth.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c44e9cb68b9b65771f9c45db2c07a06c63d71359 Maintainer: takagi Status: ready -->
<reference xml:id="class.oauth" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.oauth" role="class">
<title>OAuth クラス</title>
<titleabbrev>OAuth</titleabbrev>
@@ -11,10 +10,10 @@
<!-- {{{ OAuth intro -->
<section xml:id="oauth.intro">
&reftitle.intro;
<para>
<simpara>
OAuth 拡張モジュールは、データプロバイダとやりとりするためのシンプルなインターフェイスを提供します。
OAuth HTTP 仕様を用いることで、プライベートなリソースを保護します。
</para>
</simpara>
</section>
<!-- }}} -->
@@ -65,19 +64,19 @@
<varlistentry xml:id="oauth.props.debug">
<term><varname>debug</varname></term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="oauth.props.sslchecks">
<term><varname>sslChecks</varname></term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="oauth.props.debuginfo">
<term><varname>debugInfo</varname></term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
</variablelist>
@@ -88,7 +87,6 @@
&reference.oauth.entities.oauth;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/oauth/oauth/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.construct">
<refnamediv>
<refname>OAuth::__construct</refname>
@@ -16,9 +16,9 @@
<methodparam choice="opt"><type>string</type><parameter>signature_method</parameter><initializer><constant>OAUTH_SIG_METHOD_HMACSHA1</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>auth_type</parameter><initializer>0</initializer></methodparam>
</constructorsynopsis>
<para>
<simpara>
新しい OAuth オブジェクトを作成します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,36 +27,36 @@
<varlistentry>
<term><parameter>consumer_key</parameter></term>
<listitem>
<para>
<simpara>
サービスプロバイダが提供する consumer key。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>consumer_secret</parameter></term>
<listitem>
<para>
<simpara>
サービスプロバイダが提供する consumer secret。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signature_method</parameter></term>
<listitem>
<para>
<simpara>
このオプションのパラメータで、使用する署名方式を定義します。
デフォルトは <constant>OAUTH_SIG_METHOD_HMACSHA1</constant> (HMAC-SHA1) です。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_type</parameter></term>
<listitem>
<para>
<simpara>
このオプションのパラメータで、OAuth パラメータをコンシューマに渡す方法を定義します。
デフォルトは <constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant>
(<literal>Authorization</literal> ヘッダを使用する) です。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

16
reference/oauth/oauth/destruct.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1df54c547078be837f9b9c33dc3ac7f292f447c0 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.destruct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.destruct">
<refnamediv>
<refname>OAuth::__destruct</refname>
<refpurpose>デストラクタ</refpurpose>
@@ -12,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuth::__destruct</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
デストラクタです。
</para>
</simpara>
&warn.undocumented.func;
@@ -29,9 +28,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -42,7 +41,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/oauth/oauth/disabledebug.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.disabledebug">
<refnamediv>
@@ -14,11 +14,11 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableDebug</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
冗長なリクエスト情報を無効にします (デフォルトは無効です)。
あるいは、<link linkend="oauth.props.debug">debug</link> プロパティに
&false; を設定することによってもデバッグを無効にできます。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,9 +28,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/oauth/oauth/disableredirects.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1df54c547078be837f9b9c33dc3ac7f292f447c0 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.disableredirects" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.disableredirects">
<refnamediv>
<refname>OAuth::disableRedirects</refname>
<refpurpose>リダイレクトを無効にする</refpurpose>
@@ -12,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableRedirects</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
リダイレクト先を自動的にたどる機能を無効にし、リクエストを手動でリダイレクトできるようにします。
</para>
</simpara>
&warn.undocumented.func;
@@ -29,9 +28,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -42,7 +41,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/oauth/oauth/disablesslchecks.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.disablesslchecks">
<refnamediv>
@@ -14,12 +14,12 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableSSLChecks</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
通常の SSL ピア証明書およびホストのチェックを無効にします。
これは実運用に使うものではありません。
あるいは、<parameter>sslChecks</parameter> メンバーに
&false; を設定することによっても SSL チェックを無効にできます。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,9 +29,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

10
reference/oauth/oauth/enabledebug.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.enabledebug">
<refnamediv>
@@ -14,12 +14,12 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableDebug</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
デバッグに使用できる、冗長なリクエスト情報の出力を有効にします。
デバッグ情報は <parameter>debugInfo</parameter> メンバーに格納されます。
あるいは、<parameter>debug</parameter> メンバーに
&false; 以外の値を設定することによってもデバッグを有効にできます。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,9 +29,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/oauth/oauth/enableredirects.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1df54c547078be837f9b9c33dc3ac7f292f447c0 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.enableredirects" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.enableredirects">
<refnamediv>
<refname>OAuth::enableRedirects</refname>
<refpurpose>リダイレクトを有効にする</refpurpose>
@@ -12,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableRedirects</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
自動的にリダイレクトをたどりまず。デフォルトで有効となっています。
</para>
</simpara>
&warn.undocumented.func;
@@ -29,9 +28,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -42,7 +41,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/oauth/oauth/enablesslchecks.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.enablesslchecks">
<refnamediv>
@@ -14,12 +14,12 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableSSLChecks</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
通常の SSL ピア証明書およびホストのチェックを有効にします (デフォルトは有効です)。
あるいは、<link linkend="oauth.props.sslchecks">sslChecks</link>
プロパティに
&false; 以外の値を設定することによっても SSL チェックを有効にできます。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,9 +29,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

30
reference/oauth/oauth/fetch.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.fetch">
<refnamediv>
@@ -17,9 +17,9 @@
<methodparam choice="opt"><type>string</type><parameter>http_method</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>http_headers</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
リソースを取得します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,40 +28,40 @@
<varlistentry>
<term><parameter>protected_resource_url</parameter></term>
<listitem>
<para>
<simpara>
OAuth で保護されたリソースへの URL。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extra_parameters</parameter></term>
<listitem>
<para>
<simpara>
リソースへのリクエストとともに送信する追加パラメータ。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
<para>
<simpara>
<constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant> OAUTH 定数 のいずれか。
GET、POST、PUT、HEAD そして DELETE があります。
</para>
<para>
</simpara>
<simpara>
HEAD (<constant>OAUTH_HTTP_METHOD_HEAD</constant>) は、
実際のリクエストの前に
(OAuth 認証情報が <literal>Authorization</literal> ヘッダにあるかどうかなどの)
情報を取得するときに有用です。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_headers</parameter></term>
<listitem>
<para>
<simpara>
HTTP クライアントヘッダ (User-Agent や Accept など)。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -69,9 +69,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

26
reference/oauth/oauth/generatesignature.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.generatesignature" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.generatesignature">
<refnamediv>
<refname>OAuth::generateSignature</refname>
<refpurpose>シグネチャを生成する</refpurpose>
@@ -16,9 +15,9 @@
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>extra_parameters</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
最後の HTTP メソッド、URL そしてパラメータ文字列あるいは配列にもとづいてシグネチャを生成します。
</para>
</simpara>
</refsect1>
@@ -28,25 +27,25 @@
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
<para>
<simpara>
リクエストの HTTP メソッド。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
<simpara>
リクエストの URL。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extra_parameters</parameter></term>
<listitem>
<para>
<simpara>
パラメータ文字列あるいは配列。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -54,14 +53,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
生成されたシグネチャを文字列で返します。&return.falseforfailure;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/oauth/oauth/getaccesstoken.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getaccesstoken">
<refnamediv>
@@ -16,9 +16,9 @@
<methodparam choice="opt"><type>string</type><parameter>verifier_token</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>http_method</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
アクセストークン、secret そして追加のレスポンスパラメータをサービスプロバイダから取得します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,27 +27,27 @@
<varlistentry>
<term><parameter>access_token_url</parameter></term>
<listitem>
<para>
<simpara>
アクセストークン API の URL。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_session_handle</parameter></term>
<listitem>
<para>
<simpara>
認証セッションハンドル。このパラメータはコア OAuth 1.0
仕様を引用していませんが、大手プロバイダでは実装されているでしょう。
詳細な情報は
<link xlink:href="&url.oauth.scale;">ScalableOAuth</link>
を参照ください。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>verifier_token</parameter></term>
<listitem>
<para>
<simpara>
1.0a をサポートするサービスプロバイダでは、リクエストトークンとアクセストークンを交換する際に
<parameter>verifier_token</parameter> を渡す必要があります。
<parameter>verifier_token</parameter> が <parameter>$_GET</parameter>
@@ -57,15 +57,15 @@
詳細な情報は
<link xlink:href="&url.oauth.scale;">ScalableOAuth</link>
を参照ください。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
<para>
<simpara>
利用する HTTP メソッド。<literal>GET</literal> や <literal>POST</literal> など。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -73,9 +73,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
成功した場合は OAuth レスポンスをパースした配列、失敗した場合は &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/oauth/oauth/getcapath.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1df54c547078be837f9b9c33dc3ac7f292f447c0 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.getcapath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getcapath">
<refnamediv>
<refname>OAuth::getCAPath</refname>
<refpurpose>CA 情報を取得する</refpurpose>
@@ -12,13 +11,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>OAuth::getCAPath</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
認証局の情報を取得します。ここには、
<methodname>OAuth::setCaPath</methodname> で設定した
ca_path や ca_info が含まれます。
</para>
</simpara>
&warn.undocumented.func;
@@ -31,10 +30,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
認証局の情報を含む配列を返します。返される連想配列のキーには
<literal>ca_path</literal> と <literal>ca_info</literal> が含まれます。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -46,7 +45,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/oauth/oauth/getlastresponse.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getlastresponse">
<refnamediv>
<refname>OAuth::getLastResponse</refname>
@@ -13,9 +13,9 @@
<modifier>public</modifier> <type>string</type><methodname>OAuth::getLastResponse</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
直近のリクエストに対するレスポンスをそのままの形式で取得します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
直近のレスポンスを含む文字列を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/oauth/oauth/getlastresponseheaders.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.getlastresponseheaders" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getlastresponseheaders">
<refnamediv>
<refname>OAuth::getLastResponseHeaders</refname>
<refpurpose>最後のレスポンスのヘッダを取得する</refpurpose>
@@ -12,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>OAuth::getLastResponseHeaders</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
最後のレスポンスのヘッダを取得します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,14 +25,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
最後のレスポンスのヘッダを文字列で返します。&return.falseforfailure;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/oauth/oauth/getlastresponseinfo.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getlastresponseinfo">
<refnamediv>
<refname>OAuth::getLastResponseInfo</refname>
@@ -13,9 +13,9 @@
<modifier>public</modifier> <type>array</type><methodname>OAuth::getLastResponseInfo</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
直近のレスポンスに関する HTTP 情報を取得します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,10 +25,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
直近のリクエストに対するレスポンスの情報を含む配列を返します。
<function>curl_getinfo</function> の定数が使われます。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

26
reference/oauth/oauth/getrequestheader.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.getrequestheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getrequestheader">
<refnamediv>
<refname>OAuth::getRequestHeader</refname>
<refpurpose>OAuth ヘッダ文字列シグネチャを生成する</refpurpose>
@@ -16,9 +15,9 @@
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>extra_parameters</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
最後の HTTP メソッド、URL そしてパラメータ文字列あるいは配列にもとづいて OAuth ヘッダ文字列シグネチャを生成します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,25 +26,25 @@
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
<para>
<simpara>
リクエストの HTTP メソッド。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
<simpara>
リクエストの URL。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extra_parameters</parameter></term>
<listitem>
<para>
<simpara>
パラメータ文字列あるいは配列。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -53,14 +52,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
生成されたリクエストヘッダを文字列で返します。&return.falseforfailure;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/oauth/oauth/getrequesttoken.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getrequesttoken">
<refnamediv>
@@ -16,9 +16,9 @@
<methodparam choice="opt"><type>string</type><parameter>callback_url</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>http_method</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
リクエストトークン、secret そして追加のレスポンスパラメータをサービスプロバイダから取得します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,26 +27,26 @@
<varlistentry>
<term><parameter>request_token_url</parameter></term>
<listitem>
<para>
<simpara>
リクエストトークン API の URL。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback_url</parameter></term>
<listitem>
<para>
<simpara>
OAuth コールバック URL。<parameter>callback_url</parameter>
に空の値を渡すと、"oob" に設定されて OAuth 2009.1 advisory を指すことになります。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
<para>
<simpara>
利用する HTTP メソッド。<literal>GET</literal> や <literal>POST</literal> など。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -54,9 +54,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
成功した場合は OAuth レスポンスをパースした配列、失敗した場合は &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

10
reference/oauth/oauth/setauthtype.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setauthtype">
<refnamediv>
@@ -14,9 +14,9 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::setAuthType</methodname>
<methodparam><type>int</type><parameter>auth_type</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
OAuth パラメータをどこで渡すかを設定します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -69,11 +69,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
パラメータを正しく設定した場合に &true; を返します。
それ以外の場合 (無効な <parameter>auth_type</parameter> を渡した場合など)
は &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

18
reference/oauth/oauth/setcapath.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setcapath">
<refnamediv>
@@ -15,9 +15,9 @@
<methodparam choice="opt"><type>string</type><parameter>ca_path</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>ca_info</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
認証局 (<acronym>CA</acronym>) のパスと情報を設定します。
</para>
</simpara>
&warn.undocumented.func;
@@ -29,17 +29,17 @@
<varlistentry>
<term><parameter>ca_path</parameter></term>
<listitem>
<para>
<simpara>
設定したい CA パス。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ca_info</parameter></term>
<listitem>
<para>
<simpara>
設定したい CA 情報。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -48,10 +48,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
成功した場合に &true; を返します。<parameter>ca_path</parameter>
あるいは <parameter>ca_info</parameter> が無効な形式の場合は &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

14
reference/oauth/oauth/setnonce.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setnonce">
<refnamediv>
@@ -14,9 +14,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::setNonce</methodname>
<methodparam><type>string</type><parameter>nonce</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
それ以降のすべてのリクエスト用のノンスを設定します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
<para>
<simpara>
oauth_nonce の値。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,10 +35,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
成功した場合に &true; を返します。
<parameter>nonce</parameter> が無効な場合に &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

22
reference/oauth/oauth/setrequestengine.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 81ba8c58c0bd938de19a7e9c40db23d847903be8 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.setrequestengine" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setrequestengine">
<refnamediv>
<refname>OAuth::setRequestEngine</refname>
<refpurpose>setRequestEngine</refpurpose>
@@ -14,9 +13,9 @@
<modifier>public</modifier> <type>void</type><methodname>OAuth::setRequestEngine</methodname>
<methodparam><type>int</type><parameter>reqengine</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
HTTP リクエストの送信に使うリクエストエンジンを設定します。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,11 +27,11 @@
<varlistentry>
<term><parameter>reqengine</parameter></term>
<listitem>
<para>
<simpara>
使いたいリクエストエンジン。<constant>OAUTH_REQENGINE_STREAMS</constant>
は PHP のストリームを使い、<constant>OAUTH_REQENGINE_CURL</constant> は
<link linkend="book.curl">Curl</link> を使います。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,17 +39,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
無効なリクエストエンジンを選んだ場合には
<classname>OAuthException</classname> が発生します。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -78,7 +77,6 @@ $consumer->setRequestEngine(OAUTH_REQENGINE_STREAMS);
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/oauth/oauth/setrsacertificate.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setrsacertificate">
<refnamediv>
@@ -14,9 +14,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::setRSACertificate</methodname>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<acronym>RSA</acronym> 証明書を設定します。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,9 +28,9 @@
<varlistentry>
<term><parameter>cert</parameter></term>
<listitem>
<para>
<simpara>
<acronym>RSA</acronym> 証明書。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,10 +38,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
成功した場合に &true;、失敗した場合
(RSA 証明書がパースできなかった場合はど) に &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

20
reference/oauth/oauth/setsslchecks.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: dd07341fae2c414adc1f700be0890ff32e8daab4 Maintainer: takagi Status: ready -->
<refentry xml:id="oauth.setsslchecks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setsslchecks">
<refnamediv>
<refname>OAuth::setSSLChecks</refname>
<refpurpose>リクエストに固有の SSL チェックを調整する</refpurpose>
@@ -14,9 +13,9 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::setSSLChecks</methodname>
<methodparam><type>int</type><parameter>sslcheck</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
リクエストに固有の SSL チェックを調整します。
</para>
</simpara>
&warn.undocumented.func;
</refsect1>
@@ -26,9 +25,9 @@
<varlistentry>
<term><parameter>sslcheck</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,14 +35,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/oauth/oauth/settimestamp.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.settimestamp">
<refnamediv>
@@ -14,9 +14,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::setTimestamp</methodname>
<methodparam><type>string</type><parameter>timestamp</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
それ以降のリクエスト用の OAuth タイムスタンプを設定します。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,9 +28,9 @@
<varlistentry>
<term><parameter>timestamp</parameter></term>
<listitem>
<para>
<simpara>
タイムスタンプ。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,10 +38,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true; を返します。
<parameter>timestamp</parameter> が無効な形式の場合は &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

18
reference/oauth/oauth/settoken.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.settoken">
<refnamediv>
<refname>OAuth::setToken</refname>
@@ -14,9 +14,9 @@
<methodparam><type>string</type><parameter>token</parameter></methodparam>
<methodparam><type>string</type><parameter>token_secret</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
それ以降のリクエスト用のトークンと secret を設定します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>token</parameter></term>
<listitem>
<para>
<simpara>
OAuth トークン。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>token_secret</parameter></term>
<listitem>
<para>
<simpara>
OAuth トークン secret。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,9 +43,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

14
reference/oauth/oauth/setversion.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d85b5e9045b941fb8ab48566a9d1ef703c2c805 Maintainer: takagi Status: ready -->
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setversion">
<refnamediv>
<refname>OAuth::setVersion</refname>
@@ -13,9 +13,9 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::setVersion</methodname>
<methodparam><type>string</type><parameter>version</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
それ以降のリクエスト用の OAuth のバージョンを設定します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
<simpara>
OAuth のバージョン。デフォルトは常に "1.0"。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>

22
reference/oauth/oauthexception.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 38e65393c58b006a923c5bb7878aee5c73e21b20 Maintainer: takagi Status: ready -->
<reference xml:id="class.oauthexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.oauthexception" role="class">
<title>OAuthException クラス</title>
<titleabbrev>OAuthException</titleabbrev>
@@ -12,10 +11,10 @@
<!-- {{{ OAuthException intro -->
<section xml:id="oauthexception.intro">
&reftitle.intro;
<para>
<simpara>
この例外は、OAuth 拡張モジュールの使用中に例外エラーが発生したときにスローされます。
デバッグに有用な情報が含まれています。
</para>
</simpara>
</section>
<!-- }}} -->
@@ -31,7 +30,7 @@
<ooclass>
<classname>OAuthException</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Exception</classname>
@@ -49,17 +48,17 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ OAuthException properties -->
<section xml:id="oauthexception.props">
&reftitle.properties;
@@ -67,13 +66,13 @@
<varlistentry xml:id="oauthexception.props.lastresponse">
<term><varname>lastResponse</varname></term>
<listitem>
<para>発生した例外のレスポンス (存在する場合)。</para>
<simpara>発生した例外のレスポンス (存在する場合)。</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="oauthexception.props.debuginfo">
<term><varname>debugInfo</varname></term>
<listitem>
<para></para>
<simpara/>
</listitem>
</varlistentry>
</variablelist>
@@ -84,7 +83,6 @@
</partintro>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b1ef3427055358ff6d092ddb0a8b5e748a7bbbb2 Maintainer: takagi Status: ready -->
<reference xml:id="class.oauthprovider" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.oauthprovider" role="class">
<title>OAuthProvider クラス</title>
<titleabbrev>OAuthProvider</titleabbrev>
@@ -12,17 +11,17 @@
<!-- {{{ OAuthProvider intro -->
<section xml:id="oauthprovider.intro">
&reftitle.intro;
<para>
<simpara>
OAuth プロバイダを管理するクラスです。
</para>
<para>
</simpara>
<simpara>
別のサイトで公開されている詳細なチュートリアル
<link xlink:href="&url.oauth.provider.tutorial;">Writing an OAuth Provider Service</link>
には、このサービスを作成する方法がハンズオン形式で公開されています。
OAuth 拡張モジュールのソースの中には
<link xlink:href="&url.oauth.examples;">OAuth プロバイダのサンプル</link>
もあります。
</para>
</simpara>
</section>
<!-- }}} -->
@@ -40,9 +39,9 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.oauthprovider')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.oauthprovider')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -53,7 +52,6 @@
&reference.oauth.entities.oauthprovider;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider/addrequiredparameter.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b65b2d86df7e3ac423c23a3c8358672b0d9033c Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.addrequiredparameter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.addrequiredparameter">
<refnamediv>
<refname>OAuthProvider::addRequiredParameter</refname>
<refpurpose>必須パラメータを追加する</refpurpose>
@@ -14,9 +13,9 @@
<modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>OAuthProvider::addRequiredParameter</methodname>
<methodparam><type>string</type><parameter>req_params</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
oauth プロバイダの必須パラメータを追加します。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>req_params</parameter></term>
<listitem>
<para>
<simpara>
必須パラメータ。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -51,7 +50,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/oauth/oauthprovider/callconsumerhandler.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b65b2d86df7e3ac423c23a3c8358672b0d9033c Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.callconsumerhandler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.callconsumerhandler">
<refnamediv>
<refname>OAuthProvider::callconsumerHandler</refname>
<refpurpose>consumerNonceHandler コールバックをコールする</refpurpose>
@@ -12,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::callconsumerHandler</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
コンシューマハンドラコールバックとして登録した関数をコールします。この関数は
<methodname>OAuthProvider::consumerHandler</methodname> で登録します。
</para>
</simpara>
&warn.undocumented.func;
@@ -30,16 +29,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&oauth.callback.error;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -50,7 +49,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/oauth/oauthprovider/calltimestampnoncehandler.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b65b2d86df7e3ac423c23a3c8358672b0d9033c Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.calltimestampnoncehandler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.calltimestampnoncehandler">
<refnamediv>
<refname>OAuthProvider::callTimestampNonceHandler</refname>
<refpurpose>timestampNonceHandler コールバックをコールする</refpurpose>
@@ -12,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::callTimestampNonceHandler</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
タイムスタンプハンドラコールバックとして登録した関数をコールします。この関数は
<methodname>OAuthProvider::timestampNonceHandler</methodname> で登録します。
</para>
</simpara>
&warn.undocumented.func;
@@ -30,16 +29,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&oauth.callback.error;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -50,7 +49,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/oauth/oauthprovider/calltokenhandler.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b65b2d86df7e3ac423c23a3c8358672b0d9033c Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.calltokenhandler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.calltokenhandler">
<refnamediv>
<refname>OAuthProvider::calltokenHandler</refname>
<refpurpose>tokenNonceHandler コールバックをコールする</refpurpose>
@@ -12,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::calltokenHandler</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
トークンハンドラコールバックとして登録した関数をコールします。この関数は
<methodname>OAuthProvider::tokenHandler</methodname> でコールします。
</para>
</simpara>
&warn.undocumented.func;
@@ -30,16 +29,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&oauth.callback.error;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -50,7 +49,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/oauth/oauthprovider/checkoauthrequest.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 976425d4f6eec32448be3cc22ec063015921b753 Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.checkoauthrequest" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.checkoauthrequest">
<refnamediv>
<refname>OAuthProvider::checkOAuthRequest</refname>
<refpurpose>oauth リクエストをチェックする</refpurpose>
@@ -15,9 +14,9 @@
<methodparam choice="opt"><type>string</type><parameter>uri</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>method</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
OAuth リクエストをチェックします。
</para>
</simpara>
&warn.undocumented.func;
@@ -29,19 +28,19 @@
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
<simpara>
オプションの <acronym>URI</acronym>、あるいはエンドポイント。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>method</parameter></term>
<listitem>
<para>
<simpara>
<acronym>HTTP</acronym> メソッド。
<constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant> OAuth 定数
のいずれかをオプションで渡します。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,17 +48,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
HTTP メソッドを検出できない場合には <constant>E_ERROR</constant>
レベルのエラーが発生します。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -70,7 +69,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider/construct.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d8b968e63cba67a082e6e37aee1ebe7821b41258 Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.construct">
<refnamediv>
<refname>OAuthProvider::__construct</refname>
<refpurpose>新しい OAuthProvider オブジェクトを作る</refpurpose>
@@ -14,9 +13,9 @@
<modifier>public</modifier> <methodname>OAuthProvider::__construct</methodname>
<methodparam choice="opt"><type>array</type><parameter>params_array</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
新しい <classname>OAuthProvider</classname> オブジェクトのインスタンスを作成します。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,10 +27,10 @@
<varlistentry>
<term><parameter>params_array</parameter></term>
<listitem>
<para>
<simpara>
これらのオプションパラメータを設定できるのは
<link linkend="features.commandline">CLI SAPI</link> のみです。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<classname>OAuthProvider</classname> オブジェクトを返します。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -86,7 +85,6 @@ try {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider/consumerhandler.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.consumerhandler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.consumerhandler">
<refnamediv>
<refname>OAuthProvider::consumerHandler</refname>
<refpurpose>consumerHandler コールバックを設定する</refpurpose>
@@ -14,11 +13,11 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::consumerHandler</methodname>
<methodparam><type>callable</type><parameter>callback_function</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
コンシューマハンドラコールバックを設定します。これは
<methodname>OAuthProvider::callConsumerHandler</methodname>
でコールされる関数です。
</para>
</simpara>
&warn.undocumented.func;
@@ -30,9 +29,9 @@
<varlistentry>
<term><parameter>callback_function</parameter></term>
<listitem>
<para>
<simpara>
<type>callable</type> 関数名。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -78,7 +77,6 @@ function lookupConsumer($provider) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/oauth/oauthprovider/generatetoken.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.generatetoken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.generatetoken">
<refnamediv>
<refname>OAuthProvider::generateToken</refname>
<refpurpose>ランダムなトークンを生成する</refpurpose>
@@ -15,9 +14,9 @@
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>strong</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
擬似乱数を使ってランダムなバイトの文字列を生成します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,19 +25,19 @@
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
<simpara>
トークンの長さ。バイト単位で指定します。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>strong</parameter></term>
<listitem>
<para>
<simpara>
&true; に設定すると、エントロピーとして <literal>/dev/random</literal> を使います。
それ以外の場合は、ブロックされることのない <literal>/dev/urandom</literal> を使います。
このパラメータは、Windows では無視されます。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,19 +45,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
生成されたトークンをバイト文字列で返します。
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
<parameter>strong</parameter> パラメータが &true; のときは、
(十分な量の初期ランダムデータがなかったなどの理由で)
代替 <function>rand</function> 実装を使うことになった場合に
<constant>E_WARNING</constant> レベルのエラーが発生します。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -91,10 +90,10 @@ b6a82c27
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
十分な量のランダムデータがシステムから得られなかった場合、この関数は
PHP の <function>rand</function> 関数の実装を使って残りのバイトを埋めます。
</para>
</simpara>
</note>
</refsect1>
@@ -107,7 +106,6 @@ b6a82c27
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider/is2leggedendpoint.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b65b2d86df7e3ac423c23a3c8358672b0d9033c Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.is2leggedendpoint" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.is2leggedendpoint">
<refnamediv>
<refname>OAuthProvider::is2LeggedEndpoint</refname>
<refpurpose>is2LeggedEndpoint</refpurpose>
@@ -14,9 +13,9 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::is2LeggedEndpoint</methodname>
<methodparam><type>mixed</type><parameter>params_array</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
2-legged フローあるいはリクエストの署名。トークンは不要です。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>params_array</parameter></term>
<listitem>
<para>
<simpara>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<classname>OAuthProvider</classname> オブジェクトを返します。
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -69,7 +68,6 @@ $provider->is2LeggedEndpoint(true);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider/isrequesttokenendpoint.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b65b2d86df7e3ac423c23a3c8358672b0d9033c Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.isrequesttokenendpoint" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.isrequesttokenendpoint">
<refnamediv>
<refname>OAuthProvider::isRequestTokenEndpoint</refname>
<refpurpose>isRequestTokenEndpoint を設定する</refpurpose>
@@ -14,9 +13,9 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::isRequestTokenEndpoint</methodname>
<methodparam><type>bool</type><parameter>will_issue_request_token</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -28,11 +27,11 @@
<varlistentry>
<term><parameter>will_issue_request_token</parameter></term>
<listitem>
<para>
<simpara>
リクエストトークンを発行するか否かを設定します。つまり
<methodname>OAuthProvider::tokenHandler</methodname>
がコールされる必要があるかどうかを決めるということです。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -54,7 +53,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider/removerequiredparameter.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a516c3d9a457dc52ebe6bd7377dde238d0ce551d Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.removerequiredparameter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.removerequiredparameter">
<refnamediv>
<refname>OAuthProvider::removeRequiredParameter</refname>
<refpurpose>必須パラメータを削除する</refpurpose>
@@ -14,9 +13,9 @@
<modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>OAuthProvider::removeRequiredParameter</methodname>
<methodparam><type>string</type><parameter>req_params</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
必須パラメータを削除します。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>req_params</parameter></term>
<listitem>
<para>
<simpara>
削除したい必須パラメータ。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -52,7 +51,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/oauth/oauthprovider/reportproblem.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.reportproblem" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.reportproblem">
<refnamediv>
<refname>OAuthProvider::reportProblem</refname>
<refpurpose>問題を報告する</refpurpose>
@@ -15,11 +14,11 @@
<methodparam><type>string</type><parameter>oauthexception</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>send_headers</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
問題を、<classname>OAuthException</classname> 形式で渡します。設定できる問題については
<link linkend="oauth.constants">OAuth 定数</link> のセクションを参照ください。
</para>
</simpara>
&warn.undocumented.func;
</refsect1>
@@ -30,9 +29,9 @@
<varlistentry>
<term><parameter>oauthexception</parameter></term>
<listitem>
<para>
<simpara>
<classname>OAuthException</classname>。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -54,7 +53,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/oauth/oauthprovider/setparam.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 16f141aeafbcc8a5e70f2acb6798765a78def32c Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.setparam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.setparam">
<refnamediv>
<refname>OAuthProvider::setParam</refname>
<refpurpose>パラメータを設定する</refpurpose>
@@ -15,9 +14,9 @@
<methodparam><type>string</type><parameter>param_key</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>param_val</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
パラメータを設定します。
</para>
</simpara>
&warn.undocumented.func;
@@ -29,20 +28,20 @@
<varlistentry>
<term><parameter>param_key</parameter></term>
<listitem>
<para>
<simpara>
パラメータのキー。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param_val</parameter></term>
<listitem>
<para>
<simpara>
パラメータの値。
</para>
<para>
</simpara>
<simpara>
パラメータをシグネチャの検証から除外するには、この値を &null; にします。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -63,7 +62,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/oauth/oauthprovider/setrequesttokenpath.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a516c3d9a457dc52ebe6bd7377dde238d0ce551d Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.setrequesttokenpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.setrequesttokenpath">
<refnamediv>
<refname>OAuthProvider::setRequestTokenPath</refname>
<refpurpose>リクエストトークンのパスを設定する</refpurpose>
@@ -14,9 +13,9 @@
<modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>OAuthProvider::setRequestTokenPath</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
リクエストトークンのパスを設定します。
</para>
</simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
パス。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&true;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -51,7 +50,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/oauth/oauthprovider/timestampnoncehandler.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.timestampnoncehandler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.timestampnoncehandler">
<refnamediv>
<refname>OAuthProvider::timestampNonceHandler</refname>
<refpurpose>timestampNonceHandler コールバックを設定する</refpurpose>
@@ -14,11 +13,11 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::timestampNonceHandler</methodname>
<methodparam><type>callable</type><parameter>callback_function</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
タイムスタンプ ノンス ハンドラコールバックを設定します。これは
<methodname>OAuthProvider::callTimestampNonceHandler</methodname>
でコールされる関数です。タイムスタンプやノンスに関するエラーはこのコールバックにスローされます。
</para>
</simpara>
&warn.undocumented.func;
@@ -30,9 +29,9 @@
<varlistentry>
<term><parameter>callback_function</parameter></term>
<listitem>
<para>
<simpara>
<type>callable</type> 関数名。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -59,7 +58,7 @@ function timestampNonceChecker($provider) {
} elseif ($provider->timestamp == '0') {
return OAUTH_BAD_TIMESTAMP;
}
return OAUTH_OK;
}
?>
@@ -76,7 +75,6 @@ function timestampNonceChecker($provider) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/oauth/oauthprovider/tokenhandler.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: takagi Status: ready -->
<refentry xml:id="oauthprovider.tokenhandler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauthprovider.tokenhandler">
<refnamediv>
<refname>OAuthProvider::tokenHandler</refname>
<refpurpose>tokenHandler コールバックを設定する</refpurpose>
@@ -14,11 +13,11 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::tokenHandler</methodname>
<methodparam><type>callable</type><parameter>callback_function</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
トークンハンドラコールバックを設定します。これは
<methodname>OAuthProvider::callTokenHandler</methodname>
でコールされる関数です。
</para>
</simpara>
&warn.undocumented.func;
@@ -30,9 +29,9 @@
<varlistentry>
<term><parameter>callback_function</parameter></term>
<listitem>
<para>
<simpara>
<type>callable</type> 関数名。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -53,7 +52,7 @@
<![CDATA[
<?php
function tokenHandler($provider) {
if ($provider->token === 'rejected') {
return OAUTH_TOKEN_REJECTED;
} elseif ($provider->token === 'revoked') {
@@ -77,7 +76,6 @@ function tokenHandler($provider) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/oauth/setup.xml
View File

@@ -1,19 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 48ce43fe79fa0c9f31f187ea8ec995b4cb13037e Maintainer: takagi Status: ready -->
<chapter xml:id="oauth.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: takagi Status: ready -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setup">
&reftitle.setup;
<section xml:id="oauth.requirements">
&reftitle.required;
<para>
<simpara>
PECL/oauth には、PHP 5.1 以降と ext/hash、そして ext/pcre が必要です。
</para>
<para>
</simpara>
<simpara>
PECL/oauth は、ビルド時に選択した場合に、オプションで libcurl が必要な場合があります。
libcurl を含めてコンパイルする場合、libcurl を HTTPS サポート付きでビルドしなければいけません。
</para>
</simpara>
</section>
<!-- {{{ Installation -->
@@ -21,7 +20,6 @@
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -42,4 +40,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->