archived-doc-ja/reference/oauth/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: takagi Status: ready -->

<appendix xml:id="oauth.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.constants;
 &extension.constants;
 <para>
  これらの定数の大半には何らかの問題があります。問題点については OAuth の公式ページにも
  <link xlink:href="&url.oauth.problemreporting;">問題一覧</link> があります。
  ここで扱う定数名は PHP 固有のものですが、命名方式は似ています。
 </para>
 <para>
  <variablelist>
   <!-- TODO: Ensure each constant mentions the exact oauth API name/value pair. -->
   <varlistentry xml:id="constant.oauth-sig-method-rsasha1">
    <term>
     <constant>OAUTH_SIG_METHOD_RSASHA1</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <simpara>
      OAuth <emphasis>RSA-SHA1</emphasis> 署名方式。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-sig-method-hmacsha1">
    <term>
     <constant>OAUTH_SIG_METHOD_HMACSHA1</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      OAuth <emphasis>HMAC-SHA1</emphasis> 署名方式。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-sig-method-hmacsha256">
    <term>
     <constant>OAUTH_SIG_METHOD_HMACSHA256</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <simpara>
      OAuth <emphasis>HMAC-SHA256</emphasis> 署名方式。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-auth-type-authorization">
    <term>
     <constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      この定数は、OAuth パラメータを
      <literal>Authorization</literal> ヘッダ内に記述することを表します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-auth-type-none">
    <term>
     <constant>OAUTH_AUTH_TYPE_NONE</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      この定数は、NoAuth OAuth リクエストを表します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-auth-type-uri">
    <term>
     <constant>OAUTH_AUTH_TYPE_URI</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      この定数は、OAuth パラメータをリクエスト <acronym>URI</acronym> に記述することを表します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-auth-type-form">
    <term>
     <constant>OAUTH_AUTH_TYPE_FORM</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      この定数は、OAuth パラメータを HTTP POST の本文の一部として記述することを表します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-http-method-get">
    <term>
     <constant>OAUTH_HTTP_METHOD_GET</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      <acronym>GET</acronym> メソッドを OAuth リクエストで使用します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-http-method-post">
    <term>
     <constant>OAUTH_HTTP_METHOD_POST</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      <acronym>POST</acronym> メソッドを OAuth リクエストで使用します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-http-method-put">
    <term>
     <constant>OAUTH_HTTP_METHOD_PUT</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      <acronym>PUT</acronym> メソッドを OAuth リクエストで使用します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-http-method-head">
    <term>
     <constant>OAUTH_HTTP_METHOD_HEAD</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <para>
      <acronym>HEAD</acronym> メソッドを OAuth リクエストで使用します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-http-method-delete">
    <term>
     <constant>OAUTH_HTTP_METHOD_DELETE</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <simpara>
      <acronym>DELETE</acronym> メソッドを OAuth リクエストで使用します。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-reqengine-streams">
    <term>
     <constant>OAUTH_REQENGINE_STREAMS</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <methodname>OAuth::setRequestEngine</methodname> で使用するもので、
      エンジンを <link linkend="book.stream">PHP ストリーム</link> に設定します。
      <link linkend="book.curl">Curl</link> を使う場合は
      <constant>OAUTH_REQENGINE_CURL</constant> を用います。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-reqengine-curl">
    <term>
     <constant>OAUTH_REQENGINE_CURL</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <methodname>OAuth::setRequestEngine</methodname> で使用するもので、
      エンジンを <link linkend="book.curl">Curl</link> に設定します。
      <link linkend="book.stream">PHP streams</link> を使う場合は
      <constant>OAUTH_REQENGINE_STREAMS</constant> を用います。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-ok">
    <term>
     <constant>OAUTH_OK</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      無事に生きています。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-bad-nonce">
    <term>
     <constant>OAUTH_BAD_NONCE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
       <emphasis>oauth_nonce</emphasis> の値が前のリクエストで使われたものなので、
       このリクエストでは使えません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-bad-timestamp">
    <term>
     <constant>OAUTH_BAD_TIMESTAMP</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
       <emphasis>oauth_timestamp</emphasis> の値がサービスプロバイダに受け入れられませんでした。
       この場合、レスポンスには <emphasis>oauth_acceptable_timestamps</emphasis>
       パラメータが含まれていなければなりません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-consumer-key-unknown">
    <term>
     <constant>OAUTH_CONSUMER_KEY_UNKNOWN</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <emphasis>oauth_consumer_key</emphasis> が、一時的にサービスプロバイダに受け入れられませんでした。
      プロバイダ側でコンシューマに制限をかけているなどの可能性が考えられます。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-consumer-key-refused">
    <term>
     <constant>OAUTH_CONSUMER_KEY_REFUSED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      コンシューマキーが拒否されました。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-invalid-signature">
    <term>
     <constant>OAUTH_INVALID_SIGNATURE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
       <emphasis>oauth_signature</emphasis> が無効です。
       サービスプロバイダが算出したシグネチャとマッチしません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-token-used">
    <term>
     <constant>OAUTH_TOKEN_USED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <emphasis>oauth_token</emphasis> が使用済みです。
      これまでのリクエストで既に使用済みであるため、もう使うことはできません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-token-expired">
    <term>
     <constant>OAUTH_TOKEN_EXPIRED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <emphasis>oauth_token</emphasis> の有効期限が切れました。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-token-revoked">
    <term>
     <constant>OAUTH_TOKEN_REVOKED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <emphasis>oauth_token</emphasis> が無効になりました。もう使えません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-token-rejected">
    <term>
     <constant>OAUTH_TOKEN_REJECTED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <emphasis>oauth_token</emphasis> がサービスプロバイダに受け入れられませんでした。
      理由は不明ですが、
      トークンが発行されていない・すでに使用済みである・プロバイダ側で忘れられてしまった
      といった原因が考えられます。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-verifier-invalid">
    <term>
     <constant>OAUTH_VERIFIER_INVALID</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <emphasis>oauth_verifier</emphasis> が無効です。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-parameter-absent">
    <term>
     <constant>OAUTH_PARAMETER_ABSENT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      必須パラメータが含まれていません。
      この場合、レスポンスには <emphasis>oauth_parameters_absent</emphasis>
      パラメータが含まれていなければなりません。
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.oauth-signature-method-rejected">
    <term>
     <constant>OAUTH_SIGNATURE_METHOD_REJECTED</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      <emphasis>oauth_signature_method</emphasis> がサービスプロバイダに受け入れられませんでした。
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
</appendix>

<!-- 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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/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
-->