rhymix/modules/member/php-openid-1.2.3/doc/OpenID/Auth_OpenID_Server.html
2008-12-19 11:00:19 +00:00

202 lines
No EOL
7 KiB
HTML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Auth_OpenID_Server</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Auth_OpenID_Server</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An object that implements the OpenID protocol for a single URL.</p>
<p class="description"><p>Use this object by calling getOpenIDResponse when you get any request for the server URL.</p></p>
<p class="notes">
Located in <a class="field" href="_Auth---OpenID---Server.php.html">/Auth/OpenID/Server.php</a> (line <span class="field">1235</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Auth_OpenID_Server</span>
<a href="#Auth_OpenID_Server" title="details" class="method-name">Auth_OpenID_Server</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$store</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#decodeRequest" title="details" class="method-name">decodeRequest</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$query</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#encodeResponse" title="details" class="method-name">encodeResponse</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
</div>
<div class="method-definition">
<span class="method-result">Auth_OpenID_Response</span>
<a href="#handleRequest" title="details" class="method-name">handleRequest</a>
(<span class="var-type">Auth_OpenID_Request</span>&nbsp;<span class="var-name">$request</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodAuth_OpenID_Server" id="Auth_OpenID_Server"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor Auth_OpenID_Server</span> (line <span class="line-number">1236</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">Auth_OpenID_Server</span>
<span class="method-name">
Auth_OpenID_Server
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$store</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$store</span> </li>
</ul>
</div>
<a name="methoddecodeRequest" id="decodeRequest"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">decodeRequest</span> (line <span class="line-number">1298</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Decodes a query args array into the appropriate Auth_OpenID_Request object.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
decodeRequest
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$query</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$query</span> </li>
</ul>
</div>
<a name="methodencodeResponse" id="encodeResponse"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">encodeResponse</span> (line <span class="line-number">1289</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Encodes as response in the appropriate format suitable for sending to the user agent.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
encodeResponse
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$response</span> </li>
</ul>
</div>
<a name="methodhandleRequest" id="handleRequest"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">handleRequest</span> (line <span class="line-number">1255</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Handle a request. Given an Auth_OpenID_Request object, call the appropriate Auth_OpenID_Server method to process the request and generate a response.</p>
<ul class="tags">
<li><span class="field">return:</span> A response object capable of generating a user-agent reply.</li>
</ul>
<div class="method-signature">
<span class="method-result">Auth_OpenID_Response</span>
<span class="method-name">
handleRequest
</span>
(<span class="var-type">Auth_OpenID_Request</span>&nbsp;<span class="var-name">$request</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">Auth_OpenID_Request</span>
<span class="var-name">$request</span><span class="var-description">: An Auth_OpenID_Request returned by Auth_OpenID_Server::decodeRequest.</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 10 Sep 2007 13:29:30 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>