getrequesttoken.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="oauth.getrequesttoken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>OAuth::getRequestToken</refname>
  <refpurpose>Fetch a request token</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>OAuth::getRequestToken</methodname>
   <methodparam><type>string</type><parameter>request_token_url</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>callback_url</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>http_method</parameter></methodparam>
  </methodsynopsis>
  <para>
   Fetch a request token, secret and any additional response parameters from the service provider.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>request_token_url</parameter></term>
     <listitem>
      <para>
       URL to the request token API.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback_url</parameter></term>
     <listitem>
      <para>
       OAuth callback URL. If <parameter>callback_url</parameter> is passed and is an empty value, it is set to "oob" to address the OAuth 2009.1 advisory.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>http_method</parameter></term>
     <listitem>
      <para>
       HTTP method to use, e.g. <literal>GET</literal> or <literal>POST</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array containing the parsed OAuth response on success or &false; on failure.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>1.0.0</entry>
       <entry>
        &oauth.changelog.error.null;
       </entry>
      </row>
      <row>
       <entry>0.99.9</entry>
       <entry>
        The <parameter>callback_url</parameter> parameter was added
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>OAuth::getRequestToken</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
try {
    $oauth = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET);
    $request_token_info = $oauth->getRequestToken("https://example.com/oauth/request_token");
    if(!empty($request_token_info)) {
        print_r($request_token_info);
    } else {
        print "Failed fetching request token, response was: " . $oauth->getLastResponse();
    }
} catch(OAuthException $E) {
    echo "Response: ". $E->lastResponse . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [oauth_token] => some_token
    [oauth_token_secret] => some_token_secret
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>OAuth::getLastResponse</methodname></member>
    <member><methodname>OAuth::getLastResponseInfo</methodname></member>
   </simplelist>
  </para>
 </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
-->