Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<!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>File Source for Storage.php</title><meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/><link rel="stylesheet" href="../media/stylesheet.css" /></head><body><h1>Source for file Storage.php</h1><p>Documentation is available at <a href="../Zend_OpenId/Zend_OpenId_Consumer/_utilitaires---Storage.php.html">Storage.php</a></p><div class="src-code"><div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li><li><div class="src-line"><a name="a2"></a> </div></li><li><div class="src-line"><a name="a3"></a><span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a4"></a><span class="src-doc"> * Zend Framework</span></div></li><li><div class="src-line"><a name="a5"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a6"></a><span class="src-doc"> * LICENSE</span></div></li><li><div class="src-line"><a name="a7"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a8"></a><span class="src-doc"> * This source file is subject to the new BSD license that is bundled</span></div></li><li><div class="src-line"><a name="a9"></a><span class="src-doc"> * with this package in the file LICENSE.txt.</span></div></li><li><div class="src-line"><a name="a10"></a><span class="src-doc"> * It is also available through the world-wide-web at this URL:</span></div></li><li><div class="src-line"><a name="a11"></a><span class="src-doc"> * http://framework.zend.com/license/new-bsd</span></div></li><li><div class="src-line"><a name="a12"></a><span class="src-doc"> * If you did not receive a copy of the license and are unable to</span></div></li><li><div class="src-line"><a name="a13"></a><span class="src-doc"> * obtain it through the world-wide-web, please send an email</span></div></li><li><div class="src-line"><a name="a14"></a><span class="src-doc"> * to license@zend.com so we can send you a copy immediately.</span></div></li><li><div class="src-line"><a name="a15"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a16"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@category</span><span class="src-doc"> Zend</span></div></li><li><div class="src-line"><a name="a17"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Zend_OpenId</span></div></li><li><div class="src-line"><a name="a18"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@subpackage</span><span class="src-doc"> Zend_OpenId_Consumer</span></div></li><li><div class="src-line"><a name="a19"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</span></div></li><li><div class="src-line"><a name="a20"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://framework.zend.com/license/new-bsd New BSD License</span></div></li><li><div class="src-line"><a name="a21"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Id: Storage.php 299 2011-01-18 14:03:46Z jpm $</span></div></li><li><div class="src-line"><a name="a22"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a23"></a> </div></li><li><div class="src-line"><a name="a24"></a><span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a25"></a><span class="src-doc"> * Abstract class to implement external storage for OpenID consumer</span></div></li><li><div class="src-line"><a name="a26"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a27"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@category</span><span class="src-doc"> Zend</span></div></li><li><div class="src-line"><a name="a28"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Zend_OpenId</span></div></li><li><div class="src-line"><a name="a29"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@subpackage</span><span class="src-doc"> Zend_OpenId_Consumer</span></div></li><li><div class="src-line"><a name="a30"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</span></div></li><li><div class="src-line"><a name="a31"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://framework.zend.com/license/new-bsd New BSD License</span></div></li><li><div class="src-line"><a name="a32"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a33"></a><span class="src-key">abstract </span><span class="src-key">class </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></div></li><li><div class="src-line"><a name="a34"></a><span class="src-sym">{</span></div></li><li><div class="src-line"><a name="a35"></a> </div></li><li><div class="src-line"><a name="a36"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a37"></a><span class="src-doc"> * Stores information about association identified by $url/$handle</span></div></li><li><div class="src-line"><a name="a38"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a39"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$url </span><span class="src-doc">OpenID server URL</span></div></li><li><div class="src-line"><a name="a40"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$handle </span><span class="src-doc">assiciation handle</span></div></li><li><div class="src-line"><a name="a41"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$macFunc </span><span class="src-doc">HMAC function (sha1 or sha256)</span></div></li><li><div class="src-line"><a name="a42"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$secret </span><span class="src-doc">shared secret</span></div></li><li><div class="src-line"><a name="a43"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">long </span><span class="src-doc-var">$expires </span><span class="src-doc">expiration UNIX time</span></div></li><li><div class="src-line"><a name="a44"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li><li><div class="src-line"><a name="a45"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a46"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddAssociation">addAssociation</a><span class="src-sym">(</span><span class="src-var">$url</span><span class="src-sym">, </span><span class="src-var">$handle</span><span class="src-sym">, </span><span class="src-var">$macFunc</span><span class="src-sym">, </span><span class="src-var">$secret</span><span class="src-sym">, </span><span class="src-var">$expires</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a47"></a> </div></li><li><div class="src-line"><a name="a48"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a49"></a><span class="src-doc"> * Gets information about association identified by $url</span></div></li><li><div class="src-line"><a name="a50"></a><span class="src-doc"> * Returns true if given association found and not expired and false</span></div></li><li><div class="src-line"><a name="a51"></a><span class="src-doc"> * otherwise</span></div></li><li><div class="src-line"><a name="a52"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a53"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$url </span><span class="src-doc">OpenID server URL</span></div></li><li><div class="src-line"><a name="a54"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$handle </span><span class="src-doc">assiciation handle</span></div></li><li><div class="src-line"><a name="a55"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$macFunc </span><span class="src-doc">HMAC function (sha1 or sha256)</span></div></li><li><div class="src-line"><a name="a56"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$secret </span><span class="src-doc">shared secret</span></div></li><li><div class="src-line"><a name="a57"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">long </span><span class="src-doc-var">&$expires </span><span class="src-doc">expiration UNIX time</span></div></li><li><div class="src-line"><a name="a58"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li><li><div class="src-line"><a name="a59"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a60"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociation">getAssociation</a><span class="src-sym">(</span><span class="src-var">$url</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$handle</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$macFunc</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$secret</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$expires</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a61"></a> </div></li><li><div class="src-line"><a name="a62"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a63"></a><span class="src-doc"> * Gets information about association identified by $handle</span></div></li><li><div class="src-line"><a name="a64"></a><span class="src-doc"> * Returns true if given association found and not expired and false</span></div></li><li><div class="src-line"><a name="a65"></a><span class="src-doc"> * othverwise</span></div></li><li><div class="src-line"><a name="a66"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a67"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$handle </span><span class="src-doc">assiciation handle</span></div></li><li><div class="src-line"><a name="a68"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$url </span><span class="src-doc">OpenID server URL</span></div></li><li><div class="src-line"><a name="a69"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$macFunc </span><span class="src-doc">HMAC function (sha1 or sha256)</span></div></li><li><div class="src-line"><a name="a70"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$secret </span><span class="src-doc">shared secret</span></div></li><li><div class="src-line"><a name="a71"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">long </span><span class="src-doc-var">&$expires </span><span class="src-doc">expiration UNIX time</span></div></li><li><div class="src-line"><a name="a72"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li><li><div class="src-line"><a name="a73"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a74"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociationByHandle">getAssociationByHandle</a><span class="src-sym">(</span><span class="src-var">$handle</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$url</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$macFunc</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$secret</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$expires</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a75"></a> </div></li><li><div class="src-line"><a name="a76"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a77"></a><span class="src-doc"> * Deletes association identified by $url</span></div></li><li><div class="src-line"><a name="a78"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a79"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$url </span><span class="src-doc">OpenID server URL</span></div></li><li><div class="src-line"><a name="a80"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li><li><div class="src-line"><a name="a81"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a82"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelAssociation">delAssociation</a><span class="src-sym">(</span><span class="src-var">$url</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a83"></a> </div></li><li><div class="src-line"><a name="a84"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a85"></a><span class="src-doc"> * Stores information discovered from identity $id</span></div></li><li><div class="src-line"><a name="a86"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a87"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$id </span><span class="src-doc">identity</span></div></li><li><div class="src-line"><a name="a88"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$realId </span><span class="src-doc">discovered real identity URL</span></div></li><li><div class="src-line"><a name="a89"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$server </span><span class="src-doc">discovered OpenID server URL</span></div></li><li><div class="src-line"><a name="a90"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$version </span><span class="src-doc">discovered OpenID protocol version</span></div></li><li><div class="src-line"><a name="a91"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">long </span><span class="src-doc-var">$expires </span><span class="src-doc">expiration UNIX time</span></div></li><li><div class="src-line"><a name="a92"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li><li><div class="src-line"><a name="a93"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a94"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddDiscoveryInfo">addDiscoveryInfo</a><span class="src-sym">(</span><span class="src-var">$id</span><span class="src-sym">, </span><span class="src-var">$realId</span><span class="src-sym">, </span><span class="src-var">$server</span><span class="src-sym">, </span><span class="src-var">$version</span><span class="src-sym">, </span><span class="src-var">$expires</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a95"></a> </div></li><li><div class="src-line"><a name="a96"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a97"></a><span class="src-doc"> * Gets information discovered from identity $id</span></div></li><li><div class="src-line"><a name="a98"></a><span class="src-doc"> * Returns true if such information exists and false otherwise</span></div></li><li><div class="src-line"><a name="a99"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a100"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$id </span><span class="src-doc">identity</span></div></li><li><div class="src-line"><a name="a101"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$realId </span><span class="src-doc">discovered real identity URL</span></div></li><li><div class="src-line"><a name="a102"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$server </span><span class="src-doc">discovered OpenID server URL</span></div></li><li><div class="src-line"><a name="a103"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">&$version </span><span class="src-doc">discovered OpenID protocol version</span></div></li><li><div class="src-line"><a name="a104"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">long </span><span class="src-doc-var">&$expires </span><span class="src-doc">expiration UNIX time</span></div></li><li><div class="src-line"><a name="a105"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li><li><div class="src-line"><a name="a106"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a107"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetDiscoveryInfo">getDiscoveryInfo</a><span class="src-sym">(</span><span class="src-var">$id</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$realId</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$server</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$version</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$expires</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a108"></a> </div></li><li><div class="src-line"><a name="a109"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a110"></a><span class="src-doc"> * Removes cached information discovered from identity $id</span></div></li><li><div class="src-line"><a name="a111"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a112"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$id </span><span class="src-doc">identity</span></div></li><li><div class="src-line"><a name="a113"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li><li><div class="src-line"><a name="a114"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a115"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelDiscoveryInfo">delDiscoveryInfo</a><span class="src-sym">(</span><span class="src-var">$id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a116"></a> </div></li><li><div class="src-line"><a name="a117"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a118"></a><span class="src-doc"> * The function checks the uniqueness of openid.response_nonce</span></div></li><li><div class="src-line"><a name="a119"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a120"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$provider </span><span class="src-doc">openid.openid_op_endpoint field from authentication response</span></div></li><li><div class="src-line"><a name="a121"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$nonce </span><span class="src-doc">openid.response_nonce field from authentication response</span></div></li><li><div class="src-line"><a name="a122"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li><li><div class="src-line"><a name="a123"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a124"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodisUniqueNonce">isUniqueNonce</a><span class="src-sym">(</span><span class="src-var">$provider</span><span class="src-sym">, </span><span class="src-var">$nonce</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a125"></a> </div></li><li><div class="src-line"><a name="a126"></a> <span class="src-doc">/**</span></div></li><li><div class="src-line"><a name="a127"></a><span class="src-doc"> * Removes data from the uniqueness database that is older then given date</span></div></li><li><div class="src-line"><a name="a128"></a><span class="src-doc"> *</span></div></li><li><div class="src-line"><a name="a129"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$date </span><span class="src-doc">Date of expired data</span></div></li><li><div class="src-line"><a name="a130"></a><span class="src-doc"> */</span></div></li><li><div class="src-line"><a name="a131"></a> <span class="src-key">abstract </span><span class="src-key">public </span><span class="src-key">function </span><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodpurgeNonces">purgeNonces</a><span class="src-sym">(</span><span class="src-var">$date</span>=<span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li><li><div class="src-line"><a name="a132"></a><span class="src-sym">}</span></div></li></ol></div></div><p class="notes" id="credit">Documentation generated on Tue, 18 Jan 2011 15:30:59 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a></p></body></html>