<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The OAuth class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.oauth-urlencode.html">oauth_urlencode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oauth.construct.html">OAuth::__construct</a></div>
<div class="up"><a href="book.oauth.html">OAuth</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.oauth" class="reference">
<h1 class="title">The OAuth class</h1>
<div class="partintro"><p class="verinfo">(PECL OAuth >= 0.99.1)</p>
<div class="section" id="oauth.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The OAuth extension provides a simple interface to interact with
data providers using the OAuth HTTP specification to protect
private resources.
</p>
</div>
<div class="section" id="oauth.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">OAuth</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.oauth.html#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.html#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.html#oauth.props.debuginfo">$<var class="varname">debugInfo</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="oauth.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$consumer_key</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$consumer_secret</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$signature_method</code><span class="initializer"> = <strong><code>OAUTH_SIG_METHOD_HMACSHA1</code></strong></span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$auth_type</code><span class="initializer"> = 0</span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauth.destruct.html" class="methodname">__destruct</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.disabledebug.html" class="methodname">disableDebug</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.disableredirects.html" class="methodname">disableRedirects</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.disablesslchecks.html" class="methodname">disableSSLChecks</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.enabledebug.html" class="methodname">enableDebug</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.enableredirects.html" class="methodname">enableRedirects</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.enablesslchecks.html" class="methodname">enableSSLChecks</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="oauth.fetch.html" class="methodname">fetch</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$protected_resource_url</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$extra_parameters</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$http_method</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$http_headers</code></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="oauth.generatesignature.html" class="methodname">generateSignature</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$http_method</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$url</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$extra_parameters</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="oauth.getaccesstoken.html" class="methodname">getAccessToken</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$access_token_url</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$auth_session_handle</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$verifier_token</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="oauth.getcapath.html" class="methodname">getCAPath</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="oauth.getlastresponse.html" class="methodname">getLastResponse</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="oauth.getlastresponseheaders.html" class="methodname">getLastResponseHeaders</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="oauth.getlastresponseinfo.html" class="methodname">getLastResponseInfo</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="oauth.getrequestheader.html" class="methodname">getRequestHeader</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$http_method</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$url</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$extra_parameters</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="oauth.getrequesttoken.html" class="methodname">getRequestToken</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$request_token_url</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$callback_url</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="oauth.setauthtype.html" class="methodname">setAuthType</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$auth_type</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="oauth.setcapath.html" class="methodname">setCAPath</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$ca_path</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$ca_info</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="oauth.setnonce.html" class="methodname">setNonce</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$nonce</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauth.setrequestengine.html" class="methodname">setRequestEngine</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$reqengine</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="oauth.setrsacertificate.html" class="methodname">setRSACertificate</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$cert</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.setsslchecks.html" class="methodname">setSSLChecks</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$sslcheck</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="oauth.settimestamp.html" class="methodname">setTimestamp</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$timestamp</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.settoken.html" class="methodname">setToken</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$token</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$token_secret</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauth.setversion.html" class="methodname">setVersion</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$version</code></span>
)</div>
}</div>
</div>
<div class="section" id="oauth.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="oauth.props.debug">
<span class="term"><var class="varname"><var class="varname">debug</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="oauth.props.sslchecks">
<span class="term"><var class="varname"><var class="varname">sslChecks</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="oauth.props.debuginfo">
<span class="term"><var class="varname"><var class="varname">debugInfo</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="oauth.construct.html">OAuth::__construct</a> — Create a new OAuth object</li><li><a href="oauth.destruct.html">OAuth::__destruct</a> — The destructor</li><li><a href="oauth.disabledebug.html">OAuth::disableDebug</a> — Turn off verbose debugging</li><li><a href="oauth.disableredirects.html">OAuth::disableRedirects</a> — Turn off redirects</li><li><a href="oauth.disablesslchecks.html">OAuth::disableSSLChecks</a> — Turn off SSL checks</li><li><a href="oauth.enabledebug.html">OAuth::enableDebug</a> — Turn on verbose debugging</li><li><a href="oauth.enableredirects.html">OAuth::enableRedirects</a> — Turn on redirects</li><li><a href="oauth.enablesslchecks.html">OAuth::enableSSLChecks</a> — Turn on SSL checks</li><li><a href="oauth.fetch.html">OAuth::fetch</a> — Fetch an OAuth protected resource</li><li><a href="oauth.generatesignature.html">OAuth::generateSignature</a> — Generate a signature</li><li><a href="oauth.getaccesstoken.html">OAuth::getAccessToken</a> — Fetch an access token</li><li><a href="oauth.getcapath.html">OAuth::getCAPath</a> — Gets CA information</li><li><a href="oauth.getlastresponse.html">OAuth::getLastResponse</a> — Get the last response</li><li><a href="oauth.getlastresponseheaders.html">OAuth::getLastResponseHeaders</a> — Get headers for last response</li><li><a href="oauth.getlastresponseinfo.html">OAuth::getLastResponseInfo</a> — Get HTTP information about the last response</li><li><a href="oauth.getrequestheader.html">OAuth::getRequestHeader</a> — Generate OAuth header string signature</li><li><a href="oauth.getrequesttoken.html">OAuth::getRequestToken</a> — Fetch a request token</li><li><a href="oauth.setauthtype.html">OAuth::setAuthType</a> — Set authorization type</li><li><a href="oauth.setcapath.html">OAuth::setCAPath</a> — Set CA path and info</li><li><a href="oauth.setnonce.html">OAuth::setNonce</a> — Set the nonce for subsequent requests</li><li><a href="oauth.setrequestengine.html">OAuth::setRequestEngine</a> — The setRequestEngine purpose</li><li><a href="oauth.setrsacertificate.html">OAuth::setRSACertificate</a> — Set the RSA certificate</li><li><a href="oauth.setsslchecks.html">OAuth::setSSLChecks</a> — Tweak specific SSL checks for requests.</li><li><a href="oauth.settimestamp.html">OAuth::setTimestamp</a> — Set the timestamp</li><li><a href="oauth.settoken.html">OAuth::setToken</a> — Sets the token and secret</li><li><a href="oauth.setversion.html">OAuth::setVersion</a> — Set the OAuth version</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.oauth-urlencode.html">oauth_urlencode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oauth.construct.html">OAuth::__construct</a></div>
<div class="up"><a href="book.oauth.html">OAuth</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
