cvs: phpdoc /en/reference/oauth book.xml constants.xml examples.xml

From: Date: Sat, 20 Jun 2009 17:43:35 +0000
Subject: cvs: phpdoc /en/reference/oauth book.xml constants.xml examples.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-4172@lists.php.net to get a copy of this message
rasmus Sat Jun 20 17:43:35 2009 UTC Added files: /phpdoc/en/reference/oauth examples.xml Modified files: /phpdoc/en/reference/oauth book.xml constants.xml Log: Daily phpdoc commit Add missing oauth constants and an example for how to get a user's location from FireEagle. http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oauth/book.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oauth/book.xml diff -u phpdoc/en/reference/oauth/book.xml:1.1 phpdoc/en/reference/oauth/book.xml:1.2 --- phpdoc/en/reference/oauth/book.xml:1.1 Wed Dec 31 00:38:41 2008 +++ phpdoc/en/reference/oauth/book.xml Sat Jun 20 17:43:34 2009 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Purpose: webservice --> <!-- Membership: pecl, external --> @@ -18,6 +18,7 @@ &reference.oauth.setup; &reference.oauth.constants; + &reference.oauth.examples; &reference.oauth.reference; &reference.oauth.oauth; &reference.oauth.oauthexception; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oauth/constants.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/oauth/constants.xml diff -u phpdoc/en/reference/oauth/constants.xml:1.1 phpdoc/en/reference/oauth/constants.xml:1.2 --- phpdoc/en/reference/oauth/constants.xml:1.1 Wed Dec 31 00:38:41 2008 +++ phpdoc/en/reference/oauth/constants.xml Sat Jun 20 17:43:34 2009 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <appendix xml:id="oauth.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> &reftitle.constants; @@ -31,6 +31,17 @@ </varlistentry> <varlistentry> <term> + <constant>OAUTH_AUTH_TYPE_NONE</constant> + (<type>string</type>) + </term> + <listitem> + <para> + This constant indicates a NoAuth OAuth request. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> <constant>OAUTH_AUTH_TYPE_URI</constant> (<type>string</type>) </term> @@ -53,6 +64,50 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term> + <constant>OAUTH_HTTP_METHOD_GET</constant> + (<type>string</type>) + </term> + <listitem> + <para> + Use the GET method for the OAuth request + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>OAUTH_HTTP_METHOD_POST</constant> + (<type>string</type>) + </term> + <listitem> + <para> + Use the POST method for the OAuth request + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>OAUTH_HTTP_METHOD_PUT</constant> + (<type>string</type>) + </term> + <listitem> + <para> + Use the PUT method for the OAuth request + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>OAUTH_HTTP_METHOD_HEAD</constant> + (<type>string</type>) + </term> + <listitem> + <para> + Use the HEAD method for the OAuth request + </para> + </listitem> + </varlistentry> </variablelist> </para> </appendix> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/oauth/examples.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/oauth/examples.xml +++ phpdoc/en/reference/oauth/examples.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <chapter xml:id="oauth.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> &reftitle.examples; <section xml:id='oauth.examples.fireeagle'> <title>FireEagle</title> <para> <example> <title></title> <programlisting role="php" xml:id="oauth.examples.fireeagle.location"> <![CDATA[ $req_url = 'https://fireeagle.yahooapis.com/oauth/request_token'; $authurl = 'https://fireeagle.yahoo.net/oauth/authorize'; $acc_url = 'https://fireeagle.yahooapis.com/oauth/access_token'; $api_url = 'https://fireeagle.yahooapis.com/api/0.1'; $conskey = 'your_consumer_key'; $conssec = 'your_consumer_secret'; session_start(); // In state=1 the next request should include an oauth_token. // If it doesn't go back to 0 if(!isset($_GET['oauth_token']) && $_SESSION['state']==1) $_SESSION['state'] = 0; try { $oauth = new OAuth($conskey,$conssec,OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_URI); $oauth->enableDebug(); if(!isset($_GET['oauth_token']) && !$_SESSION['state']) { $request_token_info = $oauth->getRequestToken($req_url); $_SESSION['secret'] = $request_token_info['oauth_token_secret']; $_SESSION['state'] = 1; header('Location: '.$auth_url.'?oauth_token='.$request_token_info['oauth_token']); exit; } else if($_SESSION['state']==1) { $oauth->setToken($_GET['oauth_token'],$_SESSION['secret']); $access_token_info = $oauth->getAccessToken($acc_url); $_SESSION['state'] = 2; $_SESSION['token'] = $access_token_info['oauth_token']; $_SESSION['secret'] = $access_token_info['oauth_token_secret']; } $oauth->setToken($_SESSION['token'],$_SESSION['secret']); $oauth->fetch("$api_url/user.json"); $json = json_decode($oauth->getLastResponse()); print_r($json); } catch(OAuthException $E) { print_r($E); } ?> ]]> </programlisting> </example> </para> </section> </chapter> <!-- 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:"../../../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 -->

« previous php.doc.cvs (#4172) next »