[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/_language-snippets.ent_reference/oauth/book.xml_reference/
From: Philip_Olson <philip () php ! net>
Date: 2010-05-27 16:02:15
Message-ID: svn-philip-1274976135-299859-1744884214 () svn ! php ! net
[Download RAW message or body]
philip Thu, 27 May 2010 16:02:15 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=299859
Log:
Added basic documention for OAuthProvider.
Changed paths:
U phpdoc/en/trunk/language-snippets.ent
U phpdoc/en/trunk/reference/oauth/book.xml
U phpdoc/en/trunk/reference/oauth/constants.xml
U phpdoc/en/trunk/reference/oauth/oauthexception.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/
A phpdoc/en/trunk/reference/oauth/oauthprovider/addrequiredparameter.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/callconsumerhandler.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/calltimestampnoncehandler.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/calltokenhandler.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/checkoauthrequest.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/construct.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/consumerhandler.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/is2leggedendpoint.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/isrequesttokenendpoint.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/removerequiredparameter.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/reportproblem.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/setparam.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/setrequesttokenpath.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/timestampnoncehandler.xml
A phpdoc/en/trunk/reference/oauth/oauthprovider/tokenhandler.xml
U phpdoc/en/trunk/reference/oauth/versions.xml
["svn-diffs-299859.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2010-05-27 15:01:58 UTC (rev 299858)
+++ phpdoc/en/trunk/language-snippets.ent 2010-05-27 16:02:15 UTC (rev 299859)
@@ -545,6 +545,9 @@
<!ENTITY odbc.parameter.search 'This parameter accepts the following search \
patterns: "%" to match zero or more characters, and "_" to match a single \
character.'>
+<!ENTITY oauth.callback.error 'Emits an <constant \
xmlns="http://docbook.org/ns/docbook">E_ERROR</constant> level +error if the callback \
function cannot be called, or was not specified.'> +
<!-- Oracle -->
<!ENTITY oci.db "<para xmlns='http://docbook.org/ns/docbook' \
xmlns:xlink='http://www.w3.org/1999/xlink'>Contains the <literal>Oracle \
instance</literal> to connect to. It can be
Modified: phpdoc/en/trunk/reference/oauth/book.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/book.xml 2010-05-27 15:01:58 UTC (rev 299858)
+++ phpdoc/en/trunk/reference/oauth/book.xml 2010-05-27 16:02:15 UTC (rev 299859)
@@ -9,7 +9,7 @@
<preface xml:id="intro.oauth">
&reftitle.intro;
<para>
- This extension provides OAuth consumer bindings. OAuth is an
+ This extension provides OAuth 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.
@@ -21,6 +21,7 @@
&reference.oauth.examples;
&reference.oauth.reference;
&reference.oauth.oauth;
+ &reference.oauth.oauthprovider;
&reference.oauth.oauthexception;
</book>
Modified: phpdoc/en/trunk/reference/oauth/constants.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/constants.xml 2010-05-27 15:01:58 UTC (rev \
299858)
+++ phpdoc/en/trunk/reference/oauth/constants.xml 2010-05-27 16:02:15 UTC (rev \
299859) @@ -5,20 +5,49 @@
&reftitle.constants;
&extension.constants;
<para>
+ 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>
+ <para>
<variablelist>
+ <!-- TODO: Ensure each constant mentions the exact oauth API name/value pair. -->
<varlistentry>
<term>
+ <constant>OAUTH_SIG_METHOD_RSASHA1</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <simpara>
+ OAuth <emphasis>RSA-SHA1</emphasis> signature method.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
<constant>OAUTH_SIG_METHOD_HMACSHA1</constant>
(<type>string</type>)
</term>
<listitem>
<para>
- OAuth HMAC-SHA1 signature method
+ OAuth <emphasis>HMAC-SHA1</emphasis> signature method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
+ <constant>OAUTH_SIG_METHOD_HMACSHA256</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <simpara>
+ OAuth <emphasis>HMAC-SHA256</emphasis> signature method.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
<constant>OAUTH_AUTH_TYPE_AUTHORIZATION</constant>
(<type>string</type>)
</term>
@@ -48,7 +77,7 @@
<listitem>
<para>
This constant represents putting OAuth parameters in the request
- URI.
+ <acronym>URI</acronym>.
</para>
</listitem>
</varlistentry>
@@ -71,7 +100,7 @@
</term>
<listitem>
<para>
- Use the GET method for the OAuth request
+ Use the <emphasis>GET</emphasis> method for the OAuth request.
</para>
</listitem>
</varlistentry>
@@ -82,7 +111,7 @@
</term>
<listitem>
<para>
- Use the POST method for the OAuth request
+ Use the <emphasis>POST</emphasis> method for the OAuth request.
</para>
</listitem>
</varlistentry>
@@ -93,7 +122,7 @@
</term>
<listitem>
<para>
- Use the PUT method for the OAuth request
+ Use the <emphasis>PUT</emphasis> method for the OAuth request.
</para>
</listitem>
</varlistentry>
@@ -104,10 +133,200 @@
</term>
<listitem>
<para>
- Use the HEAD method for the OAuth request
+ Use the <emphasis>HEAD</emphasis> method for the OAuth request.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_HTTP_METHOD_DELETE</constant>
+ (<type>string</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Use the <emphasis>DELETE</emphasis> method for the OAuth request.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_REQENGINE_STREAMS</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Used by <methodname>Oauth::setReqeustEngine</methodname> to set the engine to
+ <link linkend="book.stream">PHP streams</link>,
+ as opposed to <constant>OAUTH_REQENGINE_CURL</constant> for
+ <link linkend="book.curl">Curl</link>.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_REQENGINE_CURL</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Used by <methodname>Oauth::setReqeustEngine</methodname> to set the engine to
+ <link linkend="book.curl">Curl</link>, as opposed to
+ <constant>OAUTH_REQENGINE_STREAMS</constant> for <link \
linkend="book.stream">PHP streams</link>. + </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_OK</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Life is good.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_BAD_NONCE</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_nonce</emphasis> value was used in a previous request,
+ therefore it cannot be used now.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_BAD_TIMESTAMP</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_timestamp</emphasis> value was not accepted by the \
service provider. In + this case, the response should also contain the \
<emphasis>oauth_acceptable_timestamps</emphasis> + parameter.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_CONSUMER_KEY_UNKNOWN</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_consumer_key</emphasis> is temporarily unacceptable to the \
service provider. + For example, the service provider may be throttling the \
consumer. + </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_CONSUMER_KEY_REFUSED</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The consumer key was refused.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_INVALID_SIGNATURE</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_signature</emphasis> is invalid, as it does not match the
+ signature computed by the service provider.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_TOKEN_USED</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> has been consumed. It can no longer be
+ used because it has already been used in the previous request (or requests).
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_TOKEN_EXPIRED</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> has expired.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_TOKEN_REVOKED</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> has been revoked, and will never be \
accepted. + </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_TOKEN_REJECTED</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_token</emphasis> was not accepted by the service provider.
+ The reason is not known, but it might be because the token was never issued,
+ already consumed, expired, and/or forgotten by the service provider.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_VERIFIER_INVALID</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_verifier</emphasis> is incorrect.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_PARAMETER_ABSENT</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ A required parameter was not received. In this case, the response should also
+ contain the <emphasis>oauth_parameters_absent</emphasis> parameter.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>OAUTH_SIGNATURE_METHOD_REJECTED</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+ The <emphasis>oauth_signature_method</emphasis> was not accepted by service \
provider. + </simpara>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</appendix>
Modified: phpdoc/en/trunk/reference/oauth/oauthexception.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthexception.xml 2010-05-27 15:01:58 UTC (rev \
299858)
+++ phpdoc/en/trunk/reference/oauth/oauthexception.xml 2010-05-27 16:02:15 UTC (rev \
299859) @@ -41,6 +41,10 @@
<modifier>public</modifier>
<varname linkend="oauthexception.props.lastResponse">lastResponse</varname>
</fieldsynopsis>
+ <fieldsynopsis>
+ <modifier>public</modifier>
+ <varname linkend="oauthexception.props.debuginfo">debugInfo</varname>
+ </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])" \
/> @@ -85,6 +89,12 @@
<para>The response of the exception which occurred, if any</para>
</listitem>
</varlistentry>
+ <varlistentry xml:id="oauthexception.props.debuginfo">
+ <term><varname>debugInfo</varname></term>
+ <listitem>
+ <para></para>
+ </listitem>
+ </varlistentry>
</variablelist>
</section>
<!-- }}} -->
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/addrequiredparameter.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/addrequiredparameter.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/addrequiredparameter.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,73 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::addRequiredParameter</refname>
+ <refpurpose>Add required parameters</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>OAuthProvider::addRequiredParameter</methodname> + \
<methodparam><type>string</type><parameter>req_params</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Add required oauth provider parameters.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>req_params</parameter></term>
+ <listitem>
+ <para>
+ The required parameters.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::removeRequiredParameter</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/oauthprovider/addrequiredparameter.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/callconsumerhandler.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/callconsumerhandler.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/callconsumerhandler.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,72 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::callconsumerHandler</refname>
+ <refpurpose>Calls the consumerNonceHandler callback</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::callconsumerHandler</methodname> + \
<void /> + </methodsynopsis>
+ <para>
+ Calls the registered consumer handler callback function, which is set
+ with <methodname>OAuthProvider::consumerHandler</methodname>.
+ </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="errors">
+ &reftitle.errors;
+ <para>
+ &oauth.callback.error;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::consumerHandler</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/oauthprovider/callconsumerhandler.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/calltimestampnoncehandler.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/calltimestampnoncehandler.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/calltimestampnoncehandler.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,72 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::callTimestampNonceHandler</refname>
+ <refpurpose>Calls the timestampNonceHandler callback</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::callTimestampNonceHandler</methodname> + \
<void /> + </methodsynopsis>
+ <para>
+ Calls the registered timestamp handler callback function, which is set
+ with <methodname>OAuthProvider::timestampNonceHandler</methodname>.
+ </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="errors">
+ &reftitle.errors;
+ <para>
+ &oauth.callback.error;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::timestampNonceHandler</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/oauthprovider/calltimestampnoncehandler.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/calltokenhandler.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/calltokenhandler.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/calltokenhandler.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,72 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::calltokenHandler</refname>
+ <refpurpose>Calls the tokenNonceHandler callback</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::calltokenHandler</methodname> + <void \
/> + </methodsynopsis>
+ <para>
+ Calls the registered token handler callback function, which is set
+ with <methodname>OAuthProvider::tokenHandler</methodname>.
+ </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="errors">
+ &reftitle.errors;
+ <para>
+ &oauth.callback.error;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::tokenHandler</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/oauthprovider/calltokenhandler.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/checkoauthrequest.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/checkoauthrequest.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/checkoauthrequest.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,91 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::checkOAuthRequest</refname>
+ <refpurpose>Check an oauth request</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::checkOAuthRequest</methodname> + \
<methodparam choice="opt"><type>string</type><parameter>uri</parameter></methodparam> \
+ <methodparam choice="opt"><type>string</type><parameter>method</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Checks an OAuth request.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>uri</parameter></term>
+ <listitem>
+ <para>
+ The optional <acronym>URI</acronym>, or endpoint.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>method</parameter></term>
+ <listitem>
+ <para>
+ The <acronym>HTTP</acronym> method. Optionally pass in one of the
+ <constant>OAUTH_HTTP_METHOD_*</constant> <link linkend="oauth.constants">OAuth \
constants</link>. + </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Emits an <constant>E_ERROR</constant> level error if
+ the HTTP method cannot be detected.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::reportProblem</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/oauthprovider/checkoauthrequest.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/construct.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/construct.xml 2010-05-27 16:02:15 \
UTC (rev 299859) @@ -0,0 +1,108 @@
+<?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"> + <refnamediv>
+ <refname>OAuthProvider::__construct</refname>
+ <refpurpose>Constructs a new OAuthProvider object</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <methodname>OAuthProvider::__construct</methodname>
+ <methodparam choice="opt"><type>array</type><parameter>params_array</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Initiates a new <classname>OAuthProvider</classname> <type>object</type>.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>params_array</parameter></term>
+ <listitem>
+ <para>
+ Setting these these optional parameters is limited to the
+ <link linkend="features.commandline">CLI SAPI</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An <classname>OAuthProvider</classname> <type>object</type>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><function>OAuthProvider::__construct</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+try {
+
+ $op = new OAuthProvider();
+
+ // Uses user-defined callback functions
+ $op->consumerHandler(array($this, 'lookupConsumer'));
+ $op->timestampNonceHandler(array($this, 'timestampNonceChecker'));
+ $op->tokenHandler(array($this, 'myTokenHandler'));
+
+ // Ignore the foo_uri parameter
+ $op->setParam('foo_uri', NULL);
+
+ // No token needed for this end point
+ $op->setRequestTokenPath('/v1/oauth/request_token');
+
+ $op->checkOAuthRequest();
+
+} catch (OAuthException $e) {
+
+ echo OAuthProvider::reportProblem($e);
+}
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::setParam</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/oauthprovider/construct.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/consumerhandler.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/consumerhandler.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/consumerhandler.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,99 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::consumerHandler</refname>
+ <refpurpose>Set the consumerHandler handler callback</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::consumerHandler</methodname> + \
<methodparam><type>callback</type><parameter>callback_function</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Sets the consumer handler callback, which will later be called with
+ <methodname>OAuthProvider::callConsumerHandler</methodname>.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>callback_function</parameter></term>
+ <listitem>
+ <para>
+ The <type>callback</type> functions name.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title>Example <methodname>OAuthProvider::consumerHandler</methodname> \
callback</title> + <programlisting role="php">
+<![CDATA[
+<?php
+function lookupConsumer($provider) {
+
+ if ($provider->consumer_key === 'unknown') {
+ return OAUTH_CONSUMER_KEY_UNKNOWN;
+ } else if($provider->consumer_key == 'blacklisted' || $provider->consumer_key \
=== 'throttled') { + return OAUTH_CONSUMER_KEY_REFUSED;
+ }
+
+ $provider->consumer_secret = "the_consumers_secret";
+
+ return OAUTH_OK;
+}
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::callConsumerHandler</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/oauthprovider/consumerhandler.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/is2leggedendpoint.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/is2leggedendpoint.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/is2leggedendpoint.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,91 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::is2LeggedEndpoint</refname>
+ <refpurpose>is2LeggedEndpoint</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::is2LeggedEndpoint</methodname> + \
<methodparam><type>mixed</type><parameter>params_array</parameter></methodparam> + \
</methodsynopsis> + <para>
+ The 2-legged flow, or request signing. It does not require a token.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>params_array</parameter></term>
+ <listitem>
+ <para>
+
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An <classname>OAuthProvider</classname> <type>object</type>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><function>OAuthProvider::is2LeggedEndpoint</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+$provider = new OAuthProvider();
+
+$provider->is2LeggedEndpoint(true);
+
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::__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/oauthprovider/is2leggedendpoint.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/isrequesttokenendpoint.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/isrequesttokenendpoint.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/isrequesttokenendpoint.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,75 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::isRequestTokenEndpoint</refname>
+ <refpurpose>Sets isRequestTokenEndpoint</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::isRequestTokenEndpoint</methodname> + \
<methodparam><type>bool</type><parameter>will_issue_request_token</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>will_issue_request_token</parameter></term>
+ <listitem>
+ <para>
+ Sets whether or not it will issue a request token, thus determining if
+ <methodname>OAuthProvider::tokenHandler</methodname> needs to be called.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::setRequestTokenPath</methodname></member>
+ <member><methodname>OAuthProvider::reportProblem</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/oauthprovider/isrequesttokenendpoint.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/removerequiredparameter.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/removerequiredparameter.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/removerequiredparameter.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,67 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::removeRequiredParameter</refname>
+ <refpurpose>Remove a required parameter</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>OAuthProvider::removeRequiredParameter</methodname> + \
<methodparam><type>string</type><parameter>req_params</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Removes a required parameter.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>req_params</parameter></term>
+ <listitem>
+ <para>
+ The required parameter to be removed.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::setParam</methodname></member>
+ <member><methodname>OAuthProvider::addRequiredParameter</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/oauthprovider/removerequiredparameter.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/reportproblem.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/reportproblem.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/reportproblem.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,68 @@
+<?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"> + <refnamediv>
+ <refname>OAuthProvider::reportProblem</refname>
+ <refpurpose>Report a problem</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<modifier>static</modifier> \
<type>void</type><methodname>OAuthProvider::reportProblem</methodname> + \
<methodparam><type>string</type><parameter>oauthexception</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Pass in a problem as an <classname>OAuthException</classname>, with possible \
problems listed + in the <link linkend="oauth.constants">OAuth constants</link> \
section. + </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>oauthexception</parameter></term>
+ <listitem>
+ <para>
+ The <classname>OAuthException</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::checkOAuthRequest</methodname></member>
+ <member><methodname>OAuthProvider::isRequestTokenEndpoint</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/oauthprovider/reportproblem.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/setparam.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/setparam.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/setparam.xml 2010-05-27 16:02:15 \
UTC (rev 299859) @@ -0,0 +1,82 @@
+<?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"> + <refnamediv>
+ <refname>OAuthProvider::setParam</refname>
+ <refpurpose>Set a parameter</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>OAuthProvider::setParam</methodname> + \
<methodparam><type>string</type><parameter>param_key</parameter></methodparam> + \
<methodparam choice="opt"><type>mixed</type><parameter>param_val</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Sets a parameter.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>param_key</parameter></term>
+ <listitem>
+ <para>
+ The parameter key.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>param_val</parameter></term>
+ <listitem>
+ <para>
+ The optional parameter value.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::addRequiredParameter</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/oauthprovider/setparam.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/setrequesttokenpath.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/setrequesttokenpath.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/setrequesttokenpath.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,66 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::setRequestTokenPath</refname>
+ <refpurpose>Set request token path</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>OAuthProvider::setRequestTokenPath</methodname> + \
<methodparam><type>string</type><parameter>path</parameter></methodparam> + \
</methodsynopsis> + <para>
+ Sets the request tokens path.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>path</parameter></term>
+ <listitem>
+ <para>
+ The path.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::tokenHandler</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/oauthprovider/setrequesttokenpath.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/timestampnoncehandler.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/timestampnoncehandler.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/timestampnoncehandler.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,98 @@
+<?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"> + \
<refnamediv> + <refname>OAuthProvider::timestampNonceHandler</refname>
+ <refpurpose>Set the timestampNonceHandler handler callback</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::timestampNonceHandler</methodname> + \
<methodparam><type>callback</type><parameter>callback_function</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ 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>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>callback_function</parameter></term>
+ <listitem>
+ <para>
+ The <type>callback</type> functions name.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title>Example <methodname>OAuthProvider::timestampNonceHandler</methodname> \
callback</title> + <programlisting role="php">
+<![CDATA[
+<?php
+function timestampNonceChecker($provider) {
+
+ if ($provider->nonce === 'bad') {
+ return OAUTH_BAD_NONCE;
+ } elseif ($provider->timestamp == '0') {
+ return OAUTH_BAD_TIMESTAMP;
+ }
+
+ return OAUTH_OK;
+}
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::callTimestampNonceHandler</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/oauthprovider/timestampnoncehandler.xml \
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/oauth/oauthprovider/tokenhandler.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/oauthprovider/tokenhandler.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/oauth/oauthprovider/tokenhandler.xml 2010-05-27 \
16:02:15 UTC (rev 299859) @@ -0,0 +1,98 @@
+<?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"> + <refnamediv>
+ <refname>OAuthProvider::tokenHandler</refname>
+ <refpurpose>Set the tokenHandler handler callback</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>void</type><methodname>OAuthProvider::tokenHandler</methodname> + \
<methodparam><type>callback</type><parameter>callback_function</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Sets the token handler callback, which will later be called with
+ <methodname>OAuthProvider::callTokenHandler</methodname>.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>callback_function</parameter></term>
+ <listitem>
+ <para>
+ The <type>callback</type> functions name.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title>Example <methodname>OAuthProvider::tokenHandler</methodname> \
callback</title> + <programlisting role="php">
+<![CDATA[
+<?php
+function tokenHandler($provider) {
+
+ if ($provider->token === 'rejected') {
+ return OAUTH_TOKEN_REJECTED;
+ } elseif ($provider->token === 'revoked') {
+ return OAUTH_TOKEN_REVOKED;
+ }
+
+ $provider->token_secret = "the_tokens_secret";
+ return OAUTH_OK;
+}
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>OAuthProvider::callTokenHandler</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/oauthprovider/tokenhandler.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/oauth/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/oauth/versions.xml 2010-05-27 15:01:58 UTC (rev 299858)
+++ phpdoc/en/trunk/reference/oauth/versions.xml 2010-05-27 16:02:15 UTC (rev 299859)
@@ -32,6 +32,22 @@
<function name='oauthexception::getprevious' from='PECL OAuth >= 0.99.1'/>
<function name='oauthexception::gettraceasstring' from='PECL OAuth >= 0.99.1'/>
<function name='oauthexception::__tostring' from='PECL OAuth >= 0.99.1'/>
+
+ <function name='OAuthProvider::addRequiredParameter' from='PECL OAuth >= \
1.0.0'/> + <function name='OAuthProvider::callConcumserHandler' from='PECL OAuth \
>= 1.0.0'/> + <function name='OAuthProvider::callTimestampNonceHandler' from='PECL \
OAuth >= 1.0.0'/> + <function name='OAuthProvider::callTokenHandler' from='PECL \
OAuth >= 1.0.0'/> + <function name='OAuthProvider::checkOauthRequest' from='PECL \
OAuth >= 1.0.0'/> + <function name='OAuthProvider::__construct' from='PECL OAuth \
>= 1.0.0'/> + <function name='OAuthProvider::consumerHandler' from='PECL OAuth \
>= 1.0.0'/> + <function name='OAuthProvider::is2LeggedEndpoint' from='PECL OAuth \
>= 1.0.0'/> + <function name='OAuthProvider::isRequestTokenEndpoint' from='PECL \
OAuth >= 1.0.0'/> + <function name='OAuthProvider::removeRequiredParameter' \
from='PECL OAuth >= 1.0.0'/> + <function name='OAuthProvider::reportProblem' \
from='PECL OAuth >= 1.0.0'/> + <function name='OAuthProvider::setParam' from='PECL \
OAuth >= 1.0.0'/> + <function name='OAuthProvider::setRequestTokenPath' from='PECL \
OAuth >= 1.0.0'/> + <function name='OAuthProvider::timestampNonceHandler' \
from='PECL OAuth >= 1.0.0'/> + <function name='OAuthProvider::tokenHandler' \
from='PECL OAuth >= 1.0.0'/> </versions>
<!-- Keep this comment at the end of the file
--
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