[DOC-CVS] [doc-en] master: oauth : fix XML by converting para to simpara 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/bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a
Raw diff: https://github.com/php/doc-en/commit/bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a.diff
oauth : fix XML by converting para to simpara tags via script
Changed paths:
M reference/oauth/book.xml
M reference/oauth/configure.xml
M reference/oauth/constants.xml
M reference/oauth/functions/oauth-get-sbs.xml
M reference/oauth/functions/oauth-urlencode.xml
M reference/oauth/oauth.xml
M reference/oauth/oauth/construct.xml
M reference/oauth/oauth/destruct.xml
M reference/oauth/oauth/disabledebug.xml
M reference/oauth/oauth/disableredirects.xml
M reference/oauth/oauth/disablesslchecks.xml
M reference/oauth/oauth/enabledebug.xml
M reference/oauth/oauth/enableredirects.xml
M reference/oauth/oauth/enablesslchecks.xml
M reference/oauth/oauth/fetch.xml
M reference/oauth/oauth/generatesignature.xml
M reference/oauth/oauth/getaccesstoken.xml
M reference/oauth/oauth/getcapath.xml
M reference/oauth/oauth/getlastresponse.xml
M reference/oauth/oauth/getlastresponseheaders.xml
M reference/oauth/oauth/getlastresponseinfo.xml
M reference/oauth/oauth/getrequestheader.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/setrequestengine.xml
M reference/oauth/oauth/setrsacertificate.xml
M reference/oauth/oauth/setsslchecks.xml
M reference/oauth/oauth/settimestamp.xml
M reference/oauth/oauth/settoken.xml
M reference/oauth/oauth/setversion.xml
M reference/oauth/oauthexception.xml
M reference/oauth/oauthprovider.xml
M reference/oauth/oauthprovider/addrequiredparameter.xml
M reference/oauth/oauthprovider/callconsumerhandler.xml
M reference/oauth/oauthprovider/calltimestampnoncehandler.xml
M reference/oauth/oauthprovider/calltokenhandler.xml
M reference/oauth/oauthprovider/checkoauthrequest.xml
M reference/oauth/oauthprovider/construct.xml
M reference/oauth/oauthprovider/consumerhandler.xml
M reference/oauth/oauthprovider/generatetoken.xml
M reference/oauth/oauthprovider/is2leggedendpoint.xml
M reference/oauth/oauthprovider/isrequesttokenendpoint.xml
M reference/oauth/oauthprovider/removerequiredparameter.xml
M reference/oauth/oauthprovider/reportproblem.xml
M reference/oauth/oauthprovider/setparam.xml
M reference/oauth/oauthprovider/setrequesttokenpath.xml
M reference/oauth/oauthprovider/timestampnoncehandler.xml
M reference/oauth/oauthprovider/tokenhandler.xml
M reference/oauth/setup.xml
Diff:
diff --git a/reference/oauth/book.xml b/reference/oauth/book.xml
index 057bae2fcb40..ab305ef480c5 100644
--- a/reference/oauth/book.xml
+++ b/reference/oauth/book.xml
@@ -1,30 +1,28 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.oauth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<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>
This extension provides OAuth 1.0a consumer and provider bindings. OAuth is an
authorization protocol built on top of HTTP which allows applications
to securely access data without having to store usernames and
- passwords.
- </para>
+ passwords.
+ </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
@@ -45,4 +43,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/configure.xml b/reference/oauth/configure.xml
index f0286917a4d0..96dd50dffdd4 100644
--- a/reference/oauth/configure.xml
+++ b/reference/oauth/configure.xml
@@ -1,15 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<section xml:id="oauth.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<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
diff --git a/reference/oauth/constants.xml b/reference/oauth/constants.xml
index f6b0fc78d1a6..54a0646af142 100644
--- a/reference/oauth/constants.xml
+++ b/reference/oauth/constants.xml
@@ -3,12 +3,12 @@
<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>
Most of these constants involve problems, which are also described within the official
OAuth <link xlink:href="&url.oauth.problemreporting;">Problem Reporting</link>
documentation. Note however, that these constant names are specific to PHP, although
the naming scheme is similar.
- </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> signature method.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-sig-method-hmacsha256">
@@ -50,10 +50,10 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
This constant represents putting OAuth parameters in the
<literal>Authorization</literal> header.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-auth-type-none">
@@ -62,9 +62,9 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
This constant indicates a NoAuth OAuth request.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-auth-type-uri">
@@ -73,10 +73,10 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
This constant represents putting OAuth parameters in the request
<acronym>URI</acronym>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-auth-type-form">
@@ -85,10 +85,10 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
This constant represents putting OAuth parameters as part of the
HTTP POST body.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-get">
@@ -97,9 +97,9 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
Use the <emphasis>GET</emphasis> method for the OAuth request.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-post">
@@ -108,9 +108,9 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
Use the <emphasis>POST</emphasis> method for the OAuth request.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-put">
@@ -119,9 +119,9 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
Use the <emphasis>PUT</emphasis> method for the OAuth request.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-head">
@@ -130,9 +130,9 @@
(<type>string</type>)
</term>
<listitem>
- <para>
+ <simpara>
Use the <emphasis>HEAD</emphasis> method for the OAuth request.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.oauth-http-method-delete">
diff --git a/reference/oauth/functions/oauth-get-sbs.xml b/reference/oauth/functions/oauth-get-sbs.xml
index 27336aa8c6cf..1f214dcd0763 100644
--- a/reference/oauth/functions/oauth-get-sbs.xml
+++ b/reference/oauth/functions/oauth-get-sbs.xml
@@ -14,9 +14,9 @@
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>request_parameters</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Generates a Signature Base String according to pecl/oauth.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,25 +25,25 @@
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
- <para>
+ <simpara>
The HTTP method.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
- <para>
+ <simpara>
URI to encode.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>request_parameters</parameter></term>
<listitem>
- <para>
+ <simpara>
Array of request parameters.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,9 +51,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a Signature Base String.
- </para>
+ </simpara>
</refsect1>
</refentry>
diff --git a/reference/oauth/functions/oauth-urlencode.xml b/reference/oauth/functions/oauth-urlencode.xml
index 4c3cb0d20f57..ed1bb5fbebe9 100644
--- a/reference/oauth/functions/oauth-urlencode.xml
+++ b/reference/oauth/functions/oauth-urlencode.xml
@@ -12,9 +12,9 @@
<type>string</type><methodname>oauth_urlencode</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Encodes a URI to <link xlink:href="&url.rfc;3986">RFC 3986</link>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
- <para>
+ <simpara>
URI to encode.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an <link xlink:href="&url.rfc;3986">RFC 3986</link> encoded string.
- </para>
+ </simpara>
</refsect1>
</refentry>
diff --git a/reference/oauth/oauth.xml b/reference/oauth/oauth.xml
index 0decff502add..c985bc8cecbe 100644
--- a/reference/oauth/oauth.xml
+++ b/reference/oauth/oauth.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<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">
+<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>The OAuth class</title>
<titleabbrev>OAuth</titleabbrev>
@@ -10,11 +9,11 @@
<!-- {{{ OAuth intro -->
<section xml:id="oauth.intro">
&reftitle.intro;
- <para>
+ <simpara>
The OAuth extension provides a simple interface to interact with
data providers using the OAuth HTTP specification to protect
private resources.
- </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
diff --git a/reference/oauth/oauth/construct.xml b/reference/oauth/oauth/construct.xml
index e1ad78a7537c..503795e67ed6 100644
--- a/reference/oauth/oauth/construct.xml
+++ b/reference/oauth/oauth/construct.xml
@@ -15,9 +15,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>
Creates a new OAuth object
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,36 +26,36 @@
<varlistentry>
<term><parameter>consumer_key</parameter></term>
<listitem>
- <para>
+ <simpara>
The consumer key provided by the service provider.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>consumer_secret</parameter></term>
<listitem>
- <para>
+ <simpara>
The consumer secret provided by the service provider.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signature_method</parameter></term>
<listitem>
- <para>
+ <simpara>
This optional parameter defines which signature method to use, by default it is <constant>OAUTH_SIG_METHOD_HMACSHA1</constant> (HMAC-SHA1).
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_type</parameter></term>
<listitem>
- <para>
+ <simpara>
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>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
diff --git a/reference/oauth/oauth/destruct.xml b/reference/oauth/oauth/destruct.xml
index 578c5e8b1ea5..65e73865ba38 100644
--- a/reference/oauth/oauth/destruct.xml
+++ b/reference/oauth/oauth/destruct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.destruct" 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.destruct">
<refnamediv>
<refname>OAuth::__destruct</refname>
<refpurpose>The destructor</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuth::__destruct</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
The destructor.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
@@ -41,7 +40,6 @@
</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 2541523b0fe8..6e6950d3e7b4 100644
--- a/reference/oauth/oauth/disabledebug.xml
+++ b/reference/oauth/oauth/disabledebug.xml
@@ -12,11 +12,11 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableDebug</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Turns off verbose request information (off by default).
Alternatively, the <link linkend="oauth.props.debug">debug</link> property can
be set to a &false; value to turn debug off.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/disableredirects.xml b/reference/oauth/oauth/disableredirects.xml
index a7bdb5236971..b04b4bc8c6a1 100644
--- a/reference/oauth/oauth/disableredirects.xml
+++ b/reference/oauth/oauth/disableredirects.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.disableredirects" 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.disableredirects">
<refnamediv>
<refname>OAuth::disableRedirects</refname>
<refpurpose>Turn off redirects</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableRedirects</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Disable redirects from being followed automatically, thus allowing the request to be manually redirected.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
@@ -41,7 +40,6 @@
</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 009bdf3a5a41..a5955ba1fa1d 100644
--- a/reference/oauth/oauth/disablesslchecks.xml
+++ b/reference/oauth/oauth/disablesslchecks.xml
@@ -12,12 +12,12 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::disableSSLChecks</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Turns off the usual SSL peer certificate and host checks,
this is not for production environments. Alternatively, the
<parameter>sslChecks</parameter> member can be set to &false;
to turn SSL checks off.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/enabledebug.xml b/reference/oauth/oauth/enabledebug.xml
index f5420cb03d1a..20a5517b8ad2 100644
--- a/reference/oauth/oauth/enabledebug.xml
+++ b/reference/oauth/oauth/enabledebug.xml
@@ -12,12 +12,12 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableDebug</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
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
be set to a non-&false; value to turn debug on.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/enableredirects.xml b/reference/oauth/oauth/enableredirects.xml
index 2399ec608c56..49575da8a18c 100644
--- a/reference/oauth/oauth/enableredirects.xml
+++ b/reference/oauth/oauth/enableredirects.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.enableredirects" 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.enableredirects">
<refnamediv>
<refname>OAuth::enableRedirects</refname>
<refpurpose>Turn on redirects</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableRedirects</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Follow and sign redirects automatically, which is enabled by default.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
@@ -41,7 +40,6 @@
</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 116884237531..46840ac1eb9e 100644
--- a/reference/oauth/oauth/enablesslchecks.xml
+++ b/reference/oauth/oauth/enablesslchecks.xml
@@ -12,11 +12,11 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::enableSSLChecks</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Turns on the usual SSL peer certificate and host checks (enabled by default).
Alternatively, the <link linkend="oauth.props.sslchecks">sslChecks</link> property can be set to a
non-&false; value to turn SSL checks on.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/fetch.xml b/reference/oauth/oauth/fetch.xml
index 734830574747..5508d8ffc5bb 100644
--- a/reference/oauth/oauth/fetch.xml
+++ b/reference/oauth/oauth/fetch.xml
@@ -15,9 +15,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>
Fetch a resource.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,40 +26,40 @@
<varlistentry>
<term><parameter>protected_resource_url</parameter></term>
<listitem>
- <para>
+ <simpara>
URL to the OAuth protected resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extra_parameters</parameter></term>
<listitem>
- <para>
+ <simpara>
Extra parameters to send with the request for the resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
- <para>
+ <simpara>
One of the <constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant>
OAUTH constants, which includes
GET, POST, PUT, HEAD, or DELETE.
- </para>
- <para>
+ </simpara>
+ <simpara>
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>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_headers</parameter></term>
<listitem>
- <para>
+ <simpara>
HTTP client headers (such as User-Agent, Accept, etc.)
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -67,9 +67,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/generatesignature.xml b/reference/oauth/oauth/generatesignature.xml
index 3dd55e2afd50..62c21cfc2c55 100644
--- a/reference/oauth/oauth/generatesignature.xml
+++ b/reference/oauth/oauth/generatesignature.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.generatesignature" 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.generatesignature">
<refnamediv>
<refname>OAuth::generateSignature</refname>
<refpurpose>Generate a signature</refpurpose>
@@ -15,9 +14,9 @@
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>extra_parameters</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Generate a signature based on the final HTTP method, URL and a string/array of parameters.
- </para>
+ </simpara>
</refsect1>
@@ -27,25 +26,25 @@
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
- <para>
+ <simpara>
HTTP method for request
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
- <para>
+ <simpara>
URL for request
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extra_parameters</parameter></term>
<listitem>
- <para>
+ <simpara>
String or array of additional parameters.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -53,14 +52,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
A string containing the generated signature&return.falseforfailure;
- </para>
+ </simpara>
</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 6f8a309189a2..a89a5e4d1098 100644
--- a/reference/oauth/oauth/getaccesstoken.xml
+++ b/reference/oauth/oauth/getaccesstoken.xml
@@ -15,9 +15,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>
Fetch an access token, secret and any additional response parameters from the service provider.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,27 +26,27 @@
<varlistentry>
<term><parameter>access_token_url</parameter></term>
<listitem>
- <para>
+ <simpara>
URL to the access token API.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_session_handle</parameter></term>
<listitem>
- <para>
+ <simpara>
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>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>verifier_token</parameter></term>
<listitem>
- <para>
+ <simpara>
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>
@@ -55,15 +55,15 @@
is exchanged at the oauth_callback URL).
<link xlink:href="&url.oauth.scale;">See ScalableOAuth</link>
for more information.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
- <para>
+ <simpara>
HTTP method to use, e.g. <literal>GET</literal> or <literal>POST</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -71,9 +71,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an array containing the parsed OAuth response on success or &false; on failure.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/getcapath.xml b/reference/oauth/oauth/getcapath.xml
index 4e39f2231f55..22f2513f0720 100644
--- a/reference/oauth/oauth/getcapath.xml
+++ b/reference/oauth/oauth/getcapath.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.getcapath" 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.getcapath">
<refnamediv>
<refname>OAuth::getCAPath</refname>
<refpurpose>Gets CA information</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>OAuth::getCAPath</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Gets the Certificate Authority information, which includes the
ca_path and ca_info set by <methodname>OAuth::setCaPath</methodname>.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -29,11 +28,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
An <type>array</type> of Certificate Authority information, specifically as
<literal>ca_path</literal> and <literal>ca_info</literal> keys within the returned
associative array.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
@@ -45,7 +44,6 @@
</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 43b9c17b5cf6..333e20e93c1b 100644
--- a/reference/oauth/oauth/getlastresponse.xml
+++ b/reference/oauth/oauth/getlastresponse.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>string</type><methodname>OAuth::getLastResponse</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Get the raw response of the most recent request.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a string containing the last response.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/oauth/oauth/getlastresponseheaders.xml b/reference/oauth/oauth/getlastresponseheaders.xml
index 37d6ea07a77e..1a1df9e29518 100644
--- a/reference/oauth/oauth/getlastresponseheaders.xml
+++ b/reference/oauth/oauth/getlastresponseheaders.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.getlastresponseheaders" 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.getlastresponseheaders">
<refnamediv>
<refname>OAuth::getLastResponseHeaders</refname>
<refpurpose>Get headers for last response</refpurpose>
@@ -11,11 +10,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>
Get headers for last response.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,14 +24,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
A string containing the last response's headers&return.falseforfailure;
- </para>
+ </simpara>
</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 5b2450cb7464..221990d77719 100644
--- a/reference/oauth/oauth/getlastresponseinfo.xml
+++ b/reference/oauth/oauth/getlastresponseinfo.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>array</type><methodname>OAuth::getLastResponseInfo</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Get HTTP information about the last response.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,11 +24,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an array containing the response information for the last
request. Constants from <function>curl_getinfo</function> may be
used.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/oauth/oauth/getrequestheader.xml b/reference/oauth/oauth/getrequestheader.xml
index 2034ba79a2e2..df39f8f7a6c3 100644
--- a/reference/oauth/oauth/getrequestheader.xml
+++ b/reference/oauth/oauth/getrequestheader.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.getrequestheader" 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.getrequestheader">
<refnamediv>
<refname>OAuth::getRequestHeader</refname>
<refpurpose>Generate OAuth header string signature</refpurpose>
@@ -15,9 +14,9 @@
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>extra_parameters</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Generate OAuth header string signature based on the final HTTP method, URL and a string/array of parameters
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,25 +25,25 @@
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
- <para>
+ <simpara>
HTTP method for request.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
- <para>
+ <simpara>
URL for request.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extra_parameters</parameter></term>
<listitem>
- <para>
+ <simpara>
String or array of additional parameters.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,14 +51,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
A string containing the generated request header&return.falseforfailure;
- </para>
+ </simpara>
</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 41950a08016d..e3fb021df4ec 100644
--- a/reference/oauth/oauth/getrequesttoken.xml
+++ b/reference/oauth/oauth/getrequesttoken.xml
@@ -14,9 +14,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>
Fetch a request token, secret and any additional response parameters from the service provider.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,25 +25,25 @@
<varlistentry>
<term><parameter>request_token_url</parameter></term>
<listitem>
- <para>
+ <simpara>
URL to the request token API.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback_url</parameter></term>
<listitem>
- <para>
+ <simpara>
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>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
- <para>
+ <simpara>
HTTP method to use, e.g. <literal>GET</literal> or <literal>POST</literal>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,9 +51,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an array containing the parsed OAuth response on success or &false; on failure.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/setauthtype.xml b/reference/oauth/oauth/setauthtype.xml
index 33fb4082e362..2c7c1fbba8c1 100644
--- a/reference/oauth/oauth/setauthtype.xml
+++ b/reference/oauth/oauth/setauthtype.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::setAuthType</methodname>
<methodparam><type>int</type><parameter>auth_type</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Set where the OAuth parameters should be passed.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -67,10 +67,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if a parameter is correctly set, otherwise &false;
(e.g., if an invalid <parameter>auth_type</parameter> is passed in.)
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/setcapath.xml b/reference/oauth/oauth/setcapath.xml
index afc4e17dbe5e..4b15758c2019 100644
--- a/reference/oauth/oauth/setcapath.xml
+++ b/reference/oauth/oauth/setcapath.xml
@@ -13,10 +13,10 @@
<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>
Sets the Certificate Authority (<acronym>CA</acronym>), both for path
and info.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,17 +28,17 @@
<varlistentry>
<term><parameter>ca_path</parameter></term>
<listitem>
- <para>
+ <simpara>
The CA Path being set.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ca_info</parameter></term>
<listitem>
- <para>
+ <simpara>
The CA Info being set.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,10 +47,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; on success, or &false; if either <parameter>ca_path</parameter>
or <parameter>ca_info</parameter> are considered invalid.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/setnonce.xml b/reference/oauth/oauth/setnonce.xml
index 924a97c9e195..342028afcb0f 100644
--- a/reference/oauth/oauth/setnonce.xml
+++ b/reference/oauth/oauth/setnonce.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::setNonce</methodname>
<methodparam><type>string</type><parameter>nonce</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the nonce for all subsequent requests.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
- <para>
+ <simpara>
The value for oauth_nonce.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,10 +33,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; on success, or &false; if the
<parameter>nonce</parameter> is considered invalid.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/setrequestengine.xml b/reference/oauth/oauth/setrequestengine.xml
index 3f5073cfced8..c29a0dbe6e9a 100644
--- a/reference/oauth/oauth/setrequestengine.xml
+++ b/reference/oauth/oauth/setrequestengine.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.setrequestengine" 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.setrequestengine">
<refnamediv>
<refname>OAuth::setRequestEngine</refname>
<refpurpose>The setRequestEngine purpose</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>void</type><methodname>OAuth::setRequestEngine</methodname>
<methodparam><type>int</type><parameter>reqengine</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the Request Engine, that will be sending the HTTP requests.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -27,11 +26,11 @@
<varlistentry>
<term><parameter>reqengine</parameter></term>
<listitem>
- <para>
+ <simpara>
The desired request engine. Set to <constant>OAUTH_REQENGINE_STREAMS</constant>
to use PHP Streams, or <constant>OAUTH_REQENGINE_CURL</constant> to use
<link linkend="book.curl">Curl</link>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,17 +38,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
+ <simpara>
Emits an <classname>OAuthException</classname> exception if an invalid
request engine is chosen.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -77,7 +76,6 @@ $consumer->setRequestEngine(OAUTH_REQENGINE_STREAMS);
</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 34b35523fed1..e05891e16456 100644
--- a/reference/oauth/oauth/setrsacertificate.xml
+++ b/reference/oauth/oauth/setrsacertificate.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::setRSACertificate</methodname>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the <acronym>RSA</acronym> certificate.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -26,9 +26,9 @@
<varlistentry>
<term><parameter>cert</parameter></term>
<listitem>
- <para>
+ <simpara>
The <acronym>RSA</acronym> certificate.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,10 +36,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; on success, or &false; on failure (e.g., the RSA certificate
cannot be parsed.)
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/setsslchecks.xml b/reference/oauth/oauth/setsslchecks.xml
index 6365bf637eaa..2a736bf9da75 100644
--- a/reference/oauth/oauth/setsslchecks.xml
+++ b/reference/oauth/oauth/setsslchecks.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauth.setsslchecks" 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.setsslchecks">
<refnamediv>
<refname>OAuth::setSSLChecks</refname>
<refpurpose>Tweak specific SSL checks for requests</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::setSSLChecks</methodname>
<methodparam><type>int</type><parameter>sslcheck</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Tweak specific SSL checks for requests.
- </para>
+ </simpara>
&warn.undocumented.func;
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>sslcheck</parameter></term>
<listitem>
- <para>
-
- </para>
+ <simpara>
+
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,14 +34,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
diff --git a/reference/oauth/oauth/settimestamp.xml b/reference/oauth/oauth/settimestamp.xml
index 591dca0cdedf..1d2c405c87eb 100644
--- a/reference/oauth/oauth/settimestamp.xml
+++ b/reference/oauth/oauth/settimestamp.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::setTimestamp</methodname>
<methodparam><type>string</type><parameter>timestamp</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the OAuth timestamp for subsequent requests.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -26,9 +26,9 @@
<varlistentry>
<term><parameter>timestamp</parameter></term>
<listitem>
- <para>
+ <simpara>
The timestamp.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,10 +36,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true;, unless the <parameter>timestamp</parameter> is invalid, in which
case &false; is returned.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/oauth/oauth/settoken.xml b/reference/oauth/oauth/settoken.xml
index 4383ab9b2aba..c895962a9049 100644
--- a/reference/oauth/oauth/settoken.xml
+++ b/reference/oauth/oauth/settoken.xml
@@ -13,9 +13,9 @@
<methodparam><type>string</type><parameter>token</parameter></methodparam>
<methodparam><type>string</type><parameter>token_secret</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Set the token and secret for subsequent requests.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>token</parameter></term>
<listitem>
- <para>
+ <simpara>
The OAuth token.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>token_secret</parameter></term>
<listitem>
- <para>
+ <simpara>
The OAuth token secret.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,9 +42,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/oauth/oauth/setversion.xml b/reference/oauth/oauth/setversion.xml
index e2fdb07c4979..7f96fcce644e 100644
--- a/reference/oauth/oauth/setversion.xml
+++ b/reference/oauth/oauth/setversion.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>bool</type><methodname>OAuth::setVersion</methodname>
<methodparam><type>string</type><parameter>version</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the OAuth version for subsequent requests
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
- <para>
+ <simpara>
OAuth version, default value is always "1.0"
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
</refentry>
diff --git a/reference/oauth/oauthexception.xml b/reference/oauth/oauthexception.xml
index 82057c9f7dbb..8f380b17d4e8 100644
--- a/reference/oauth/oauthexception.xml
+++ b/reference/oauth/oauthexception.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<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">
+<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 class</title>
<titleabbrev>OAuthException</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ OAuthException intro -->
<section xml:id="oauthexception.intro">
&reftitle.intro;
- <para>
+ <simpara>
This exception is thrown when exceptional errors occur while using the OAuth extension and contains useful debugging information.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -29,7 +28,7 @@
<ooclass>
<classname>OAuthException</classname>
</ooclass>
-
+
<ooclass>
<modifier>extends</modifier>
<classname>Exception</classname>
@@ -47,17 +46,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;
@@ -65,13 +64,13 @@
<varlistentry xml:id="oauthexception.props.lastresponse">
<term><varname>lastResponse</varname></term>
<listitem>
- <para>The response of the exception which occurred, if any</para>
+ <simpara>The response of the exception which occurred, if any</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="oauthexception.props.debuginfo">
<term><varname>debugInfo</varname></term>
<listitem>
- <para></para>
+ <simpara/>
</listitem>
</varlistentry>
</variablelist>
@@ -81,7 +80,6 @@
</partintro>
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider.xml b/reference/oauth/oauthprovider.xml
index f9fa05eb8f9f..90352860097f 100644
--- a/reference/oauth/oauthprovider.xml
+++ b/reference/oauth/oauthprovider.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<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">
+<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>The OAuthProvider class</title>
<titleabbrev>OAuthProvider</titleabbrev>
@@ -11,16 +10,16 @@
<!-- {{{ OAuthProvider intro -->
<section xml:id="oauthprovider.intro">
&reftitle.intro;
- <para>
+ <simpara>
Manages an OAuth provider class.
- </para>
- <para>
+ </simpara>
+ <simpara>
See also an external in-depth tutorial titled
<link xlink:href="&url.oauth.provider.tutorial;">Writing an OAuth Provider Service</link>,
- which takes a hands-on approach to providing this service. There are also
+ which takes a hands-on approach to providing this service. There are also
<link xlink:href="&url.oauth.examples;">OAuth provider examples</link> within the OAuth
extensions sources.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -38,9 +37,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>
<!-- }}} -->
@@ -51,7 +50,6 @@
&reference.oauth.entities.oauthprovider;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/addrequiredparameter.xml b/reference/oauth/oauthprovider/addrequiredparameter.xml
index 536eb6e478f3..ec694b532df6 100644
--- a/reference/oauth/oauthprovider/addrequiredparameter.xml
+++ b/reference/oauth/oauthprovider/addrequiredparameter.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.addrequiredparameter" 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="oauthprovider.addrequiredparameter">
<refnamediv>
<refname>OAuthProvider::addRequiredParameter</refname>
<refpurpose>Add required parameters</refpurpose>
@@ -13,9 +12,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>
Add required oauth provider parameters.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>req_params</parameter></term>
<listitem>
- <para>
+ <simpara>
The required parameters.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </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
diff --git a/reference/oauth/oauthprovider/callconsumerhandler.xml b/reference/oauth/oauthprovider/callconsumerhandler.xml
index cb16af0dadb4..3df61cf0435f 100644
--- a/reference/oauth/oauthprovider/callconsumerhandler.xml
+++ b/reference/oauth/oauthprovider/callconsumerhandler.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.callconsumerhandler" 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="oauthprovider.callconsumerhandler">
<refnamediv>
<refname>OAuthProvider::callconsumerHandler</refname>
<refpurpose>Calls the consumerNonceHandler callback</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::callconsumerHandler</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Calls the registered consumer handler callback function, which is set
with <methodname>OAuthProvider::consumerHandler</methodname>.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -29,16 +28,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">
@@ -49,7 +48,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml b/reference/oauth/oauthprovider/calltimestampnoncehandler.xml
index 040da312cf9f..6b19bb822902 100644
--- a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml
+++ b/reference/oauth/oauthprovider/calltimestampnoncehandler.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.calltimestampnoncehandler" 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="oauthprovider.calltimestampnoncehandler">
<refnamediv>
<refname>OAuthProvider::callTimestampNonceHandler</refname>
<refpurpose>Calls the timestampNonceHandler callback</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::callTimestampNonceHandler</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Calls the registered timestamp handler callback function, which is set
with <methodname>OAuthProvider::timestampNonceHandler</methodname>.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -29,16 +28,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">
@@ -49,7 +48,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/calltokenhandler.xml b/reference/oauth/oauthprovider/calltokenhandler.xml
index 62c8911329f1..050d3a9b0c4f 100644
--- a/reference/oauth/oauthprovider/calltokenhandler.xml
+++ b/reference/oauth/oauthprovider/calltokenhandler.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.calltokenhandler" 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="oauthprovider.calltokenhandler">
<refnamediv>
<refname>OAuthProvider::calltokenHandler</refname>
<refpurpose>Calls the tokenNonceHandler callback</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::calltokenHandler</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Calls the registered token handler callback function, which is set
with <methodname>OAuthProvider::tokenHandler</methodname>.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -29,16 +28,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">
@@ -49,7 +48,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/checkoauthrequest.xml b/reference/oauth/oauthprovider/checkoauthrequest.xml
index 8a15769cf7a7..8b06ac3a8124 100644
--- a/reference/oauth/oauthprovider/checkoauthrequest.xml
+++ b/reference/oauth/oauthprovider/checkoauthrequest.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.checkoauthrequest" 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="oauthprovider.checkoauthrequest">
<refnamediv>
<refname>OAuthProvider::checkOAuthRequest</refname>
<refpurpose>Check an oauth request</refpurpose>
@@ -14,9 +13,9 @@
<methodparam choice="opt"><type>string</type><parameter>uri</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>method</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Checks an OAuth request.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,18 +27,18 @@
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
- <para>
+ <simpara>
The optional <acronym>URI</acronym>, or endpoint.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>method</parameter></term>
<listitem>
- <para>
+ <simpara>
The <acronym>HTTP</acronym> method. Optionally pass in one of the
<constant>OAUTH_HTTP_METHOD_<replaceable>*</replaceable></constant> OAuth constants.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,17 +46,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
+ <simpara>
Emits an <constant>E_ERROR</constant> level error if
the HTTP method cannot be detected.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
@@ -68,7 +67,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/construct.xml b/reference/oauth/oauthprovider/construct.xml
index e4bcb1bc774d..9b54240a92a9 100644
--- a/reference/oauth/oauthprovider/construct.xml
+++ b/reference/oauth/oauthprovider/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.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="oauthprovider.construct">
<refnamediv>
<refname>OAuthProvider::__construct</refname>
<refpurpose>Constructs a new OAuthProvider object</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <methodname>OAuthProvider::__construct</methodname>
<methodparam choice="opt"><type>array</type><parameter>params_array</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Initiates a new <classname>OAuthProvider</classname> <type>object</type>.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -27,10 +26,10 @@
<varlistentry>
<term><parameter>params_array</parameter></term>
<listitem>
- <para>
+ <simpara>
Setting these optional parameters is limited to the
<link linkend="features.commandline">CLI SAPI</link>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
An <classname>OAuthProvider</classname> <type>object</type>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -85,7 +84,6 @@ try {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/consumerhandler.xml b/reference/oauth/oauthprovider/consumerhandler.xml
index a1f61234fdbc..092d541723a1 100644
--- a/reference/oauth/oauthprovider/consumerhandler.xml
+++ b/reference/oauth/oauthprovider/consumerhandler.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.consumerhandler" 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="oauthprovider.consumerhandler">
<refnamediv>
<refname>OAuthProvider::consumerHandler</refname>
<refpurpose>Set the consumerHandler handler callback</refpurpose>
@@ -13,10 +12,10 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::consumerHandler</methodname>
<methodparam><type>callable</type><parameter>callback_function</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the consumer handler callback, which will later be called with
<methodname>OAuthProvider::callConsumerHandler</methodname>.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>callback_function</parameter></term>
<listitem>
- <para>
+ <simpara>
The <type>callable</type> functions name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -76,7 +75,6 @@ function lookupConsumer($provider) {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/generatetoken.xml b/reference/oauth/oauthprovider/generatetoken.xml
index 7052ac17087e..344ccebb31e0 100644
--- a/reference/oauth/oauthprovider/generatetoken.xml
+++ b/reference/oauth/oauthprovider/generatetoken.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.generatetoken" 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="oauthprovider.generatetoken">
<refnamediv>
<refname>OAuthProvider::generateToken</refname>
<refpurpose>Generate a random token</refpurpose>
@@ -14,9 +13,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>
Generates a <type>string</type> of pseudo-random bytes.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,19 +24,19 @@
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
- <para>
+ <simpara>
The desired token length, in terms of bytes.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>strong</parameter></term>
<listitem>
- <para>
+ <simpara>
Setting to &true; means <literal>/dev/random</literal> will be used for
entropy, as otherwise the non-blocking <literal>/dev/urandom</literal> is used.
This parameter is ignored on Windows.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,20 +44,20 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The generated token, as a <type>string</type> of bytes.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
+ <simpara>
If the <parameter>strong</parameter> parameter is &true;, then an
<constant>E_WARNING</constant> level error will be emitted when the
fallback <function>rand</function> implementation is used to fill
the remaining random bytes (e.g., when not enough random data was found,
initially).
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -91,11 +90,11 @@ b6a82c27
<refsect1 role="notes">
&reftitle.notes;
<note>
- <para>
+ <simpara>
When not enough random data is available to the system, this function will
fill the remaining random bytes using the internal PHP <function>rand</function>
implementation.
- </para>
+ </simpara>
</note>
</refsect1>
@@ -108,7 +107,6 @@ b6a82c27
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/is2leggedendpoint.xml b/reference/oauth/oauthprovider/is2leggedendpoint.xml
index 6e811e09b6ec..5b02a339d302 100644
--- a/reference/oauth/oauthprovider/is2leggedendpoint.xml
+++ b/reference/oauth/oauthprovider/is2leggedendpoint.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.is2leggedendpoint" 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="oauthprovider.is2leggedendpoint">
<refnamediv>
<refname>OAuthProvider::is2LeggedEndpoint</refname>
<refpurpose>is2LeggedEndpoint</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::is2LeggedEndpoint</methodname>
<methodparam><type>mixed</type><parameter>params_array</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
The 2-legged flow, or request signing. It does not require a token.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>params_array</parameter></term>
<listitem>
- <para>
+ <simpara>
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
An <classname>OAuthProvider</classname> <type>object</type>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -68,7 +67,6 @@ $provider->is2LeggedEndpoint(true);
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml b/reference/oauth/oauthprovider/isrequesttokenendpoint.xml
index 103cf6a878d3..7b192c9fa5ec 100644
--- a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml
+++ b/reference/oauth/oauthprovider/isrequesttokenendpoint.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.isrequesttokenendpoint" 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="oauthprovider.isrequesttokenendpoint">
<refnamediv>
<refname>OAuthProvider::isRequestTokenEndpoint</refname>
<refpurpose>Sets isRequestTokenEndpoint</refpurpose>
@@ -13,9 +12,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;
@@ -27,10 +26,10 @@
<varlistentry>
<term><parameter>will_issue_request_token</parameter></term>
<listitem>
- <para>
+ <simpara>
Sets whether or not it will issue a request token, thus determining if
<methodname>OAuthProvider::tokenHandler</methodname> needs to be called.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </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
diff --git a/reference/oauth/oauthprovider/removerequiredparameter.xml b/reference/oauth/oauthprovider/removerequiredparameter.xml
index 3653b9a47d52..b13fd46791b0 100644
--- a/reference/oauth/oauthprovider/removerequiredparameter.xml
+++ b/reference/oauth/oauthprovider/removerequiredparameter.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.removerequiredparameter" 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="oauthprovider.removerequiredparameter">
<refnamediv>
<refname>OAuthProvider::removeRequiredParameter</refname>
<refpurpose>Remove a required parameter</refpurpose>
@@ -13,9 +12,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>
Removes a required parameter.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>req_params</parameter></term>
<listitem>
- <para>
+ <simpara>
The required parameter to be removed.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,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
diff --git a/reference/oauth/oauthprovider/reportproblem.xml b/reference/oauth/oauthprovider/reportproblem.xml
index 4fbbcd77ec6c..109eab1a6ce6 100644
--- a/reference/oauth/oauthprovider/reportproblem.xml
+++ b/reference/oauth/oauthprovider/reportproblem.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.reportproblem" 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="oauthprovider.reportproblem">
<refnamediv>
<refname>OAuthProvider::reportProblem</refname>
<refpurpose>Report a problem</refpurpose>
@@ -14,11 +13,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>
Pass in a problem as an <classname>OAuthException</classname>, with possible problems listed
in the <link linkend="oauth.constants">OAuth constants</link> section.
- </para>
-
+ </simpara>
+
&warn.undocumented.func;
</refsect1>
@@ -29,9 +28,9 @@
<varlistentry>
<term><parameter>oauthexception</parameter></term>
<listitem>
- <para>
+ <simpara>
The <classname>OAuthException</classname>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
@@ -53,7 +52,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/setparam.xml b/reference/oauth/oauthprovider/setparam.xml
index d2ef62326489..9504da506903 100644
--- a/reference/oauth/oauthprovider/setparam.xml
+++ b/reference/oauth/oauthprovider/setparam.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.setparam" 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="oauthprovider.setparam">
<refnamediv>
<refname>OAuthProvider::setParam</refname>
<refpurpose>Set a parameter</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>param_key</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>param_val</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets a parameter.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,21 +27,21 @@
<varlistentry>
<term><parameter>param_key</parameter></term>
<listitem>
- <para>
+ <simpara>
The parameter key.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param_val</parameter></term>
<listitem>
- <para>
+ <simpara>
The optional parameter value.
- </para>
- <para>
+ </simpara>
+ <simpara>
To exclude a parameter from signature verification, set
its value to &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
diff --git a/reference/oauth/oauthprovider/setrequesttokenpath.xml b/reference/oauth/oauthprovider/setrequesttokenpath.xml
index c0c438138233..60aa80684749 100644
--- a/reference/oauth/oauthprovider/setrequesttokenpath.xml
+++ b/reference/oauth/oauthprovider/setrequesttokenpath.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.setrequesttokenpath" 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="oauthprovider.setrequesttokenpath">
<refnamediv>
<refname>OAuthProvider::setRequestTokenPath</refname>
<refpurpose>Set request token path</refpurpose>
@@ -13,9 +12,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>
Sets the request tokens path.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
- <para>
+ <simpara>
The path.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&true;
- </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
diff --git a/reference/oauth/oauthprovider/timestampnoncehandler.xml b/reference/oauth/oauthprovider/timestampnoncehandler.xml
index d0edbfd08374..ee8887666a36 100644
--- a/reference/oauth/oauthprovider/timestampnoncehandler.xml
+++ b/reference/oauth/oauthprovider/timestampnoncehandler.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.timestampnoncehandler" 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="oauthprovider.timestampnoncehandler">
<refnamediv>
<refname>OAuthProvider::timestampNonceHandler</refname>
<refpurpose>Set the timestampNonceHandler handler callback</refpurpose>
@@ -13,11 +12,11 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::timestampNonceHandler</methodname>
<methodparam><type>callable</type><parameter>callback_function</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the timestamp nonce handler callback, which will later be called with
<methodname>OAuthProvider::callTimestampNonceHandler</methodname>. Errors related to
timestamp/nonce are thrown to this callback.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -29,9 +28,9 @@
<varlistentry>
<term><parameter>callback_function</parameter></term>
<listitem>
- <para>
+ <simpara>
The <type>callable</type> functions name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -58,7 +57,7 @@ function timestampNonceChecker($provider) {
} elseif ($provider->timestamp == '0') {
return OAUTH_BAD_TIMESTAMP;
}
-
+
return OAUTH_OK;
}
?>
@@ -75,7 +74,6 @@ function timestampNonceChecker($provider) {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/oauthprovider/tokenhandler.xml b/reference/oauth/oauthprovider/tokenhandler.xml
index fdf710c014b5..57093cc09fbe 100644
--- a/reference/oauth/oauthprovider/tokenhandler.xml
+++ b/reference/oauth/oauthprovider/tokenhandler.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="oauthprovider.tokenhandler" 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="oauthprovider.tokenhandler">
<refnamediv>
<refname>OAuthProvider::tokenHandler</refname>
<refpurpose>Set the tokenHandler handler callback</refpurpose>
@@ -13,10 +12,10 @@
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::tokenHandler</methodname>
<methodparam><type>callable</type><parameter>callback_function</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the token handler callback, which will later be called with
<methodname>OAuthProvider::callTokenHandler</methodname>.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>callback_function</parameter></term>
<listitem>
- <para>
+ <simpara>
The <type>callable</type> functions name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -51,7 +50,7 @@
<![CDATA[
<?php
function tokenHandler($provider) {
-
+
if ($provider->token === 'rejected') {
return OAUTH_TOKEN_REJECTED;
} elseif ($provider->token === 'revoked') {
@@ -75,7 +74,6 @@ function tokenHandler($provider) {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/oauth/setup.xml b/reference/oauth/setup.xml
index 6bd0d3665812..e7f20effd269 100644
--- a/reference/oauth/setup.xml
+++ b/reference/oauth/setup.xml
@@ -1,19 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="oauth.setup" 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.setup">
&reftitle.setup;
<section xml:id="oauth.requirements">
&reftitle.required;
- <para>
+ <simpara>
PECL/oauth requires PHP 5.1 or newer, ext/hash and ext/pcre.
- </para>
- <para>
+ </simpara>
+ <simpara>
PECL/oauth may optionally require libcurl if selected at build
time. If configured with libcurl, it must be built with HTTPS
support.
- </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
-->
-