Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<html><head><title>Docs For Class Storage</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">Zend_OpenId</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_Zend_OpenId.html" class="menu">class tree: Zend_OpenId</a> ][ <a href="../../elementindex_Zend_OpenId.html" class="menu">index: Zend_OpenId</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 />subpackage <b>Zend_OpenId_Consumer</b><br> <div class="package"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/_utilitaires---Storage.php.html"> Storage.php</a><br><a href="../../Zend_OpenId/Zend_OpenId_Consumer/_utilitaires---StorageFile.php.html"> StorageFile.php</a><br></div><br /><b>Classes:</b><br /><div class="package">Zend_OpenId_Consumer<br /> <a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a><br /> <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html">StorageFile</a><br /></div></td><td><table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"><h1>Class: Storage</h1>Source Location: /utilitaires/Storage.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">Abstract class to implement external storage for OpenID consumer</div><br /><br /><h4>Author(s):</h4><ul></ul><h4>Copyright:</h4><ul><li>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</li></ul></td><td valign="top"><h3><a href="#class_methods">Methods</a></h3><ul><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddAssociation">addAssociation</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddDiscoveryInfo">addDiscoveryInfo</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelAssociation">delAssociation</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelDiscoveryInfo">delDiscoveryInfo</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociation">getAssociation</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociationByHandle">getAssociationByHandle</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetDiscoveryInfo">getDiscoveryInfo</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodisUniqueNonce">isUniqueNonce</a></li><li><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodpurgeNonces">purgeNonces</a></li></ul></td></tr></table><hr /><table width="100%" border="0"><tr><td valign="top"><h3>Child classes:</h3><div class="tags"><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html">StorageFile</a></dt><dd>External storage implemmentation using serialized files</dd></dl></div></td></tr></table><hr /><a name="class_details"></a><h3>Class Details</h3><div class="tags">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a33">33</a>]<br />Abstract class to implement external storage for OpenID consumer<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>copyright:</b> </td><td>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</td></tr><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>license:</b> </td><td><a href="http://framework.zend.com/license/new-bsd">New BSD License</a></td></tr></table></div></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><hr /><a name="class_methods"></a><h3>Class Methods</h3><div class="tags"><hr /><a name="methodaddAssociation"></a><h3>method addAssociation <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a46">46</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, long$expires)</code></td></tr></table></td></tr></table><br />Stores information about association identified by $url/$handle<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodaddAssociation">StorageFile::addAssociation()</a></dt><dd>Stores information about association identified by $url/$handle</dd></dl></p><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>assiciation 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">long </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="methodaddDiscoveryInfo"></a><h3>method addDiscoveryInfo <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a94">94</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 addDiscoveryInfo(string$id, string$realId, string$server, float$version, long$expires)</code></td></tr></table></td></tr></table><br />Stores information discovered from identity $id<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodaddDiscoveryInfo">StorageFile::addDiscoveryInfo()</a></dt><dd>Stores information discovered from identity $id</dd></dl></p><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>identity</td></tr><tr><td class="type">string </td><td><b>$realId</b> </td><td>discovered real identity URL</td></tr><tr><td class="type">string </td><td><b>$server</b> </td><td>discovered OpenID server URL</td></tr><tr><td class="type">float </td><td><b>$version</b> </td><td>discovered OpenID protocol version</td></tr><tr><td class="type">long </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="methoddelAssociation"></a><h3>method delAssociation <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a82">82</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 delAssociation(string$url)</code></td></tr></table></td></tr></table><br />Deletes association identified by $url<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methoddelAssociation">StorageFile::delAssociation()</a></dt><dd>Deletes association identified by $url</dd></dl></p><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></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methoddelDiscoveryInfo"></a><h3>method delDiscoveryInfo <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a115">115</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 delDiscoveryInfo(string$id)</code></td></tr></table></td></tr></table><br />Removes cached information discovered from identity $id<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methoddelDiscoveryInfo">StorageFile::delDiscoveryInfo()</a></dt><dd>Removes cached information discovered from identity $id</dd></dl></p><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>identity</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetAssociation"></a><h3>method getAssociation <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a60">60</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 getAssociation(string$url, string&$handle, string&$macFunc, string&$secret, long&$expires)</code></td></tr></table></td></tr></table><br />Gets information about association identified by $url Returns true if given association found and not expired and false otherwise<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodgetAssociation">StorageFile::getAssociation()</a></dt><dd>Gets information about association identified by $url Returns true if given association found and not expired and false otherwise</dd></dl></p><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>assiciation 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">long </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="methodgetAssociationByHandle"></a><h3>method getAssociationByHandle <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a74">74</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 getAssociationByHandle(string$handle, string&$url, string&$macFunc, string&$secret, long&$expires)</code></td></tr></table></td></tr></table><br />Gets information about association identified by $handle Returns true if given association found and not expired and false othverwise<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodgetAssociationByHandle">StorageFile::getAssociationByHandle()</a></dt><dd>Gets information about association identified by $handle Returns true if given association found and not expired and false otherwise</dd></dl></p><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$handle</b> </td><td>assiciation handle</td></tr><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>&$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">long </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="methodgetDiscoveryInfo"></a><h3>method getDiscoveryInfo <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a107">107</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 getDiscoveryInfo(string$id, string&$realId, string&$server, float&$version, long&$expires)</code></td></tr></table></td></tr></table><br />Gets information discovered from identity $id Returns true if such information exists and false otherwise<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodgetDiscoveryInfo">StorageFile::getDiscoveryInfo()</a></dt><dd>Gets information discovered from identity $id Returns true if such information exists and false otherwise</dd></dl></p><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>identity</td></tr><tr><td class="type">string </td><td><b>&$realId</b> </td><td>discovered real identity URL</td></tr><tr><td class="type">string </td><td><b>&$server</b> </td><td>discovered OpenID server URL</td></tr><tr><td class="type">float </td><td><b>&$version</b> </td><td>discovered OpenID protocol version</td></tr><tr><td class="type">long </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="methodisUniqueNonce"></a><h3>method isUniqueNonce <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a124">124</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 isUniqueNonce(string$provider, string$nonce)</code></td></tr></table></td></tr></table><br />The function checks the uniqueness of openid.response_nonce<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodisUniqueNonce">StorageFile::isUniqueNonce()</a></dt><dd>The function checks the uniqueness of openid.response_nonce</dd></dl></p><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$provider</b> </td><td>openid.openid_op_endpoint field from authentication response</td></tr><tr><td class="type">string </td><td><b>$nonce</b> </td><td>openid.response_nonce field from authentication response</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodpurgeNonces"></a><h3>method purgeNonces <span class="smalllinenumber">[line <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a131">131</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 purgeNonces([string$date = null])</code></td></tr></table></td></tr></table><br />Removes data from the uniqueness database that is older then given date<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><p>Overridden in child classes as:<br /><dl><dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodpurgeNonces">StorageFile::purgeNonces()</a></dt><dd>Removes data from the uniqueness database that is older then given date</dd></dl></p><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$date</b> </td><td>Date of expired data</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div></div><br /><div class="credit"><hr />Documentation generated on Tue, 18 Jan 2011 15:31:29 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a></div></td></tr></table></td></tr></table></body></html>