<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.oauth.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'oauth.getaccesstoken.php',
    1 => 'OAuth::getAccessToken',
    2 => 'アクセストークンを取得する',
  ),
  'up' => 
  array (
    0 => 'class.oauth.php',
    1 => 'OAuth',
  ),
  'prev' => 
  array (
    0 => 'oauth.generatesignature.php',
    1 => 'OAuth::generateSignature',
  ),
  'next' => 
  array (
    0 => 'oauth.getcapath.php',
    1 => 'OAuth::getCAPath',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/oauth/oauth/getaccesstoken.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="oauth.getaccesstoken" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">OAuth::getAccessToken</h1>
  <p class="verinfo">(PECL OAuth &gt;= 0.99.1)</p><p class="refpurpose"><span class="refname">OAuth::getAccessToken</span> &mdash; <span class="dc-title">アクセストークンを取得する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-oauth.getaccesstoken-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>OAuth::getAccessToken</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$access_token_url</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$verifier_token</code><span class="initializer"> = ?</span></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$http_method</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="simpara">
   アクセストークン、secret そして追加のレスポンスパラメータをサービスプロバイダから取得します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-oauth.getaccesstoken-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">access_token_url</code></dt>
    <dd>
     <span class="simpara">
      アクセストークン API の URL。
     </span>
    </dd>
   
   
    <dt><code class="parameter">auth_session_handle</code></dt>
    <dd>
     <span class="simpara">
      認証セッションハンドル。このパラメータはコア OAuth 1.0
      仕様を引用していませんが、大手プロバイダでは実装されているでしょう。
      詳細な情報は
      <a href="http://oauth.pbwiki.com/ScalableOAuth/" class="link external">&raquo;&nbsp;ScalableOAuth</a>
      を参照ください。
     </span>
    </dd>
   
   
    <dt><code class="parameter">verifier_token</code></dt>
    <dd>
     <span class="simpara">
      1.0a をサポートするサービスプロバイダでは、リクエストトークンとアクセストークンを交換する際に
      <code class="parameter">verifier_token</code> を渡す必要があります。
      <code class="parameter">verifier_token</code> が <code class="parameter">$_GET</code>
      あるいは <code class="parameter">$_POST</code> に存在する場合は自動的にそれが渡され、
      呼び出し側が <code class="parameter">verifier_token</code> を指定する必要はありません
      (通常、アクセストークンを oauth_callback URL で交換する場合はこのようになります)。
      詳細な情報は
      <a href="http://oauth.pbwiki.com/ScalableOAuth/" class="link external">&raquo;&nbsp;ScalableOAuth</a>
      を参照ください。
     </span>
    </dd>
   
   
    <dt><code class="parameter">http_method</code></dt>
    <dd>
     <span class="simpara">
      利用する HTTP メソッド。<code class="literal">GET</code> や <code class="literal">POST</code> など。
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-oauth.getaccesstoken-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   成功した場合は OAuth レスポンスをパースした配列、失敗した場合は <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-oauth.getaccesstoken-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>PECL oauth 1.0.0</td>
      <td>
       以前は、失敗したときに <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> ではなく <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> を返していました。
      </td>
     </tr>

     <tr>
      <td>PECL oauth 0.99.9</td>
      <td>
       <code class="parameter">verifier_token</code> パラメータが追加されました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-oauth.getaccesstoken-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 <span class="function"><strong>OAuth::getAccessToken()</strong></span> の例</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">try {<br />    </span><span style="color: #0000BB">$oauth </span><span style="color: #007700">= new </span><span style="color: #0000BB">OAuth</span><span style="color: #007700">(</span><span style="color: #0000BB">OAUTH_CONSUMER_KEY</span><span style="color: #007700">,</span><span style="color: #0000BB">OAUTH_CONSUMER_SECRET</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$oauth</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setToken</span><span style="color: #007700">(</span><span style="color: #0000BB">$request_token</span><span style="color: #007700">,</span><span style="color: #0000BB">$request_token_secret</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$access_token_info </span><span style="color: #007700">= </span><span style="color: #0000BB">$oauth</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getAccessToken</span><span style="color: #007700">(</span><span style="color: #DD0000">"https://example.com/oauth/access_token"</span><span style="color: #007700">);<br />    if(!empty(</span><span style="color: #0000BB">$access_token_info</span><span style="color: #007700">)) {<br />        </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$access_token_info</span><span style="color: #007700">);<br />    } else {<br />        print </span><span style="color: #DD0000">"Failed fetching access token, response was: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$oauth</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getLastResponse</span><span style="color: #007700">();<br />    }<br />} catch(</span><span style="color: #0000BB">OAuthException $E</span><span style="color: #007700">) {<br />    echo </span><span style="color: #DD0000">"Response: "</span><span style="color: #007700">. </span><span style="color: #0000BB">$E</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">lastResponse </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>上の例の出力は、
たとえば以下のようになります。</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [oauth_token] =&gt; some_token
    [oauth_token_secret] =&gt; some_token_secret
)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-oauth.getaccesstoken-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="oauth.getlastresponse.php" class="methodname" rel="rdfs-seeAlso">OAuth::getLastResponse()</a> - 直近のレスポンスを取得する</span></li>
   <li><span class="methodname"><a href="oauth.getlastresponseinfo.php" class="methodname" rel="rdfs-seeAlso">OAuth::getLastResponseInfo()</a> - 直近のレスポンスの HTTP 情報を取得する</span></li>
   <li><span class="methodname"><a href="oauth.settoken.php" class="methodname" rel="rdfs-seeAlso">OAuth::setToken()</a> - トークンと secret を設定する</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>