New file |
0,0 → 1,851 |
<html> |
<head> |
<title>Docs For Class OpenIdClient</title> |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/> |
<link rel="stylesheet" type="text/css" href="../media/style.css"> |
</head> |
<body> |
|
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> |
<tr> |
<td class="header_top">Framework</td> |
</tr> |
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> |
<tr> |
<td class="header_menu"> |
|
|
[ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ] |
[ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ] |
[ <a href="../elementindex.html" class="menu">all elements</a> ] |
</td> |
</tr> |
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> |
</table> |
|
<table width="100%" border="0" cellpadding="0" cellspacing="0"> |
<tr valign="top"> |
<td width="200" class="menu"> |
<div id="todolist"> |
<p><a href="../todolist.html">Todo List</a></p> |
</div> |
<b>Packages:</b><br /> |
<a href="../li_Framework.html">Framework</a><br /> |
<a href="../li_Utilitaire.html">Utilitaire</a><br /> |
<a href="../li_Zend_OpenId.html">Zend_OpenId</a><br /> |
<br /><br /> |
<b>Files:</b><br /> |
<div class="package"> |
<a href="../Framework/_Bdd.php.html"> Bdd.php |
</a><br> |
<a href="../Framework/_Cache.php.html"> Cache.php |
</a><br> |
<a href="../Framework/_CacheFichier.php.html"> CacheFichier.php |
</a><br> |
<a href="../Framework/_CacheSimple.php.html"> CacheSimple.php |
</a><br> |
<a href="../Framework/_CacheSqlite.php.html"> CacheSqlite.php |
</a><br> |
<a href="../Framework/_Chronometre.php.html"> Chronometre.php |
</a><br> |
<a href="../Framework/_Cli.php.html"> Cli.php |
</a><br> |
<a href="../Framework/_Config.php.html"> Config.php |
</a><br> |
<a href="../Framework/_Controleur.php.html"> Controleur.php |
</a><br> |
<a href="../Framework/_Debug.php.html"> Debug.php |
</a><br> |
<a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html"> DiffieHellmanUtil.php |
</a><br> |
<a href="../Framework/_Framework.php.html"> Framework.php |
</a><br> |
<a href="../Framework/_GestionnaireException.php.html"> GestionnaireException.php |
</a><br> |
<a href="../Framework/_I18n.php.html"> I18n.php |
</a><br> |
<a href="../Framework/_Log.php.html"> Log.php |
</a><br> |
<a href="../Framework/_OpenIdClient.php.html"> OpenIdClient.php |
</a><br> |
<a href="../Framework/_Registre.php.html"> Registre.php |
</a><br> |
<a href="../Framework/_RestClient.php.html"> RestClient.php |
</a><br> |
<a href="../Framework/_RestServeur.php.html"> RestServeur.php |
</a><br> |
<a href="../Framework/_RestService.php.html"> RestService.php |
</a><br> |
<a href="../Framework/_Script.php.html"> Script.php |
</a><br> |
<a href="../Framework/_SquelettePhp.php.html"> SquelettePhp.php |
</a><br> |
<a href="../Framework/_Url.php.html"> Url.php |
</a><br> |
</div><br /> |
|
|
<b>Classes:</b><br /> |
<div class="package"> |
<a href="../Framework/Bdd.html">Bdd</a><br /> |
<a href="../Framework/Cache.html">Cache</a><br /> |
<a href="../Framework/CacheFichier.html">CacheFichier</a><br /> |
<a href="../Framework/CacheSimple.html">CacheSimple</a><br /> |
<a href="../Framework/CacheSqlite.html">CacheSqlite</a><br /> |
<a href="../Framework/Chronometre.html">Chronometre</a><br /> |
<a href="../Framework/Cli.html">Cli</a><br /> |
<a href="../Framework/Config.html">Config</a><br /> |
<a href="../Framework/Controleur.html">Controleur</a><br /> |
<a href="../Framework/Debug.html">Debug</a><br /> |
<a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br /> |
<a href="../Framework/Framework.html">Framework</a><br /> |
<a href="../Framework/GestionnaireException.html">GestionnaireException</a><br /> |
<a href="../Framework/I18n.html">I18n</a><br /> |
<a href="../Framework/Log.html">Log</a><br /> |
<a href="../Framework/OpenIdClient.html">OpenIdClient</a><br /> |
<a href="../Framework/Registre.html">Registre</a><br /> |
<a href="../Framework/RestClient.html">RestClient</a><br /> |
<a href="../Framework/RestServeur.html">RestServeur</a><br /> |
<a href="../Framework/RestService.html">RestService</a><br /> |
<a href="../Framework/Script.html">Script</a><br /> |
<a href="../Framework/SquelettePhp.html">SquelettePhp</a><br /> |
<a href="../Framework/Url.html">Url</a><br /> |
</div> |
</td> |
<td> |
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> |
|
<h1>Class: OpenIdClient</h1> |
Source Location: /OpenIdClient.php<br /><br /> |
|
|
<table width="100%" border="0"> |
<tr><td valign="top"> |
|
<h3><a href="#class_details">Class Overview</a></h3> |
<pre></pre><br /> |
<div class="description">La classe OpenIdClient est une implémentation d'un client OpenId, depuis une classe Zend.</div><br /><br /> |
|
|
|
|
|
|
|
</td> |
|
<td valign="top"> |
<h3><a href="#class_vars">Variables</a></h3> |
<ul> |
<li><a href="../Framework/OpenIdClient.html#var$_cache">$_cache</a></li> |
<li><a href="../Framework/OpenIdClient.html#var$_storage">$_storage</a></li> |
</ul> |
</td> |
|
<td valign="top"> |
<h3><a href="#class_consts">Constants</a></h3> |
<ul> |
<li><a href="../Framework/OpenIdClient.html#constNS_2_0">NS_2_0</a></li> |
</ul> |
</td> |
|
<td valign="top"> |
<h3><a href="#class_methods">Methods</a></h3> |
<ul> |
<li><a href="../Framework/OpenIdClient.html#methodabsoluteUrl">absoluteUrl</a></li> |
<li><a href="../Framework/OpenIdClient.html#methoddigest">digest</a></li> |
<li><a href="../Framework/OpenIdClient.html#methodlogin">login</a></li> |
<li><a href="../Framework/OpenIdClient.html#methodnormalize">normalize</a></li> |
<li><a href="../Framework/OpenIdClient.html#methodnormalizeUrl">normalizeUrl</a></li> |
<li><a href="../Framework/OpenIdClient.html#method__construct">__construct</a></li> |
<li><a href="../Framework/OpenIdClient.html#methodredirect">redirect</a></li> |
<li><a href="../Framework/OpenIdClient.html#methodselfUrl">selfUrl</a></li> |
<li><a href="../Framework/OpenIdClient.html#methodverifierVersion">verifierVersion</a></li> |
<li><a href="../Framework/OpenIdClient.html#methodverify">verify</a></li> |
<li><a href="../Framework/OpenIdClient.html#method_addAssociation">_addAssociation</a></li> |
<li><a href="../Framework/OpenIdClient.html#method_associate">_associate</a></li> |
<li><a href="../Framework/OpenIdClient.html#method_discovery">_discovery</a></li> |
<li><a href="../Framework/OpenIdClient.html#method_getAssociation">_getAssociation</a></li> |
</ul> |
</td> |
|
</tr></table> |
<hr /> |
|
<table width="100%" border="0"><tr> |
|
|
|
|
|
|
</tr></table> |
<hr /> |
|
<a name="class_details"></a> |
<h3>Class Details</h3> |
<div class="tags"> |
[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a9">9</a>]<br /> |
La classe OpenIdClient est une implémentation d'un client OpenId, depuis une classe Zend.<br /><br /><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><br /></div><br /><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div><br /> |
|
<hr /> |
<a name="class_vars"></a> |
<h3>Class Variables</h3> |
<div class="tags"> |
<a name="var$_cache"></a> |
<p></p> |
<h4>$_cache = <span class="value">array()</span></h4> |
<p>[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a26">26</a>]</p> |
Tableau "cache" interne permettant d'éviter des accès inutiles au fichier storage<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>protected</td> |
</tr> |
</table> |
</div> |
|
<br /> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>Type:</b> </td> |
<td>array</td> |
</tr> |
</table> |
</div><br /><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div><br /> |
<a name="var$_storage"></a> |
<p></p> |
<h4>$_storage = <span class="value"> null</span></h4> |
<p>[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a20">20</a>]</p> |
Variable permettant le stockage d'informations, notammenent à propos des clés DiffieHellmann<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>protected</td> |
</tr> |
</table> |
</div> |
|
<br /> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>Type:</b> </td> |
<td><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></td> |
</tr> |
</table> |
</div><br /><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div><br /> |
</div><br /> |
|
<hr /> |
<a name="class_methods"></a> |
<h3>Class Methods</h3> |
<div class="tags"> |
<hr /> |
<a name="methodnormalize"></a> |
<h3>static method normalize <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a971">971</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>static bool normalize( |
string |
&$id)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Normaliser l'identifiant OpenId qui peut être une URL ou nom XRI Retourne true ou false en cas d'erreur.<br /><br /><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><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>public</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>&$id</b> </td> |
<td>identifier to be normalized</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="methodnormalizeUrl"></a> |
<h3>static method normalizeUrl <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a810">810</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>static bool normalizeUrl( |
string |
&$id)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Normalizes URL according to RFC 3986 to use it in comparison operations.<br /><br /><p>The function gets URL argument by reference and modifies it. It returns true on success and false of failure.</p><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>public</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>&$id</b> </td> |
<td>url to be normalized</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
|
<hr /> |
<a name="methodabsoluteUrl"></a> |
<h3>method absoluteUrl <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1123">1123</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>string absoluteUrl( |
string |
$url)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Retourne l'url absolue d'une url donnée<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>public</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>$url</b> </td> |
<td>absilute or relative URL</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="methoddigest"></a> |
<h3>method digest <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1018">1018</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>string digest( |
string |
$func, string |
$data)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Generates a hash value (message digest) according to given algorithm.<br /><br /><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><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>return:</b> </td><td>RAW digital signature</td> |
</tr> |
<tr> |
<td><b>throws:</b> </td><td>Zend_OpenId_Exception</td> |
</tr> |
<tr> |
<td><b>access:</b> </td><td>public</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>$func</b> </td> |
<td>digest algorithm</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>$data</b> </td> |
<td>data to sign</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="methodlogin"></a> |
<h3>method login <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a48">48</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>void login( |
|
$id, [ |
$immediate = false])</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Fonction login<br /><br /><p>Return true ou false > Ne retourne rien si true car redirige vers l'adresse du serveur OID</p><br /><br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type"> </td> |
<td><b>$id</b> </td> |
<td></td> |
</tr> |
<tr> |
<td class="type"> </td> |
<td><b>$immediate</b> </td> |
<td></td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="method__construct"></a> |
<h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a34">34</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>OpenIdClient __construct( |
)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Constructeur de l'application<br /><br /><br /><br /> |
|
|
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="methodredirect"></a> |
<h3>method redirect <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1178">1178</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>void redirect( |
string |
$url, array |
$params)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Rediriger vers la page du serveur avec les paramètres de confiration<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>public</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>$url</b> </td> |
<td>URL de retour</td> |
</tr> |
<tr> |
<td class="type">array </td> |
<td><b>$params</b> </td> |
<td>paramètres additionnels</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="methodselfUrl"></a> |
<h3>method selfUrl <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1050">1050</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>string selfUrl( |
)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Returns a full URL that was requested on current HTTP request.<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>public</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="methodverifierVersion"></a> |
<h3>method verifierVersion <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a477">477</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>void verifierVersion( |
|
$reponseHtml)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type"> </td> |
<td><b>$reponseHtml</b> </td> |
<td></td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="methodverify"></a> |
<h3>method verify <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a193">193</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>bool verify( |
array |
$params, [string |
&$identity = ""], [mixed |
$extensions = null])</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Verifies authentication response from OpenID server.<br /><br /><p>This is the second step of OpenID authentication process. The function returns true on successful authentication and false on failure.</p><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>public</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">array </td> |
<td><b>$params</b> </td> |
<td>HTTP query data from OpenID server</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>&$identity</b> </td> |
<td>this argument is set to end-user's claimed identifier or OpenID provider local identifier.</td> |
</tr> |
<tr> |
<td class="type">mixed </td> |
<td><b>$extensions</b> </td> |
<td>extension object or array of extensions objects</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="method_addAssociation"></a> |
<h3>method _addAssociation <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a759">759</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>void _addAssociation( |
string |
$url, string |
$handle, string |
$macFunc, string |
$secret, integer |
$expires)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Store assiciation in internal chace and external storage<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>protected</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>$url</b> </td> |
<td>OpenID server url</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>$handle</b> </td> |
<td>association handle</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>$macFunc</b> </td> |
<td>HMAC function (sha1 or sha256)</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>$secret</b> </td> |
<td>shared secret</td> |
</tr> |
<tr> |
<td class="type">integer </td> |
<td><b>$expires</b> </td> |
<td>expiration UNIX time</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="method_associate"></a> |
<h3>method _associate <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a556">556</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>bool _associate( |
string |
$url, float |
$version, [string |
$priv_key = null])</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
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.<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>protected</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>$url</b> </td> |
<td>OpenID server url</td> |
</tr> |
<tr> |
<td class="type">float </td> |
<td><b>$version</b> </td> |
<td>OpenID protocol version</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>$priv_key</b> </td> |
<td>for testing only</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="method_discovery"></a> |
<h3>method _discovery <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a434">434</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>bool _discovery( |
string |
&$id, string |
&$server, float |
&$version)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Performs discovery of identity and finds OpenID URL, OpenID server URL and OpenID protocol version. Returns true on succees and false on failure.<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>todo:</b> </td><td>OpenID 2.0 (7.3) XRI and Yadis discovery</td> |
</tr> |
<tr> |
<td><b>access:</b> </td><td>protected</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>&$id</b> </td> |
<td>OpenID identity URL</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>&$server</b> </td> |
<td>OpenID server URL</td> |
</tr> |
<tr> |
<td class="type">float </td> |
<td><b>&$version</b> </td> |
<td>OpenID protocol version</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
<hr /> |
<a name="method_getAssociation"></a> |
<h3>method _getAssociation <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a781">781</a>]</span></h3> |
<div class="function"> |
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> |
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> |
<code>void _getAssociation( |
string |
$url, string |
&$handle, string |
&$macFunc, string |
&$secret, integer |
&$expires)</code> |
</td></tr></table> |
</td></tr></table><br /> |
|
Retrive assiciation information for given $url from internal cahce or external storage<br /><br /><br /><br /> |
<h4>Tags:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td><b>access:</b> </td><td>protected</td> |
</tr> |
</table> |
</div> |
<br /><br /> |
|
|
<h4>Parameters:</h4> |
<div class="tags"> |
<table border="0" cellspacing="0" cellpadding="0"> |
<tr> |
<td class="type">string </td> |
<td><b>$url</b> </td> |
<td>OpenID server url</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>&$handle</b> </td> |
<td>association handle</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>&$macFunc</b> </td> |
<td>HMAC function (sha1 or sha256)</td> |
</tr> |
<tr> |
<td class="type">string </td> |
<td><b>&$secret</b> </td> |
<td>shared secret</td> |
</tr> |
<tr> |
<td class="type">integer </td> |
<td><b>&$expires</b> </td> |
<td>expiration UNIX time</td> |
</tr> |
</table> |
</div><br /> |
<div class="top">[ <a href="#top">Top</a> ]</div> |
</div> |
</div><br /> |
|
<hr /> |
<a name="class_consts"></a> |
<h3>Class Constants</h3> |
<div class="tags"> |
<a name="constNS_2_0"></a> |
<p></p> |
<h4>NS_2_0 = <span class="value"> 'http://specs.openid.net/auth/2.0'</span></h4> |
<p>[line <a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a12">12</a>]</p> |
|
<br /> |
<div class="top">[ <a href="#top">Top</a> ]</div><br /> |
</div><br /> |
|
<div class="credit"> |
<hr /> |
Documentation generated on Tue, 18 Jan 2011 15:31:24 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a> |
</div> |
</td></tr></table> |
</td> |
</tr> |
</table> |
|
</body> |
</html> |