<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.oauth.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'class.oauth.php',
    1 => 'OAuth',
    2 => 'OAuth 类',
  ),
  'up' => 
  array (
    0 => 'book.oauth.php',
    1 => 'OAuth',
  ),
  'prev' => 
  array (
    0 => 'function.oauth-urlencode.php',
    1 => 'oauth_urlencode',
  ),
  'next' => 
  array (
    0 => 'oauth.construct.php',
    1 => 'OAuth::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/oauth/oauth.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.oauth.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.oauth" class="reference">
 <h1 class="title">OAuth 类</h1>
 

 <div class="partintro"><p class="verinfo">(PECL OAuth &gt;= 0.99.1)</p>


  <div class="section" id="oauth.intro">
   <h2 class="title">简介</h2>
   <p class="simpara">
   此 OAuth 扩展提供一个简单接口使用 OAuth HTTP 规范与数据提供者互动，以便保护私有资源。
   </p>
  </div>


  <div class="section" id="oauth.synopsis">
   <h2 class="title">类摘要</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">OAuth</strong>
     </span>
     {</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
      <var class="varname"><a href="class.oauth.php#oauth.props.debug">$<var class="varname">debug</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
      <var class="varname"><a href="class.oauth.php#oauth.props.sslchecks">$<var class="varname">sslChecks</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
      <var class="varname"><a href="class.oauth.php#oauth.props.debuginfo">$<var class="varname">debugInfo</var></a></var>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="oauth.construct.php" class="methodname">__construct</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$consumer_key</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$consumer_secret</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$signature_method</code><span class="initializer"> = <strong><code><a href="oauth.constants.php#constant.oauth-sig-method-hmacsha1">OAUTH_SIG_METHOD_HMACSHA1</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$auth_type</code><span class="initializer"> = 0</span></span><br>)</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.destruct.php" class="methodname">__destruct</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.disabledebug.php" class="methodname">disableDebug</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.disableredirects.php" class="methodname">disableRedirects</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.disablesslchecks.php" class="methodname">disableSSLChecks</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.enabledebug.php" class="methodname">enableDebug</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.enableredirects.php" class="methodname">enableRedirects</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.enablesslchecks.php" class="methodname">enableSSLChecks</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.fetch.php" class="methodname">fetch</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$protected_resource_url</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$extra_parameters</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$http_headers</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.generatesignature.php" class="methodname">generateSignature</a></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>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$url</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$extra_parameters</code><span class="initializer"> = ?</span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.getaccesstoken.php" class="methodname">getAccessToken</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<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>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$auth_session_handle</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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><br>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.getcapath.php" class="methodname">getCAPath</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.getlastresponse.php" class="methodname">getLastResponse</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.getlastresponseheaders.php" class="methodname">getLastResponseHeaders</a></span>(): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.getlastresponseinfo.php" class="methodname">getLastResponseInfo</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.getrequestheader.php" class="methodname">getRequestHeader</a></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>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$url</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$extra_parameters</code><span class="initializer"> = ?</span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.getrequesttoken.php" class="methodname">getRequestToken</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$request_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">$callback_url</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>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.setauthtype.php" class="methodname">setAuthType</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$auth_type</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.setcapath.php" class="methodname">setCAPath</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$ca_path</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">$ca_info</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.setnonce.php" class="methodname">setNonce</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$nonce</code></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.setrequestengine.php" class="methodname">setRequestEngine</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$reqengine</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.setrsacertificate.php" class="methodname">setRSACertificate</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$cert</code></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.setsslchecks.php" class="methodname">setSSLChecks</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$sslcheck</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.settimestamp.php" class="methodname">setTimestamp</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$timestamp</code></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.settoken.php" class="methodname">setToken</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$token</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$token_secret</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="oauth.setversion.php" class="methodname">setVersion</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$version</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

   }</div>


  </div>

  <div class="section" id="oauth.props">
   <h2 class="title">属性</h2>
   <dl>
    
     <dt id="oauth.props.debug"><var class="varname">debug</var></dt>
     <dd>
      <span class="simpara"/>
     </dd>
    
    
     <dt id="oauth.props.sslchecks"><var class="varname">sslChecks</var></dt>
     <dd>
      <span class="simpara"/>
     </dd>
    
    
     <dt id="oauth.props.debuginfo"><var class="varname">debugInfo</var></dt>
     <dd>
      <span class="simpara"/>
     </dd>
    
   </dl>
  </div>

 </div>

 





















































































































































































<h2>目录</h2><ul class="chunklist chunklist_reference"><li><a href="oauth.construct.php">OAuth::__construct</a> — 新建一个 OAuth 对象</li><li><a href="oauth.destruct.php">OAuth::__destruct</a> — 析构函数</li><li><a href="oauth.disabledebug.php">OAuth::disableDebug</a> — 关闭详细的调试</li><li><a href="oauth.disableredirects.php">OAuth::disableRedirects</a> — 关闭重定向</li><li><a href="oauth.disablesslchecks.php">OAuth::disableSSLChecks</a> — 关闭 SSL 检查</li><li><a href="oauth.enabledebug.php">OAuth::enableDebug</a> — 启用详细调试</li><li><a href="oauth.enableredirects.php">OAuth::enableRedirects</a> — 启用重定向</li><li><a href="oauth.enablesslchecks.php">OAuth::enableSSLChecks</a> — 启用 SSL 检查</li><li><a href="oauth.fetch.php">OAuth::fetch</a> — 获取一个 OAuth 受保护的资源</li><li><a href="oauth.generatesignature.php">OAuth::generateSignature</a> — 生成一个签名</li><li><a href="oauth.getaccesstoken.php">OAuth::getAccessToken</a> — 获取一个访问令牌</li><li><a href="oauth.getcapath.php">OAuth::getCAPath</a> — 获取 CA 信息</li><li><a href="oauth.getlastresponse.php">OAuth::getLastResponse</a> — 获取最后一次的响应</li><li><a href="oauth.getlastresponseheaders.php">OAuth::getLastResponseHeaders</a> — 获取最后一次响应的头信息</li><li><a href="oauth.getlastresponseinfo.php">OAuth::getLastResponseInfo</a> — 获取关于最后一次响应的 HTTP 信息</li><li><a href="oauth.getrequestheader.php">OAuth::getRequestHeader</a> — 生成 OAuth 头信息字符串签名</li><li><a href="oauth.getrequesttoken.php">OAuth::getRequestToken</a> — 获取一个请求令牌</li><li><a href="oauth.setauthtype.php">OAuth::setAuthType</a> — 设置授权类型</li><li><a href="oauth.setcapath.php">OAuth::setCAPath</a> — 设置 CA 路径和信息</li><li><a href="oauth.setnonce.php">OAuth::setNonce</a> — 为后续请求设置现时标志</li><li><a href="oauth.setrequestengine.php">OAuth::setRequestEngine</a> — 设置目标请求引擎</li><li><a href="oauth.setrsacertificate.php">OAuth::setRSACertificate</a> — 设置 RSA 证书</li><li><a href="oauth.setsslchecks.php">OAuth::setSSLChecks</a> — 调整特定的SSL请求检查</li><li><a href="oauth.settimestamp.php">OAuth::setTimestamp</a> — 设置时间戳</li><li><a href="oauth.settoken.php">OAuth::setToken</a> — 设置令牌和 secret</li><li><a href="oauth.setversion.php">OAuth::setVersion</a> — 设置 OAuth 版本</li></ul>
</div>
<?php manual_footer($setup); ?>