[DOC-CVS] [doc-en] master: oauth: fix XML to remove useless wrapping para tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-19T03:20:39Z
Commit: https://github.com/php/doc-en/commit/0d85b5e9045b941fb8ab48566a9d1ef703c2c805
Raw diff: https://github.com/php/doc-en/commit/0d85b5e9045b941fb8ab48566a9d1ef703c2c805.diff
oauth: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/oauth/constants.xml
M reference/oauth/examples.xml
M reference/oauth/functions/oauth-get-sbs.xml
M reference/oauth/functions/oauth-urlencode.xml
M reference/oauth/oauth/construct.xml
M reference/oauth/oauth/disabledebug.xml
M reference/oauth/oauth/disablesslchecks.xml
M reference/oauth/oauth/enabledebug.xml
M reference/oauth/oauth/enablesslchecks.xml
M reference/oauth/oauth/fetch.xml
M reference/oauth/oauth/getaccesstoken.xml
M reference/oauth/oauth/getlastresponse.xml
M reference/oauth/oauth/getlastresponseinfo.xml
M reference/oauth/oauth/getrequesttoken.xml
M reference/oauth/oauth/setauthtype.xml
M reference/oauth/oauth/setcapath.xml
M reference/oauth/oauth/setnonce.xml
M reference/oauth/oauth/setrsacertificate.xml
M reference/oauth/oauth/settimestamp.xml
M reference/oauth/oauth/settoken.xml
M reference/oauth/oauth/setversion.xml
Diff:
diff --git a/reference/oauth/constants.xml b/reference/oauth/constants.xml
index 4a5474639a31..f6b0fc78d1a6 100644
--- a/reference/oauth/constants.xml
+++ b/reference/oauth/constants.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<appendix xml:id="oauth.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.constants">
&reftitle.constants;
&extension.constants;
<para>
@@ -10,327 +9,324 @@
documentation. Note however, that these constant names are specific to PHP, although
the naming scheme is similar.
</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> signature method.
- </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> signature method.
- </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> signature method.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-auth-type-authorization">
- <term>
- <constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <para>
- This constant represents putting OAuth parameters in the
- <literal>Authorization</literal> header.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-auth-type-none">
- <term>
- <constant>OAUTH_AUTH_TYPE_NONE</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <para>
- This constant indicates a NoAuth OAuth request.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-auth-type-uri">
- <term>
- <constant>OAUTH_AUTH_TYPE_URI</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <para>
- This constant represents putting OAuth parameters in the request
- <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>
- This constant represents putting OAuth parameters as part of the
- HTTP POST body.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-http-method-get">
- <term>
- <constant>OAUTH_HTTP_METHOD_GET</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <para>
- Use the <emphasis>GET</emphasis> method for the OAuth request.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-http-method-post">
- <term>
- <constant>OAUTH_HTTP_METHOD_POST</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <para>
- Use the <emphasis>POST</emphasis> method for the OAuth request.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-http-method-put">
- <term>
- <constant>OAUTH_HTTP_METHOD_PUT</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <para>
- Use the <emphasis>PUT</emphasis> method for the OAuth request.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-http-method-head">
- <term>
- <constant>OAUTH_HTTP_METHOD_HEAD</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <para>
- Use the <emphasis>HEAD</emphasis> method for the OAuth request.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-http-method-delete">
- <term>
- <constant>OAUTH_HTTP_METHOD_DELETE</constant>
- (<type>string</type>)
- </term>
- <listitem>
- <simpara>
- Use the <emphasis>DELETE</emphasis> method for the OAuth request.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-reqengine-streams">
- <term>
- <constant>OAUTH_REQENGINE_STREAMS</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- Used by <methodname>OAuth::setRequestEngine</methodname> to set the engine to
- <link linkend="book.stream">PHP streams</link>,
- as opposed to <constant>OAUTH_REQENGINE_CURL</constant> for
- <link linkend="book.curl">Curl</link>.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-reqengine-curl">
- <term>
- <constant>OAUTH_REQENGINE_CURL</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- Used by <methodname>OAuth::setRequestEngine</methodname> to set the engine to
- <link linkend="book.curl">Curl</link>, as opposed to
- <constant>OAUTH_REQENGINE_STREAMS</constant> for <link linkend="book.stream">PHP streams</link>.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-ok">
- <term>
- <constant>OAUTH_OK</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- Life is good.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-bad-nonce">
- <term>
- <constant>OAUTH_BAD_NONCE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_nonce</emphasis> value was used in a previous request,
- therefore it cannot be used now.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-bad-timestamp">
- <term>
- <constant>OAUTH_BAD_TIMESTAMP</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_timestamp</emphasis> value was not accepted by the service provider. In
- this case, the response should also contain the <emphasis>oauth_acceptable_timestamps</emphasis>
- parameter.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-consumer-key-unknown">
- <term>
- <constant>OAUTH_CONSUMER_KEY_UNKNOWN</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_consumer_key</emphasis> is temporarily unacceptable to the service provider.
- For example, the service provider may be throttling the consumer.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-consumer-key-refused">
- <term>
- <constant>OAUTH_CONSUMER_KEY_REFUSED</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The consumer key was refused.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-invalid-signature">
- <term>
- <constant>OAUTH_INVALID_SIGNATURE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_signature</emphasis> is invalid, as it does not match the
- signature computed by the service provider.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-token-used">
- <term>
- <constant>OAUTH_TOKEN_USED</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_token</emphasis> has been consumed. It can no longer be
- used because it has already been used in the previous request(s).
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-token-expired">
- <term>
- <constant>OAUTH_TOKEN_EXPIRED</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_token</emphasis> has expired.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-token-revoked">
- <term>
- <constant>OAUTH_TOKEN_REVOKED</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_token</emphasis> has been revoked, and will never be accepted.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-token-rejected">
- <term>
- <constant>OAUTH_TOKEN_REJECTED</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_token</emphasis> was not accepted by the service provider.
- The reason is not known, but it might be because the token was never issued,
- already consumed, expired, and/or forgotten by the service provider.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-verifier-invalid">
- <term>
- <constant>OAUTH_VERIFIER_INVALID</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_verifier</emphasis> is incorrect.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-parameter-absent">
- <term>
- <constant>OAUTH_PARAMETER_ABSENT</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- A required parameter was not received. In this case, the response should also
- contain the <emphasis>oauth_parameters_absent</emphasis> parameter.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.oauth-signature-method-rejected">
- <term>
- <constant>OAUTH_SIGNATURE_METHOD_REJECTED</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- The <emphasis>oauth_signature_method</emphasis> was not accepted by service provider.
- </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
- </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> signature method.
+ </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> signature method.
+ </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> signature method.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-auth-type-authorization">
+ <term>
+ <constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <para>
+ This constant represents putting OAuth parameters in the
+ <literal>Authorization</literal> header.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-auth-type-none">
+ <term>
+ <constant>OAUTH_AUTH_TYPE_NONE</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <para>
+ This constant indicates a NoAuth OAuth request.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-auth-type-uri">
+ <term>
+ <constant>OAUTH_AUTH_TYPE_URI</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <para>
+ This constant represents putting OAuth parameters in the request
+ <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>
+ This constant represents putting OAuth parameters as part of the
+ HTTP POST body.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-http-method-get">
+ <term>
+ <constant>OAUTH_HTTP_METHOD_GET</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <para>
+ Use the <emphasis>GET</emphasis> method for the OAuth request.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-http-method-post">
+ <term>
+ <constant>OAUTH_HTTP_METHOD_POST</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <para>
+ Use the <emphasis>POST</emphasis> method for the OAuth request.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-http-method-put">
+ <term>
+ <constant>OAUTH_HTTP_METHOD_PUT</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <para>
+ Use the <emphasis>PUT</emphasis> method for the OAuth request.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-http-method-head">
+ <term>
+ <constant>OAUTH_HTTP_METHOD_HEAD</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <para>
+ Use the <emphasis>HEAD</emphasis> method for the OAuth request.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-http-method-delete">
+ <term>
+ <constant>OAUTH_HTTP_METHOD_DELETE</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Use the <emphasis>DELETE</emphasis> method for the OAuth request.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-reqengine-streams">
+ <term>
+ <constant>OAUTH_REQENGINE_STREAMS</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Used by <methodname>OAuth::setRequestEngine</methodname> to set the engine to
+ <link linkend="book.stream">PHP streams</link>,
+ as opposed to <constant>OAUTH_REQENGINE_CURL</constant> for
+ <link linkend="book.curl">Curl</link>.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-reqengine-curl">
+ <term>
+ <constant>OAUTH_REQENGINE_CURL</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Used by <methodname>OAuth::setRequestEngine</methodname> to set the engine to
+ <link linkend="book.curl">Curl</link>, as opposed to
+ <constant>OAUTH_REQENGINE_STREAMS</constant> for <link linkend="book.stream">PHP streams</link>.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-ok">
+ <term>
+ <constant>OAUTH_OK</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Life is good.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-bad-nonce">
+ <term>
+ <constant>OAUTH_BAD_NONCE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_nonce</emphasis> value was used in a previous request,
+ therefore it cannot be used now.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-bad-timestamp">
+ <term>
+ <constant>OAUTH_BAD_TIMESTAMP</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_timestamp</emphasis> value was not accepted by the service provider. In
+ this case, the response should also contain the <emphasis>oauth_acceptable_timestamps</emphasis>
+ parameter.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-consumer-key-unknown">
+ <term>
+ <constant>OAUTH_CONSUMER_KEY_UNKNOWN</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_consumer_key</emphasis> is temporarily unacceptable to the service provider.
+ For example, the service provider may be throttling the consumer.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-consumer-key-refused">
+ <term>
+ <constant>OAUTH_CONSUMER_KEY_REFUSED</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The consumer key was refused.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-invalid-signature">
+ <term>
+ <constant>OAUTH_INVALID_SIGNATURE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_signature</emphasis> is invalid, as it does not match the
+ signature computed by the service provider.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-token-used">
+ <term>
+ <constant>OAUTH_TOKEN_USED</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> has been consumed. It can no longer be
+ used because it has already been used in the previous request(s).
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-token-expired">
+ <term>
+ <constant>OAUTH_TOKEN_EXPIRED</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> has expired.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-token-revoked">
+ <term>
+ <constant>OAUTH_TOKEN_REVOKED</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> has been revoked, and will never be accepted.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-token-rejected">
+ <term>
+ <constant>OAUTH_TOKEN_REJECTED</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> was not accepted by the service provider.
+ The reason is not known, but it might be because the token was never issued,
+ already consumed, expired, and/or forgotten by the service provider.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-verifier-invalid">
+ <term>
+ <constant>OAUTH_VERIFIER_INVALID</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_verifier</emphasis> is incorrect.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-parameter-absent">
+ <term>
+ <constant>OAUTH_PARAMETER_ABSENT</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ A required parameter was not received. In this case, the response should also
+ contain the <emphasis>oauth_parameters_absent</emphasis> parameter.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.oauth-signature-method-rejected">
+ <term>
+ <constant>OAUTH_SIGNATURE_METHOD_REJECTED</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_signature_method</emphasis> was not accepted by service provider.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</appendix>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -351,4 +347,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/oauth/examples.xml b/reference/oauth/examples.xml
index 48252fc4657b..cd18f296a116 100644
--- a/reference/oauth/examples.xml
+++ b/reference/oauth/examples.xml
@@ -1,15 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="oauth.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.examples">
&reftitle.examples;
<section xml:id="oauth.examples.fireeagle">
<title>FireEagle</title>
- <para>
- <example>
- <title></title>
- <programlisting role="php" xml:id="oauth.examples.fireeagle.location">
+ <example>
+ <title/>
+ <programlisting role="php" xml:id="oauth.examples.fireeagle.location">
<![CDATA[
<?php
$req_url = 'https://fireeagle.yahooapis.com/oauth/request_token';
@@ -39,7 +37,7 @@ try {
$_SESSION['state'] = 2;
$_SESSION['token'] = $access_token_info['oauth_token'];
$_SESSION['secret'] = $access_token_info['oauth_token_secret'];
- }
+ }
$oauth->setToken($_SESSION['token'],$_SESSION['secret']);
$oauth->fetch("$api_url/user.json");
$json = json_decode($oauth->getLastResponse());
@@ -49,13 +47,11 @@ try {
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</section>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -76,4 +72,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/oauth/functions/oauth-get-sbs.xml b/reference/oauth/functions/oauth-get-sbs.xml
index 1c105d3dbbda..27336aa8c6cf 100644
--- a/reference/oauth/functions/oauth-get-sbs.xml
+++ b/reference/oauth/functions/oauth-get-sbs.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.oauth-get-sbs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<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>
<refpurpose>Generate a Signature Base String</refpurpose>
@@ -22,34 +21,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>http_method</parameter></term>
- <listitem>
- <para>
- The HTTP method.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>uri</parameter></term>
- <listitem>
- <para>
- URI to encode.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>request_parameters</parameter></term>
- <listitem>
- <para>
- Array of request parameters.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>http_method</parameter></term>
+ <listitem>
+ <para>
+ The HTTP method.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>uri</parameter></term>
+ <listitem>
+ <para>
+ URI to encode.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>request_parameters</parameter></term>
+ <listitem>
+ <para>
+ Array of request parameters.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,7 +57,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/functions/oauth-urlencode.xml b/reference/oauth/functions/oauth-urlencode.xml
index 54b23849bdc4..4c3cb0d20f57 100644
--- a/reference/oauth/functions/oauth-urlencode.xml
+++ b/reference/oauth/functions/oauth-urlencode.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.oauth-urlencode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<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>
<refpurpose>Encode a URI to RFC 3986</refpurpose>
@@ -20,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>uri</parameter></term>
- <listitem>
- <para>
- URI to encode.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>uri</parameter></term>
+ <listitem>
+ <para>
+ URI to encode.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,7 +39,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/construct.xml b/reference/oauth/oauth/construct.xml
index 7a2e1ddffbb5..e1ad78a7537c 100644
--- a/reference/oauth/oauth/construct.xml
+++ b/reference/oauth/oauth/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.construct">
<refnamediv>
<refname>OAuth::__construct</refname>
<refpurpose>Create a new OAuth object</refpurpose>
@@ -23,49 +22,46 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>consumer_key</parameter></term>
- <listitem>
- <para>
- The consumer key provided by the service provider.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>consumer_secret</parameter></term>
- <listitem>
- <para>
- The consumer secret provided by the service provider.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>signature_method</parameter></term>
- <listitem>
- <para>
- This optional parameter defines which signature method to use, by default it is <constant>OAUTH_SIG_METHOD_HMACSHA1</constant> (HMAC-SHA1).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>auth_type</parameter></term>
- <listitem>
- <para>
- This optional parameter defines how to pass the OAuth parameters
- to a consumer, by default it is
- <constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant> (in the
- <literal>Authorization</literal> header).
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>consumer_key</parameter></term>
+ <listitem>
+ <para>
+ The consumer key provided by the service provider.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>consumer_secret</parameter></term>
+ <listitem>
+ <para>
+ The consumer secret provided by the service provider.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>signature_method</parameter></term>
+ <listitem>
+ <para>
+ This optional parameter defines which signature method to use, by default it is <constant>OAUTH_SIG_METHOD_HMACSHA1</constant> (HMAC-SHA1).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>auth_type</parameter></term>
+ <listitem>
+ <para>
+ This optional parameter defines how to pass the OAuth parameters
+ to a consumer, by default it is
+ <constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant> (in the
+ <literal>Authorization</literal> header).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/disabledebug.xml b/reference/oauth/oauth/disabledebug.xml
index 3ae9195d02af..2541523b0fe8 100644
--- a/reference/oauth/oauth/disabledebug.xml
+++ b/reference/oauth/oauth/disabledebug.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.disabledebug" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.disabledebug">
<refnamediv>
<refname>OAuth::disableDebug</refname>
<refpurpose>Turn off verbose debugging</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableDebug</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Turns off verbose request information (off by default).
@@ -34,39 +33,34 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 0.99.8</entry>
- <entry>
- The related <link linkend="oauth.props.debug">debug</link> property was added.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 0.99.8</entry>
+ <entry>
+ The related <link linkend="oauth.props.debug">debug</link> property was added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::enableDebug</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::enableDebug</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/disablesslchecks.xml b/reference/oauth/oauth/disablesslchecks.xml
index 560c71b16b01..009bdf3a5a41 100644
--- a/reference/oauth/oauth/disablesslchecks.xml
+++ b/reference/oauth/oauth/disablesslchecks.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.disablesslchecks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.disablesslchecks">
<refnamediv>
<refname>OAuth::disableSSLChecks</refname>
<refpurpose>Turn off SSL checks</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableSSLChecks</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Turns off the usual SSL peer certificate and host checks,
@@ -35,39 +34,34 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 0.99.8</entry>
- <entry>
- The <parameter>sslChecks</parameter> member was added
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 0.99.8</entry>
+ <entry>
+ The <parameter>sslChecks</parameter> member was added
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::enableSSLChecks</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::enableSSLChecks</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/enabledebug.xml b/reference/oauth/oauth/enabledebug.xml
index 723f1f083f24..f5420cb03d1a 100644
--- a/reference/oauth/oauth/enabledebug.xml
+++ b/reference/oauth/oauth/enabledebug.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.enabledebug" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.enabledebug">
<refnamediv>
<refname>OAuth::enableDebug</refname>
<refpurpose>Turn on verbose debugging</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableDebug</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Turns on verbose request information useful for debugging,
the debug information is stored in the <parameter>debugInfo</parameter>
- member. Alternatively, the <parameter>debug</parameter> member can
+ member. Alternatively, the <parameter>debug</parameter> member can
be set to a non-&false; value to turn debug on.
</para>
</refsect1>
@@ -35,39 +34,34 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 0.99.8</entry>
- <entry>
- The <parameter>debug</parameter> and <parameter>debugInfo</parameter> members were added
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 0.99.8</entry>
+ <entry>
+ The <parameter>debug</parameter> and <parameter>debugInfo</parameter> members were added
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::disableDebug</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::disableDebug</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/enablesslchecks.xml b/reference/oauth/oauth/enablesslchecks.xml
index 26f5187c6d8a..116884237531 100644
--- a/reference/oauth/oauth/enablesslchecks.xml
+++ b/reference/oauth/oauth/enablesslchecks.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.enablesslchecks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.enablesslchecks">
<refnamediv>
<refname>OAuth::enableSSLChecks</refname>
<refpurpose>Turn on SSL checks</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableSSLChecks</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Turns on the usual SSL peer certificate and host checks (enabled by default).
@@ -34,39 +33,34 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 0.99.8</entry>
- <entry>
- The <parameter>sslChecks</parameter> member was added
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 0.99.8</entry>
+ <entry>
+ The <parameter>sslChecks</parameter> member was added
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::disableSSLChecks</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::disableSSLChecks</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/fetch.xml b/reference/oauth/oauth/fetch.xml
index e1a8f9718cfa..734830574747 100644
--- a/reference/oauth/oauth/fetch.xml
+++ b/reference/oauth/oauth/fetch.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.fetch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.fetch">
<refnamediv>
<refname>OAuth::fetch</refname>
<refpurpose>Fetch an OAuth protected resource</refpurpose>
@@ -23,49 +22,47 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>protected_resource_url</parameter></term>
- <listitem>
- <para>
- URL to the OAuth protected resource.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>extra_parameters</parameter></term>
- <listitem>
- <para>
- Extra parameters to send with the request for the resource.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>http_method</parameter></term>
- <listitem>
- <para>
- One of the <constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant>
- OAUTH constants, which includes
- GET, POST, PUT, HEAD, or DELETE.
- </para>
- <para>
- HEAD (<constant>OAUTH_HTTP_METHOD_HEAD</constant>) can be useful for
- discovering information prior to the request (if OAuth credentials are
- in the <literal>Authorization</literal> header).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>http_headers</parameter></term>
- <listitem>
- <para>
- HTTP client headers (such as User-Agent, Accept, etc.)
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>protected_resource_url</parameter></term>
+ <listitem>
+ <para>
+ URL to the OAuth protected resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>extra_parameters</parameter></term>
+ <listitem>
+ <para>
+ Extra parameters to send with the request for the resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>http_method</parameter></term>
+ <listitem>
+ <para>
+ One of the <constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant>
+ OAUTH constants, which includes
+ GET, POST, PUT, HEAD, or DELETE.
+ </para>
+ <para>
+ HEAD (<constant>OAUTH_HTTP_METHOD_HEAD</constant>) can be useful for
+ discovering information prior to the request (if OAuth credentials are
+ in the <literal>Authorization</literal> header).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>http_headers</parameter></term>
+ <listitem>
+ <para>
+ HTTP client headers (such as User-Agent, Accept, etc.)
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -77,46 +74,43 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- <row>
- <entry>PECL oauth 0.99.5</entry>
- <entry>
- The <parameter>http_method</parameter> parameter was added
- </entry>
- </row>
- <row>
- <entry>PECL oauth 0.99.8</entry>
- <entry>
- The <parameter>http_headers</parameter> parameter was added
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ <row>
+ <entry>PECL oauth 0.99.5</entry>
+ <entry>
+ The <parameter>http_method</parameter> parameter was added
+ </entry>
+ </row>
+ <row>
+ <entry>PECL oauth 0.99.8</entry>
+ <entry>
+ The <parameter>http_headers</parameter> parameter was added
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>OAuth::fetch</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>OAuth::fetch</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
try {
@@ -134,24 +128,20 @@ try {
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::getLastResponse</methodname></member>
- <member><methodname>OAuth::getLastResponseInfo</methodname></member>
- <member><methodname>OAuth::setToken</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::getLastResponse</methodname></member>
+ <member><methodname>OAuth::getLastResponseInfo</methodname></member>
+ <member><methodname>OAuth::setToken</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/getaccesstoken.xml b/reference/oauth/oauth/getaccesstoken.xml
index eaab7743c93c..6f8a309189a2 100644
--- a/reference/oauth/oauth/getaccesstoken.xml
+++ b/reference/oauth/oauth/getaccesstoken.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.getaccesstoken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getaccesstoken">
<refnamediv>
<refname>OAuth::getAccessToken</refname>
<refpurpose>Fetch an access token</refpurpose>
@@ -23,53 +22,51 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>access_token_url</parameter></term>
- <listitem>
- <para>
- URL to the access token API.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>auth_session_handle</parameter></term>
- <listitem>
- <para>
- Authorization session handle, this parameter does not have any
- citation in the core OAuth 1.0 specification but may be
- implemented by large providers.
- <link xlink:href="&url.oauth.scale;">See ScalableOAuth</link>
- for more information.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>verifier_token</parameter></term>
- <listitem>
- <para>
- For service providers which support 1.0a, a <parameter>verifier_token</parameter>
- must be passed while exchanging the request token for the access
- token. If the <parameter>verifier_token</parameter> is present in <parameter>$_GET</parameter>
- or <parameter>$_POST</parameter> it is passed automatically and the caller
- does not need to specify a <parameter>verifier_token</parameter> (usually if the access token
- is exchanged at the oauth_callback URL).
- <link xlink:href="&url.oauth.scale;">See ScalableOAuth</link>
- for more information.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>http_method</parameter></term>
- <listitem>
- <para>
- HTTP method to use, e.g. <literal>GET</literal> or <literal>POST</literal>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>access_token_url</parameter></term>
+ <listitem>
+ <para>
+ URL to the access token API.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>auth_session_handle</parameter></term>
+ <listitem>
+ <para>
+ Authorization session handle, this parameter does not have any
+ citation in the core OAuth 1.0 specification but may be
+ implemented by large providers.
+ <link xlink:href="&url.oauth.scale;">See ScalableOAuth</link>
+ for more information.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>verifier_token</parameter></term>
+ <listitem>
+ <para>
+ For service providers which support 1.0a, a <parameter>verifier_token</parameter>
+ must be passed while exchanging the request token for the access
+ token. If the <parameter>verifier_token</parameter> is present in <parameter>$_GET</parameter>
+ or <parameter>$_POST</parameter> it is passed automatically and the caller
+ does not need to specify a <parameter>verifier_token</parameter> (usually if the access token
+ is exchanged at the oauth_callback URL).
+ <link xlink:href="&url.oauth.scale;">See ScalableOAuth</link>
+ for more information.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>http_method</parameter></term>
+ <listitem>
+ <para>
+ HTTP method to use, e.g. <literal>GET</literal> or <literal>POST</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -81,40 +78,37 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- <row>
- <entry>PECL oauth 0.99.9</entry>
- <entry>
- The <parameter>verifier_token</parameter> parameter was added
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ <row>
+ <entry>PECL oauth 0.99.9</entry>
+ <entry>
+ The <parameter>verifier_token</parameter> parameter was added
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>OAuth::getAccessToken</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>OAuth::getAccessToken</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
try {
@@ -131,9 +125,9 @@ try {
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Array
(
@@ -141,24 +135,20 @@ Array
[oauth_token_secret] => some_token_secret
)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::getLastResponse</methodname></member>
- <member><methodname>OAuth::getLastResponseInfo</methodname></member>
- <member><methodname>OAuth::setToken</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::getLastResponse</methodname></member>
+ <member><methodname>OAuth::getLastResponseInfo</methodname></member>
+ <member><methodname>OAuth::setToken</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/getlastresponse.xml b/reference/oauth/oauth/getlastresponse.xml
index 2df5cd5f8967..43b9c17b5cf6 100644
--- a/reference/oauth/oauth/getlastresponse.xml
+++ b/reference/oauth/oauth/getlastresponse.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.getlastresponse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getlastresponse">
<refnamediv>
<refname>OAuth::getLastResponse</refname>
<refpurpose>Get the last response</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>OAuth::getLastResponse</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Get the raw response of the most recent request.
@@ -32,16 +31,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::getLastResponseInfo</methodname></member>
- <member><methodname>OAuth::fetch</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::getLastResponseInfo</methodname></member>
+ <member><methodname>OAuth::fetch</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/getlastresponseinfo.xml b/reference/oauth/oauth/getlastresponseinfo.xml
index 8bab1f12b51f..5b2450cb7464 100644
--- a/reference/oauth/oauth/getlastresponseinfo.xml
+++ b/reference/oauth/oauth/getlastresponseinfo.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.getlastresponseinfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getlastresponseinfo">
<refnamediv>
<refname>OAuth::getLastResponseInfo</refname>
<refpurpose>Get HTTP information about the last response</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>OAuth::getLastResponseInfo</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Get HTTP information about the last response.
@@ -34,16 +33,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::fetch</methodname></member>
- <member><methodname>OAuth::getLastResponse</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::fetch</methodname></member>
+ <member><methodname>OAuth::getLastResponse</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/getrequesttoken.xml b/reference/oauth/oauth/getrequesttoken.xml
index 5cadbb6778dd..41950a08016d 100644
--- a/reference/oauth/oauth/getrequesttoken.xml
+++ b/reference/oauth/oauth/getrequesttoken.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.getrequesttoken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.getrequesttoken">
<refnamediv>
<refname>OAuth::getRequestToken</refname>
<refpurpose>Fetch a request token</refpurpose>
@@ -22,34 +21,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>request_token_url</parameter></term>
- <listitem>
- <para>
- URL to the request token API.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callback_url</parameter></term>
- <listitem>
- <para>
- OAuth callback URL. If <parameter>callback_url</parameter> is passed and is an empty value, it is set to "oob" to address the OAuth 2009.1 advisory.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>http_method</parameter></term>
- <listitem>
- <para>
- HTTP method to use, e.g. <literal>GET</literal> or <literal>POST</literal>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>request_token_url</parameter></term>
+ <listitem>
+ <para>
+ URL to the request token API.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callback_url</parameter></term>
+ <listitem>
+ <para>
+ OAuth callback URL. If <parameter>callback_url</parameter> is passed and is an empty value, it is set to "oob" to address the OAuth 2009.1 advisory.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>http_method</parameter></term>
+ <listitem>
+ <para>
+ HTTP method to use, e.g. <literal>GET</literal> or <literal>POST</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -61,40 +58,37 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- <row>
- <entry>PECL oauth 0.99.9</entry>
- <entry>
- The <parameter>callback_url</parameter> parameter was added
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ <row>
+ <entry>PECL oauth 0.99.9</entry>
+ <entry>
+ The <parameter>callback_url</parameter> parameter was added
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>OAuth::getRequestToken</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>OAuth::getRequestToken</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
try {
@@ -110,9 +104,9 @@ try {
}
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Array
(
@@ -120,23 +114,19 @@ Array
[oauth_token_secret] => some_token_secret
)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::getLastResponse</methodname></member>
- <member><methodname>OAuth::getLastResponseInfo</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::getLastResponse</methodname></member>
+ <member><methodname>OAuth::getLastResponseInfo</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/setauthtype.xml b/reference/oauth/oauth/setauthtype.xml
index a928a67ec329..33fb4082e362 100644
--- a/reference/oauth/oauth/setauthtype.xml
+++ b/reference/oauth/oauth/setauthtype.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.setauthtype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setauthtype">
<refnamediv>
<refname>OAuth::setAuthType</refname>
<refpurpose>Set authorization type</refpurpose>
@@ -20,52 +19,50 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>auth_type</parameter></term>
- <listitem>
- <para>
- <parameter>auth_type</parameter> can be one of the following flags (in order of decreasing preference as per OAuth 1.0 section 5.2):
- <variablelist>
- <varlistentry>
- <term><constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant></term>
- <listitem>
- <simpara>
- Pass the OAuth parameters in the HTTP <literal>Authorization</literal> header.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><constant>OAUTH_AUTH_TYPE_FORM</constant></term>
- <listitem>
- <simpara>
- Append the OAuth parameters to the HTTP POST request body.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><constant>OAUTH_AUTH_TYPE_URI</constant></term>
- <listitem>
- <simpara>
- Append the OAuth parameters to the request URI.
- </simpara>
- </listitem>
- </varlistentry>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>auth_type</parameter></term>
+ <listitem>
+ <para>
+ <parameter>auth_type</parameter> can be one of the following flags (in order of decreasing preference as per OAuth 1.0 section 5.2):
+ <variablelist>
<varlistentry>
- <term><constant>OAUTH_AUTH_TYPE_NONE</constant></term>
+ <term><constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant></term>
<listitem>
- <simpara>
- None.
- </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <simpara>
+ Pass the OAuth parameters in the HTTP <literal>Authorization</literal> header.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><constant>OAUTH_AUTH_TYPE_FORM</constant></term>
+ <listitem>
+ <simpara>
+ Append the OAuth parameters to the HTTP POST request body.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><constant>OAUTH_AUTH_TYPE_URI</constant></term>
+ <listitem>
+ <simpara>
+ Append the OAuth parameters to the request URI.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><constant>OAUTH_AUTH_TYPE_NONE</constant></term>
+ <listitem>
+ <simpara>
+ None.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -78,30 +75,27 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/setcapath.xml b/reference/oauth/oauth/setcapath.xml
index 89b6bed8b090..afc4e17dbe5e 100644
--- a/reference/oauth/oauth/setcapath.xml
+++ b/reference/oauth/oauth/setcapath.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.setcapath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setcapath">
<refnamediv>
<refname>OAuth::setCAPath</refname>
<refpurpose>Set CA path and info</refpurpose>
@@ -56,26 +55,24 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
@@ -86,7 +83,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/setnonce.xml b/reference/oauth/oauth/setnonce.xml
index ae65e63092a7..924a97c9e195 100644
--- a/reference/oauth/oauth/setnonce.xml
+++ b/reference/oauth/oauth/setnonce.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.setnonce" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setnonce">
<refnamediv>
<refname>OAuth::setNonce</refname>
<refpurpose>Set the nonce for subsequent requests</refpurpose>
@@ -20,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>nonce</parameter></term>
- <listitem>
- <para>
- The value for oauth_nonce.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>nonce</parameter></term>
+ <listitem>
+ <para>
+ The value for oauth_nonce.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,41 +41,36 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><methodname>OAuth::setToken</methodname></member>
- <member><methodname>OAuth::setAuthType</methodname></member>
- <member><methodname>OAuth::setVersion</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><methodname>OAuth::setToken</methodname></member>
+ <member><methodname>OAuth::setAuthType</methodname></member>
+ <member><methodname>OAuth::setVersion</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/setrsacertificate.xml b/reference/oauth/oauth/setrsacertificate.xml
index de361234ac70..34b35523fed1 100644
--- a/reference/oauth/oauth/setrsacertificate.xml
+++ b/reference/oauth/oauth/setrsacertificate.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.setrsacertificate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setrsacertificate">
<refnamediv>
<refname>OAuth::setRSACertificate</refname>
<refpurpose>Set the RSA certificate</refpurpose>
@@ -45,26 +44,24 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
@@ -91,7 +88,6 @@ $consume->setRSACertificate(file_get_contents('test.pem'));
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/settimestamp.xml b/reference/oauth/oauth/settimestamp.xml
index c6b72ee9bc40..591dca0cdedf 100644
--- a/reference/oauth/oauth/settimestamp.xml
+++ b/reference/oauth/oauth/settimestamp.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.settimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.settimestamp">
<refnamediv>
<refname>OAuth::setTimestamp</refname>
<refpurpose>Set the timestamp</refpurpose>
@@ -45,26 +44,24 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL oauth 1.0.0</entry>
- <entry>
- &oauth.changelog.error.null;
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL oauth 1.0.0</entry>
+ <entry>
+ &oauth.changelog.error.null;
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
@@ -75,7 +72,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/settoken.xml b/reference/oauth/oauth/settoken.xml
index 5ebd584abd41..4383ab9b2aba 100644
--- a/reference/oauth/oauth/settoken.xml
+++ b/reference/oauth/oauth/settoken.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.settoken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.settoken">
<refnamediv>
<refname>OAuth::setToken</refname>
<refpurpose>Sets the token and secret</refpurpose>
@@ -21,26 +20,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>token</parameter></term>
- <listitem>
- <para>
- The OAuth token.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>token_secret</parameter></term>
- <listitem>
- <para>
- The OAuth token secret.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>token</parameter></term>
+ <listitem>
+ <para>
+ The OAuth token.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>token_secret</parameter></term>
+ <listitem>
+ <para>
+ The OAuth token secret.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -52,23 +49,20 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>OAuth::setToken</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>OAuth::setToken</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$oauth = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET);
$oauth->setToken("token","token-secret");
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauth/setversion.xml b/reference/oauth/oauth/setversion.xml
index a5bd69946e12..e2fdb07c4979 100644
--- a/reference/oauth/oauth/setversion.xml
+++ b/reference/oauth/oauth/setversion.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.setversion" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="oauth.setversion">
<refnamediv>
<refname>OAuth::setVersion</refname>
<refpurpose>Set the OAuth version</refpurpose>
@@ -20,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>version</parameter></term>
- <listitem>
- <para>
- OAuth version, default value is always "1.0"
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>version</parameter></term>
+ <listitem>
+ <para>
+ OAuth version, default value is always "1.0"
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,7 +39,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml