mirror of
https://github.com/Lastorder-DC/rhymix.git
synced 2026-01-16 17:59:55 +09:00
658c0e6dbc
git-svn-id: http://xe-core.googlecode.com/svn/sandbox@5137 201d5d3c-b55e-5fd7-737f-ddc643e51545
187 lines
No EOL
8.1 KiB
HTML
187 lines
No EOL
8.1 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_AuthRequest</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_AuthRequest</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">This class represents an authentication request from a consumer to an OpenID server.</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_Auth---OpenID---Consumer.php.html">/Auth/OpenID/Consumer.php</a> (line <span class="field">934</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_AuthRequest</span>
|
|
<a href="#Auth_OpenID_AuthRequest" title="details" class="method-name">Auth_OpenID_AuthRequest</a>
|
|
(<span class="var-type"></span> <span class="var-name">$assoc</span>, <span class="var-type"></span> <span class="var-name">$endpoint</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#addExtensionArg" title="details" class="method-name">addExtensionArg</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$namespace</span>, <span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">string</span>
|
|
<a href="#redirectURL" title="details" class="method-name">redirectURL</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$trust_root</span>, <span class="var-type">string$</span> <span class="var-name">$return_to</span>, [<span class="var-type"></span> <span class="var-name">$immediate</span> = <span class="var-default">false</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_AuthRequest" id="Auth_OpenID_AuthRequest"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor Auth_OpenID_AuthRequest</span> (line <span class="line-number">944</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Initialize an authentication request with the specified token, association, and endpoint.</p>
|
|
<p class="description"><p>Users of this library should not create instances of this class. Instances of this class are created by the library when needed.</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">Auth_OpenID_AuthRequest</span>
|
|
<span class="method-name">
|
|
Auth_OpenID_AuthRequest
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$assoc</span>, <span class="var-type"></span> <span class="var-name">$endpoint</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$assoc</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$endpoint</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodaddExtensionArg" id="addExtensionArg"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">addExtensionArg</span> (line <span class="line-number">971</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Add an extension argument to this OpenID authentication request.</p>
|
|
<p class="description"><p>Use caution when adding arguments, because they will be URL-escaped and appended to the redirect URL, which can easily get quite long.</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
addExtensionArg
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$namespace</span>, <span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$namespace</span><span class="var-description">: The namespace for the extension. For example, the simple registration extension uses the namespace 'sreg'.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$key</span><span class="var-description">: The key within the extension namespace. For example, the nickname field in the simple registration extension's key is 'nickname'.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$value</span><span class="var-description">: The value to provide to the server for this argument.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodredirectURL" id="redirectURL"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">redirectURL</span> (line <span class="line-number">990</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Compute the appropriate redirection URL for this request based on a specified trust root and return-to.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The resulting redirect URL that you should send to the user agent.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
redirectURL
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$trust_root</span>, <span class="var-type">string$</span> <span class="var-name">$return_to</span>, [<span class="var-type"></span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$trust_root</span><span class="var-description">: The trust root URI for your application.</span> </li>
|
|
<li>
|
|
<span class="var-type">string$</span>
|
|
<span class="var-name">$return_to</span><span class="var-description">: The return-to URL to be used when the OpenID server redirects the user back to your site.</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$immediate</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Mon, 10 Sep 2007 13:29:27 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
|
</p>
|
|
</div></body>
|
|
</html>
|