New file |
0,0 → 1,842 |
<?xml version="1.0" encoding="UTF-8"?> |
<!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 OpenIdClient</title> |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
<script src="../media/lib/classTree.js"></script> |
<script language="javascript" type="text/javascript"> |
var imgPlus = new Image(); |
var imgMinus = new Image(); |
imgPlus.src = "../media/images/plus.png"; |
imgMinus.src = "../media/images/minus.png"; |
|
function showNode(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
var oImg = document.layers["img" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
var oImg = document.all["img" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
var oImg = document.getElementById("img" + Node); |
break; |
} |
oImg.src = imgMinus.src; |
oTable.style.display = "block"; |
} |
|
function hideNode(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
var oImg = document.layers["img" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
var oImg = document.all["img" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
var oImg = document.getElementById("img" + Node); |
break; |
} |
oImg.src = imgPlus.src; |
oTable.style.display = "none"; |
} |
|
function nodeIsVisible(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
break; |
} |
return (oTable && oTable.style.display == "block"); |
} |
|
function toggleNodeVisibility(Node){ |
if (nodeIsVisible(Node)){ |
hideNode(Node); |
}else{ |
showNode(Node); |
} |
} |
</script> |
</head> |
<body> |
<div class="page-body"> |
<h2 class="class-name">Class OpenIdClient</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
|
</div> |
<div class="info-box-body"> |
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">La classe OpenIdClient est une implémentation d'un client OpenId, depuis une classe Zend.</p> |
<p class="description"><p>Elle permet d'établir une connexion avec un serveur, en fonction d'un identifiant OpenId. Elle permet de communiquer de manière sécurisée avec ce serveur, et doit aboutir a une identification centralisée.</p></p> |
<p class="notes"> |
Located in <a class="field" href="_OpenIdClient.php.html">/OpenIdClient.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a9">9</a></span>) |
</p> |
|
|
<pre></pre> |
|
</div> |
</div> |
|
|
<a name="sec-const-summary"></a> |
<div class="info-box"> |
<div class="info-box-title">Class Constant Summary</span></div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>) |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
| |
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
<div class="const-summary"> |
<div class="const-title"> |
<img src="../media/images/Constant.png" alt=" " /> |
<a href="#NS_2_0" title="details" class="const-name">NS_2_0</a> = <span class="var-type"> 'http://specs.openid.net/auth/2.0'</span> |
|
</div> |
</div> |
</div> |
</div> |
|
<a name="sec-var-summary"></a> |
<div class="info-box"> |
<div class="info-box-title">Variable Summary</span></div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
|
</div> |
<div class="info-box-body"> |
<div class="var-summary"> |
<div class="var-title"> |
<span class="var-type">array</span> |
<a href="#$_cache" title="details" class="var-name">$_cache</a> |
</div> |
<div class="var-title"> |
<span class="var-type"><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></span> |
<a href="#$_storage" title="details" class="var-name">$_storage</a> |
</div> |
</div> |
</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> | |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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"> |
static <span class="method-result">bool</span> |
<a href="#normalize" title="details" class="method-name">normalize</a> |
(<span class="var-type">string</span> <span class="var-name">&$id</span>) |
</div> |
|
<div class="method-definition"> |
static <span class="method-result">bool</span> |
<a href="#normalizeUrl" title="details" class="method-name">normalizeUrl</a> |
(<span class="var-type">string</span> <span class="var-name">&$id</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">string</span> |
<a href="#absoluteUrl" title="details" class="method-name">absoluteUrl</a> |
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">string</span> |
<a href="#digest" title="details" class="method-name">digest</a> |
(<span class="var-type">string</span> <span class="var-name">$func</span>, <span class="var-type">string</span> <span class="var-name">$data</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#login" title="details" class="method-name">login</a> |
(<span class="var-type"></span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">OpenIdClient</span> |
<a href="#__construct" title="details" class="method-name">__construct</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#redirect" title="details" class="method-name">redirect</a> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">array</span> <span class="var-name">$params</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">string</span> |
<a href="#selfUrl" title="details" class="method-name">selfUrl</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#verifierVersion" title="details" class="method-name">verifierVersion</a> |
(<span class="var-type"></span> <span class="var-name">$reponseHtml</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">bool</span> |
<a href="#verify" title="details" class="method-name">verify</a> |
(<span class="var-type">array</span> <span class="var-name">$params</span>, [<span class="var-type">string</span> <span class="var-name">&$identity</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span> <span class="var-name">$extensions</span> = <span class="var-default">null</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#_addAssociation" title="details" class="method-name">_addAssociation</a> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$handle</span>, <span class="var-type">string</span> <span class="var-name">$macFunc</span>, <span class="var-type">string</span> <span class="var-name">$secret</span>, <span class="var-type">integer</span> <span class="var-name">$expires</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">bool</span> |
<a href="#_associate" title="details" class="method-name">_associate</a> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">float</span> <span class="var-name">$version</span>, [<span class="var-type">string</span> <span class="var-name">$priv_key</span> = <span class="var-default">null</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">bool</span> |
<a href="#_discovery" title="details" class="method-name">_discovery</a> |
(<span class="var-type">string</span> <span class="var-name">&$id</span>, <span class="var-type">string</span> <span class="var-name">&$server</span>, <span class="var-type">float</span> <span class="var-name">&$version</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#_getAssociation" title="details" class="method-name">_getAssociation</a> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">&$handle</span>, <span class="var-type">string</span> <span class="var-name">&$macFunc</span>, <span class="var-type">string</span> <span class="var-name">&$secret</span>, <span class="var-type">integer</span> <span class="var-name">&$expires</span>) |
</div> |
</div> |
</div> |
</div> |
|
<a name="sec-vars"></a> |
<div class="info-box"> |
<div class="info-box-title">Variables</div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
|
|
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
|
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
|
<a name="var$_cache" id="$_cache"><!-- --></A> |
<div class="oddrow"> |
|
<div class="var-header"> |
<span class="var-title"> |
<span class="var-type">array</span> |
<span class="var-name">$_cache</span> |
= <span class="var-default">array()</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a26">26</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Tableau "cache" interne permettant d'éviter des accès inutiles au fichier storage</p> |
<ul class="tags"> |
<li><span class="field">access:</span> protected</li> |
</ul> |
|
|
|
|
|
</div> |
<a name="var$_storage" id="$_storage"><!-- --></A> |
<div class="evenrow"> |
|
<div class="var-header"> |
<span class="var-title"> |
<span class="var-type"><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></span> |
<span class="var-name">$_storage</span> |
= <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a20">20</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Variable permettant le stockage d'informations, notammenent à propos des clés DiffieHellmann</p> |
<ul class="tags"> |
<li><span class="field">access:</span> protected</li> |
</ul> |
|
|
|
|
|
</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</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="methodnormalize" id="normalize"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">static normalize</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a971">971</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Normaliser l'identifiant OpenId qui peut être une URL ou nom XRI Retourne true ou false en cas d'erreur.</p> |
<p class="description"><p>Règles de normalisation : <ol><li>If the user's input starts with one of the "xri://", "xri://$ip*", |
or "xri://$dns*" prefixes, they MUST be stripped off, so that XRIs |
are used in the canonical form, and URI-authority XRIs are further |
considered URL identifiers.</li><li>If the first character of the resulting string is an XRI Global |
Context Symbol ("=", "@", "+", "$", "!"), then the input SHOULD be |
treated as an XRI.</li><li>Otherwise, the input SHOULD be treated as an http URL; if it does |
not include a "http" or "https" scheme, the Identifier MUST be |
prefixed with the string "http://".</li><li>URL identifiers MUST then be further normalized by both following |
redirects when retrieving their content and finally applying the |
rules in Section 6 of [RFC3986] to the final destination URL.</li></ol></p></p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
static <span class="method-result">bool</span> |
<span class="method-name"> |
normalize |
</span> |
(<span class="var-type">string</span> <span class="var-name">&$id</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$id</span><span class="var-description">: identifier to be normalized</span> </li> |
</ul> |
|
|
</div> |
<a name="methodnormalizeUrl" id="normalizeUrl"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">static normalizeUrl</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a810">810</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Normalizes URL according to RFC 3986 to use it in comparison operations.</p> |
<p class="description"><p>The function gets URL argument by reference and modifies it. It returns true on success and false of failure.</p></p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
static <span class="method-result">bool</span> |
<span class="method-name"> |
normalizeUrl |
</span> |
(<span class="var-type">string</span> <span class="var-name">&$id</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$id</span><span class="var-description">: url to be normalized</span> </li> |
</ul> |
|
|
</div> |
<a name="methodabsoluteUrl" id="absoluteUrl"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">absoluteUrl</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1123">1123</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Retourne l'url absolue d'une url donnée</p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">string</span> |
<span class="method-name"> |
absoluteUrl |
</span> |
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$url</span><span class="var-description">: absilute or relative URL</span> </li> |
</ul> |
|
|
</div> |
<a name="methoddigest" id="digest"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">digest</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1018">1018</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Generates a hash value (message digest) according to given algorithm.</p> |
<p class="description"><p>It returns RAW binary string.</p><p>This is a wrapper function that uses one of available internal function dependent on given PHP configuration. It may use various functions from ext/openssl, ext/hash, ext/mhash or ext/standard.</p></p> |
<ul class="tags"> |
<li><span class="field">return:</span> RAW digital signature</li> |
<li><span class="field">throws:</span> Zend_OpenId_Exception</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">string</span> |
<span class="method-name"> |
digest |
</span> |
(<span class="var-type">string</span> <span class="var-name">$func</span>, <span class="var-type">string</span> <span class="var-name">$data</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$func</span><span class="var-description">: digest algorithm</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$data</span><span class="var-description">: data to sign</span> </li> |
</ul> |
|
|
</div> |
<a name="methodlogin" id="login"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">login</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a48">48</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Fonction login</p> |
<p class="description"><p>Return true ou false > Ne retourne rien si true car redirige vers l'adresse du serveur OID</p></p> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
login |
</span> |
(<span class="var-type"></span> <span class="var-name">$id</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"></span> |
<span class="var-name">$id</span> </li> |
<li> |
<span class="var-type"></span> |
<span class="var-name">$immediate</span> </li> |
</ul> |
|
|
</div> |
<a name="method__construct" id="__construct"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a34">34</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Constructeur de l'application</p> |
|
<div class="method-signature"> |
<span class="method-result">OpenIdClient</span> |
<span class="method-name"> |
__construct |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodredirect" id="redirect"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">redirect</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1178">1178</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Rediriger vers la page du serveur avec les paramètres de confiration</p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
redirect |
</span> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">array</span> <span class="var-name">$params</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$url</span><span class="var-description">: URL de retour</span> </li> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$params</span><span class="var-description">: paramètres additionnels</span> </li> |
</ul> |
|
|
</div> |
<a name="methodselfUrl" id="selfUrl"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">selfUrl</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1050">1050</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Returns a full URL that was requested on current HTTP request.</p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">string</span> |
<span class="method-name"> |
selfUrl |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodverifierVersion" id="verifierVersion"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">verifierVersion</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a477">477</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
verifierVersion |
</span> |
(<span class="var-type"></span> <span class="var-name">$reponseHtml</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type"></span> |
<span class="var-name">$reponseHtml</span> </li> |
</ul> |
|
|
</div> |
<a name="methodverify" id="verify"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">verify</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a193">193</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Verifies authentication response from OpenID server.</p> |
<p class="description"><p>This is the second step of OpenID authentication process. The function returns true on successful authentication and false on failure.</p></p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">bool</span> |
<span class="method-name"> |
verify |
</span> |
(<span class="var-type">array</span> <span class="var-name">$params</span>, [<span class="var-type">string</span> <span class="var-name">&$identity</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span> <span class="var-name">$extensions</span> = <span class="var-default">null</span>]) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$params</span><span class="var-description">: HTTP query data from OpenID server</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$identity</span><span class="var-description">: this argument is set to end-user's claimed identifier or OpenID provider local identifier.</span> </li> |
<li> |
<span class="var-type">mixed</span> |
<span class="var-name">$extensions</span><span class="var-description">: extension object or array of extensions objects</span> </li> |
</ul> |
|
|
</div> |
<a name="method_addAssociation" id="_addAssociation"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">_addAssociation</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a759">759</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Store assiciation in internal chace and external storage</p> |
<ul class="tags"> |
<li><span class="field">access:</span> protected</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
_addAssociation |
</span> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$handle</span>, <span class="var-type">string</span> <span class="var-name">$macFunc</span>, <span class="var-type">string</span> <span class="var-name">$secret</span>, <span class="var-type">integer</span> <span class="var-name">$expires</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$url</span><span class="var-description">: OpenID server url</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$handle</span><span class="var-description">: association handle</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$macFunc</span><span class="var-description">: HMAC function (sha1 or sha256)</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$secret</span><span class="var-description">: shared secret</span> </li> |
<li> |
<span class="var-type">integer</span> |
<span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
</ul> |
|
|
</div> |
<a name="method_associate" id="_associate"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">_associate</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a556">556</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Create (or reuse existing) association between OpenID consumer and OpenID server based on Diffie-Hellman key agreement. Returns true on success and false on failure.</p> |
<ul class="tags"> |
<li><span class="field">access:</span> protected</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">bool</span> |
<span class="method-name"> |
_associate |
</span> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">float</span> <span class="var-name">$version</span>, [<span class="var-type">string</span> <span class="var-name">$priv_key</span> = <span class="var-default">null</span>]) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$url</span><span class="var-description">: OpenID server url</span> </li> |
<li> |
<span class="var-type">float</span> |
<span class="var-name">$version</span><span class="var-description">: OpenID protocol version</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$priv_key</span><span class="var-description">: for testing only</span> </li> |
</ul> |
|
|
</div> |
<a name="method_discovery" id="_discovery"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">_discovery</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a434">434</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Performs discovery of identity and finds OpenID URL, OpenID server URL and OpenID protocol version. Returns true on succees and false on failure.</p> |
<ul class="tags"> |
<li><span class="field">todo:</span> OpenID 2.0 (7.3) XRI and Yadis discovery</li> |
<li><span class="field">access:</span> protected</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">bool</span> |
<span class="method-name"> |
_discovery |
</span> |
(<span class="var-type">string</span> <span class="var-name">&$id</span>, <span class="var-type">string</span> <span class="var-name">&$server</span>, <span class="var-type">float</span> <span class="var-name">&$version</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$id</span><span class="var-description">: OpenID identity URL</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$server</span><span class="var-description">: OpenID server URL</span> </li> |
<li> |
<span class="var-type">float</span> |
<span class="var-name">&$version</span><span class="var-description">: OpenID protocol version</span> </li> |
</ul> |
|
|
</div> |
<a name="method_getAssociation" id="_getAssociation"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">_getAssociation</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a781">781</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Retrive assiciation information for given $url from internal cahce or external storage</p> |
<ul class="tags"> |
<li><span class="field">access:</span> protected</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
_getAssociation |
</span> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">&$handle</span>, <span class="var-type">string</span> <span class="var-name">&$macFunc</span>, <span class="var-type">string</span> <span class="var-name">&$secret</span>, <span class="var-type">integer</span> <span class="var-name">&$expires</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$url</span><span class="var-description">: OpenID server url</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$handle</span><span class="var-description">: association handle</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$macFunc</span><span class="var-description">: HMAC function (sha1 or sha256)</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">&$secret</span><span class="var-description">: shared secret</span> </li> |
<li> |
<span class="var-type">integer</span> |
<span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
</ul> |
|
|
</div> |
|
</div> |
</div> |
|
<a name="sec-consts"></a> |
<div class="info-box"> |
<div class="info-box-title">Class Constants</div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>) |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
<a name="constNS_2_0" id="NS_2_0"><!-- --></A> |
<div class="oddrow"> |
|
<div class="const-header"> |
<img src="../media/images/Variable.png" /> |
<span class="const-title"> |
<span class="const-name">NS_2_0</span> |
= <span class="const-default"> 'http://specs.openid.net/auth/2.0'</span> |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a12">12</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
</div> |
|
</div> |
</div> |
|
<p class="notes" id="credit"> |
Documentation generated on Tue, 18 Jan 2011 15:01:39 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
</p> |
</div></body> |
</html> |