[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/oauth/_oauth/construct.xml_oauth/destruct.xml_oa
From: Philip_Olson <philip () php ! net>
Date: 2010-05-31 17:16:14
Message-ID: svn-philip-1275326174-299997-1650508399 () svn ! php ! net
[Download RAW message or body]
philip Mon, 31 May 2010 17:16:14 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=299997
Log:
Updated OAuth documentation to reflect current trunk, which includes:
- Added missing methods and properties
- Updated current methods (usually with current return values)
- A few other miscellaneous changes/updates
Changed paths:
U phpdoc/en/trunk/reference/oauth/oauth/construct.xml
A phpdoc/en/trunk/reference/oauth/oauth/destruct.xml
U phpdoc/en/trunk/reference/oauth/oauth/disabledebug.xml
A phpdoc/en/trunk/reference/oauth/oauth/disableredirects.xml
U phpdoc/en/trunk/reference/oauth/oauth/disablesslchecks.xml
U phpdoc/en/trunk/reference/oauth/oauth/enabledebug.xml
A phpdoc/en/trunk/reference/oauth/oauth/enableredirects.xml
U phpdoc/en/trunk/reference/oauth/oauth/enablesslchecks.xml
U phpdoc/en/trunk/reference/oauth/oauth/fetch.xml
A phpdoc/en/trunk/reference/oauth/oauth/getcapath.xml
U phpdoc/en/trunk/reference/oauth/oauth/setauthtype.xml
A phpdoc/en/trunk/reference/oauth/oauth/setcapath.xml
U phpdoc/en/trunk/reference/oauth/oauth/setnonce.xml
A phpdoc/en/trunk/reference/oauth/oauth/setrequestengine.xml
A phpdoc/en/trunk/reference/oauth/oauth/setrsacertificate.xml
A phpdoc/en/trunk/reference/oauth/oauth/settimestamp.xml
U phpdoc/en/trunk/reference/oauth/oauth/settoken.xml
U phpdoc/en/trunk/reference/oauth/oauth.xml
U phpdoc/en/trunk/reference/oauth/versions.xml
["svn-diffs-299997.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/reference/oauth/oauth/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/construct.xml 2010-05-31 17:09:13 UTC (rev \
299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/construct.xml 2010-05-31 17:16:14 UTC (rev \
299997) @@ -13,7 +13,7 @@
<methodname>OAuth::__construct</methodname>
<methodparam><type>string</type><parameter>consumer_key</parameter></methodparam>
<methodparam><type>string</type><parameter>consumer_secret</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>signature_method</parameter></methodparam>
+ <methodparam choice="opt"><type>string</type><parameter>signature_method</paramet \
er><initializer><constant>OAUTH_SIG_METHOD_HMACSHA1</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>auth_type</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Added: phpdoc/en/trunk/reference/oauth/oauth/destruct.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/destruct.xml (rev \
0)
+++ phpdoc/en/trunk/reference/oauth/oauth/destruct.xml 2010-05-31 17:16:14 UTC (rev \
299997) @@ -0,0 +1,64 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::__destruct</refname>
+ <refpurpose>The destructor</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuth::__destruct</methodname> + <void />
+ </methodsynopsis>
+ <para>
+ The destructor.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuth::__construct</methodname></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/destruct.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/oauth/oauth/disabledebug.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/disabledebug.xml 2010-05-31 17:09:13 UTC \
(rev 299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/disabledebug.xml 2010-05-31 17:16:14 UTC \
(rev 299997) @@ -15,8 +15,8 @@
</methodsynopsis>
<para>
Turns off verbose request information (off by default).
- Alternatively, the <parameter>debug</parameter> member can be set
- to a &false; value to turn debug off.
+ Alternatively, the <link linkend="oauth.props.debug">debug</link> property can
+ be set to a &false; value to turn debug off.
</para>
</refsect1>
@@ -28,7 +28,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ &true;
</para>
</refsect1>
@@ -47,7 +47,7 @@
<row>
<entry>0.99.8</entry>
<entry>
- The <parameter>debug</parameter> member was added
+ The related <link linkend="oauth.props.debug">debug</link> property was \
added. </entry>
</row>
</tbody>
Added: phpdoc/en/trunk/reference/oauth/oauth/disableredirects.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/disableredirects.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauth/disableredirects.xml 2010-05-31 17:16:14 \
UTC (rev 299997) @@ -0,0 +1,64 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::disableRedirects</refname>
+ <refpurpose>Turn off redirects</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>bool</type><methodname>OAuth::disableRedirects</methodname> + <void />
+ </methodsynopsis>
+ <para>
+ Disable redirects from being followed automatically, thus allowing the request to \
be manually redirected. + </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &true;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuth::enableRedirects</methodname></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/disableredirects.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/oauth/oauth/disablesslchecks.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/disablesslchecks.xml 2010-05-31 17:09:13 \
UTC (rev 299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/disablesslchecks.xml 2010-05-31 17:16:14 \
UTC (rev 299997) @@ -29,7 +29,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ &true;
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/oauth/oauth/enabledebug.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/enabledebug.xml 2010-05-31 17:09:13 UTC \
(rev 299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/enabledebug.xml 2010-05-31 17:16:14 UTC \
(rev 299997) @@ -29,7 +29,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ &true;
</para>
</refsect1>
Added: phpdoc/en/trunk/reference/oauth/oauth/enableredirects.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/enableredirects.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauth/enableredirects.xml 2010-05-31 17:16:14 UTC \
(rev 299997) @@ -0,0 +1,64 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::enableRedirects</refname>
+ <refpurpose>Turn on redirects</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>bool</type><methodname>OAuth::enableRedirects</methodname> + <void />
+ </methodsynopsis>
+ <para>
+ Follow and sign redirects automatically, which is enabled by default.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &true;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuth::disableRedirects</methodname></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/enableredirects.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/oauth/oauth/enablesslchecks.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/enablesslchecks.xml 2010-05-31 17:09:13 UTC \
(rev 299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/enablesslchecks.xml 2010-05-31 17:16:14 UTC \
(rev 299997) @@ -26,7 +26,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ &true;
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/oauth/oauth/fetch.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/fetch.xml 2010-05-31 17:09:13 UTC (rev \
299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/fetch.xml 2010-05-31 17:16:14 UTC (rev \
299997) @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>bool</type><methodname>OAuth::fetch</methodname> + \
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::fetch</methodname> \
<methodparam><type>string</type><parameter>protected_resource_url</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>extra_parameters</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>http_method</parameter></methodparam>
@@ -43,46 +43,17 @@
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
- <listitem>
- <para>
- <parameter>http_method</parameter> can be one of the following:
- <variablelist>
- <varlistentry>
- <term><constant>OAUTH_HTTP_METHOD_GET</constant></term>
- <listitem>
- <simpara>
- Set the request method to <literal>GET</literal>.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><constant>OAUTH_HTTP_METHOD_POST</constant></term>
- <listitem>
- <simpara>
- Set the request method to <literal>POST</literal>.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><constant>OAUTH_HTTP_METHOD_PUT</constant></term>
- <listitem>
- <simpara>
- Set the request method to <literal>PUT</literal>.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><constant>OAUTH_HTTP_METHOD_HEAD</constant></term>
- <listitem>
- <simpara>
- Set the request method to <literal>HEAD</literal>, this can be useful for
- discovering information prior to the request (if OAuth credentials are
- in the <literal>Authorization</literal> header).
- </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
+ <listitem>
+ <para>
+ One of the <constant>OAUTH_HTTP_METHOD_*</constant>
+ <link linkend="oauth.constants">OAUTH constants</link>, 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>
@@ -100,7 +71,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ Returns &true; on success, or &null; on failure.
</para>
</refsect1>
Added: phpdoc/en/trunk/reference/oauth/oauth/getcapath.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/getcapath.xml (rev \
0)
+++ phpdoc/en/trunk/reference/oauth/oauth/getcapath.xml 2010-05-31 17:16:14 UTC (rev \
299997) @@ -0,0 +1,68 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::getCAPath</refname>
+ <refpurpose>Gets CA information</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>array</type><methodname>OAuth::getCAPath</methodname> + <void />
+ </methodsynopsis>
+ <para>
+ Gets the Certificate Authority information, which includes the
+ ca_path and ca_info set by <methodname>OAuth::setCaPath</methodname>.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ 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>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuth::setCAPath</methodname></member>
+ <member><methodname>OAuth::getLastResponseInfo</methodname></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/getcapath.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/oauth/oauth/setauthtype.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/setauthtype.xml 2010-05-31 17:09:13 UTC \
(rev 299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/setauthtype.xml 2010-05-31 17:16:14 UTC \
(rev 299997) @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>bool</type><methodname>OAuth::setAuthType</methodname> + \
<modifier>public</modifier> \
<type>mixed</type><methodname>OAuth::setAuthType</methodname> \
<methodparam><type>int</type><parameter>auth_type</parameter></methodparam> \
</methodsynopsis> <para>
@@ -52,6 +52,14 @@
</simpara>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><constant>OAUTH_AUTH_TYPE_NONE</constant></term>
+ <listitem>
+ <simpara>
+ None.
+ </simpara>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</listitem>
@@ -63,7 +71,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ Returns &true; of a parameter is correctly set,
+ &null; if an invalid <parameter>auth_type</parameter> is passed in,
+ otherwise &false;
</para>
</refsect1>
Added: phpdoc/en/trunk/reference/oauth/oauth/setcapath.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/setcapath.xml (rev \
0)
+++ phpdoc/en/trunk/reference/oauth/oauth/setcapath.xml 2010-05-31 17:16:14 UTC (rev \
299997) @@ -0,0 +1,85 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::setCAPath</refname>
+ <refpurpose>Set CA path and info</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>mixed</type><methodname>OAuth::setCAPath</methodname> + \
<methodparam><type>string</type><parameter>ca_path</parameter></methodparam> + \
<methodparam><type>string</type><parameter>ca_info</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Sets the Certificate Authority (<acronym>CA</acronym>), both for path
+ and info.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>ca_path</parameter></term>
+ <listitem>
+ <para>
+ The CA Path being set.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>ca_info</parameter></term>
+ <listitem>
+ <para>
+ The CA Info being set.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true; on success, or &null; if either <parameter>ca_path</parameter>
+ or <parameter>ca_info</parameter> are considered invalid.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuth::getCaPath</methodname></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/setcapath.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/oauth/oauth/setnonce.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/setnonce.xml 2010-05-31 17:09:13 UTC (rev \
299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/setnonce.xml 2010-05-31 17:16:14 UTC (rev \
299997) @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>bool</type><methodname>OAuth::setNonce</methodname> + \
<modifier>public</modifier> \
<type>mixed</type><methodname>OAuth::setNonce</methodname> \
<methodparam><type>string</type><parameter>nonce</parameter></methodparam> \
</methodsynopsis> <para>
@@ -37,7 +37,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ Returns &true; on success, or &null; if the
+ <parameter>nonce</parameter> is considered invalid.
</para>
</refsect1>
Added: phpdoc/en/trunk/reference/oauth/oauth/setrequestengine.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/setrequestengine.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauth/setrequestengine.xml 2010-05-31 17:16:14 \
UTC (rev 299997) @@ -0,0 +1,100 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::setRequestEngine</refname>
+ <refpurpose>The setRequestEngine purpose</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuth::setRequestEngine</methodname> + \
<methodparam><type>string</type><parameter>reqengine</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Sets the Request Engine, that will be sending the HTTP requests.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>reqengine</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Emits an <classname>OAuthException</classname> exception if an invalid
+ request engine is chosen.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><function>OAuth::setRequestEngine</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$consumer = new OAuth();
+
+$consumer->setRequestEngine(OAUTH_REQENGINE_STREAMS);
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><link linkend="book.curl">Curl</link></member>
+ <member><link linkend="book.stream">PHP streams</link></member>
+ <member><classname>OAuthException</classname></member>
+ </simplelist>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/setrequestengine.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauth/setrsacertificate.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/setrsacertificate.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauth/setrsacertificate.xml 2010-05-31 17:16:14 \
UTC (rev 299997) @@ -0,0 +1,90 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::setRSACertificate</refname>
+ <refpurpose>Set the RSA certificate</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>mixed</type><methodname>OAuth::setRSACertificate</methodname> + \
<methodparam><type>string</type><parameter>cert</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Sets the <acronym>RSA</acronym> certificate.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cert</parameter></term>
+ <listitem>
+ <para>
+ The <acronym>RSA</acronym> certificate.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true; on success, or &null; on failure (e.g., the RSA certificate
+ cannot be parsed.)
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example xml:id="oauth.setrsacertificate.example">
+ <title>An <methodname>OAuth::setRsaCertificate</methodname> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$consume = new OAuth('1234', '', OAUTH_SIG_METHOD_RSASHA1);
+
+$consume->setRSACertificate(file_get_contents('test.pem'));
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuth::setCaPath</methodname></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/setrsacertificate.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauth/settimestamp.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/settimestamp.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauth/settimestamp.xml 2010-05-31 17:16:14 UTC \
(rev 299997) @@ -0,0 +1,74 @@
+<?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"> + <refnamediv>
+ <refname>OAuth::setTimestamp</refname>
+ <refpurpose>Set the timestamp</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>mixed</type><methodname>OAuth::setTimestamp</methodname> + \
<methodparam><type>string</type><parameter>timestamp</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Sets the OAuth timestamp for subsequent requests.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>timestamp</parameter></term>
+ <listitem>
+ <para>
+ The timestamp.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true;, unless the <parameter>timestamp</parameter> is invalid, in which
+ case &null; is returned.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>setNonce</methodname></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Property changes on: phpdoc/en/trunk/reference/oauth/oauth/settimestamp.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/oauth/oauth/settoken.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth/settoken.xml 2010-05-31 17:09:13 UTC (rev \
299996)
+++ phpdoc/en/trunk/reference/oauth/oauth/settoken.xml 2010-05-31 17:16:14 UTC (rev \
299997) @@ -46,7 +46,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ &true;
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/oauth/oauth.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauth.xml 2010-05-31 17:09:13 UTC (rev 299996)
+++ phpdoc/en/trunk/reference/oauth/oauth.xml 2010-05-31 17:16:14 UTC (rev 299997)
@@ -32,7 +32,21 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
-
+
+ <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+ <fieldsynopsis>
+ <modifier>public</modifier>
+ <varname linkend="oauth.props.debug">debug</varname>
+ </fieldsynopsis>
+ <fieldsynopsis>
+ <modifier>public</modifier>
+ <varname linkend="oauth.props.sslchecks">sslChecks</varname>
+ </fieldsynopsis>
+ <fieldsynopsis>
+ <modifier>public</modifier>
+ <varname linkend="oauth.props.debuginfo">debugInfo</varname>
+ </fieldsynopsis>
+
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.oauth')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" \
/> </classsynopsis>
@@ -40,6 +54,30 @@
</section>
+ <section xml:id="oauth.props">
+ &reftitle.properties;
+ <variablelist>
+ <varlistentry xml:id="oauth.props.debug">
+ <term><varname>debug</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="oauth.props.sslchecks">
+ <term><varname>sslChecks</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="oauth.props.debuginfo">
+ <term><varname>debugInfo</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
</partintro>
&reference.oauth.entities.oauth;
Modified: phpdoc/en/trunk/reference/oauth/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/versions.xml 2010-05-31 17:09:13 UTC (rev 299996)
+++ phpdoc/en/trunk/reference/oauth/versions.xml 2010-05-31 17:16:14 UTC (rev 299997)
@@ -7,8 +7,10 @@
<!-- Functions -->
<function name='oauth_urlencode' from='PECL OAuth >=0.99.2'/>
<function name='oauth_get_sbs' from='PECL OAuth >=0.99.7'/>
+
<!-- Methods -->
<function name='oauth::__construct' from='PECL OAuth >= 0.99.1'/>
+ <function name='oauth::__destruct' from='PECL OAuth >= 0.99.9'/>
<function name='oauth::getrequesttoken' from='PECL OAuth >= 0.99.1'/>
<function name='oauth::getaccesstoken' from='PECL OAuth >= 0.99.1'/>
<function name='oauth::getlastresponse' from='PECL OAuth >= 0.99.1'/>
@@ -17,11 +19,19 @@
<function name='oauth::setversion' from='PECL OAuth >= 0.99.1'/>
<function name='oauth::setauthtype' from='PECL OAuth >= 0.99.1'/>
<function name='oauth::setnonce' from='PECL OAuth >= 0.99.1'/>
+ <function name='oauth::setRequestEngine' from='PECL OAuth >= 1.0.0'/>
+ <function name='oauth::setRsaCertificate' from='PECL OAuth >= 1.0.0'/>
+ <function name='oauth::setTimestamp' from='PECL OAuth >= 1.0.0'/>
<function name='oauth::fetch' from='PECL OAuth >= 0.99.1'/>
<function name='oauth::enableDebug' from='PECL OAuth >= 0.99.3'/>
<function name='oauth::disableDebug' from='PECL OAuth >= 0.99.3'/>
+ <function name='oauth::disableRedirects' from='PECL OAuth >= 0.99.9'/>
+ <function name='oauth::enableRedirects' from='PECL OAuth >= 0.99.9'/>
<function name='oauth::enableSSLChecks' from='PECL OAuth >= 0.99.5'/>
<function name='oauth::disableSSLChecks' from='PECL OAuth >= 0.99.5'/>
+ <function name='oauth::setCaPath' from='PECL OAuth >= 0.99.8'/>
+ <function name='oauth::getCaPath' from='PECL OAuth >= 0.99.8'/>
+
<function name='oauthexception::__clone' from='PECL OAuth >= 0.99.1'/>
<function name='oauthexception::__construct' from='PECL OAuth >= 0.99.1'/>
<function name='oauthexception::getmessage' from='PECL OAuth >= 0.99.1'/>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic