<!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 OAuthProvider class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="oauth.setversion.html">OAuth::setVersion</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oauthprovider.addrequiredparameter.html">OAuthProvider::addRequiredParameter</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.oauthprovider" class="reference">
<h1 class="title">The OAuthProvider class</h1>
<div class="partintro"><p class="verinfo">(PECL OAuth >= 1.0.0)</p>
<div class="section" id="oauthprovider.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Manages an OAuth provider class.
</p>
<p class="para">
See also an external in-depth tutorial titled
<a href="http://toys.lerdorf.com/archives/55-Writing-an-OAuth-Provider-Service.html" class="link external">» Writing an OAuth Provider Service</a>,
which takes a hands-on approach to providing this service. There are also
<a href="http://svn.php.net/viewvc/pecl/oauth/trunk/examples" class="link external">» OAuth provider examples</a> within the OAuth
extensions sources.
</p>
</div>
<div class="section" id="oauthprovider.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">OAuthProvider</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauthprovider.addrequiredparameter.html" class="methodname">addRequiredParameter</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$req_params</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.callconsumerhandler.html" class="methodname">callconsumerHandler</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.calltimestampnoncehandler.html" class="methodname">callTimestampNonceHandler</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.calltokenhandler.html" class="methodname">calltokenHandler</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.checkoauthrequest.html" class="methodname">checkOAuthRequest</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$uri</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$method</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="oauthprovider.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">array</span> <code class="parameter">$params_array</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.consumerhandler.html" class="methodname">consumerHandler</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback_function</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><a href="oauthprovider.generatetoken.html" class="methodname">generateToken</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$strong</code><span class="initializer"> = false</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.is2leggedendpoint.html" class="methodname">is2LeggedEndpoint</a></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">$params_array</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.isrequesttokenendpoint.html" class="methodname">isRequestTokenEndpoint</a></span>
( <span class="methodparam"><span class="type">bool</span> <code class="parameter">$will_issue_request_token</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauthprovider.removerequiredparameter.html" class="methodname">removeRequiredParameter</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$req_params</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><a href="oauthprovider.reportproblem.html" class="methodname">reportProblem</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$oauthexception</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$send_headers</code><span class="initializer"> = true</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauthprovider.setparam.html" class="methodname">setParam</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$param_key</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">$param_val</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="oauthprovider.setrequesttokenpath.html" class="methodname">setRequestTokenPath</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.timestampnoncehandler.html" class="methodname">timestampNonceHandler</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback_function</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="oauthprovider.tokenhandler.html" class="methodname">tokenHandler</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback_function</code></span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="oauthprovider.addrequiredparameter.html">OAuthProvider::addRequiredParameter</a> — Add required parameters</li><li><a href="oauthprovider.callconsumerhandler.html">OAuthProvider::callconsumerHandler</a> — Calls the consumerNonceHandler callback</li><li><a href="oauthprovider.calltimestampnoncehandler.html">OAuthProvider::callTimestampNonceHandler</a> — Calls the timestampNonceHandler callback</li><li><a href="oauthprovider.calltokenhandler.html">OAuthProvider::calltokenHandler</a> — Calls the tokenNonceHandler callback</li><li><a href="oauthprovider.checkoauthrequest.html">OAuthProvider::checkOAuthRequest</a> — Check an oauth request</li><li><a href="oauthprovider.construct.html">OAuthProvider::__construct</a> — Constructs a new OAuthProvider object</li><li><a href="oauthprovider.consumerhandler.html">OAuthProvider::consumerHandler</a> — Set the consumerHandler handler callback</li><li><a href="oauthprovider.generatetoken.html">OAuthProvider::generateToken</a> — Generate a random token</li><li><a href="oauthprovider.is2leggedendpoint.html">OAuthProvider::is2LeggedEndpoint</a> — is2LeggedEndpoint</li><li><a href="oauthprovider.isrequesttokenendpoint.html">OAuthProvider::isRequestTokenEndpoint</a> — Sets isRequestTokenEndpoint</li><li><a href="oauthprovider.removerequiredparameter.html">OAuthProvider::removeRequiredParameter</a> — Remove a required parameter</li><li><a href="oauthprovider.reportproblem.html">OAuthProvider::reportProblem</a> — Report a problem</li><li><a href="oauthprovider.setparam.html">OAuthProvider::setParam</a> — Set a parameter</li><li><a href="oauthprovider.setrequesttokenpath.html">OAuthProvider::setRequestTokenPath</a> — Set request token path</li><li><a href="oauthprovider.timestampnoncehandler.html">OAuthProvider::timestampNonceHandler</a> — Set the timestampNonceHandler handler callback</li><li><a href="oauthprovider.tokenhandler.html">OAuthProvider::tokenHandler</a> — Set the tokenHandler handler callback</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="oauth.setversion.html">OAuth::setVersion</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oauthprovider.addrequiredparameter.html">OAuthProvider::addRequiredParameter</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>
