| /trunk/doc/HTMLframesConverter/Zend_OpenId/Zend_OpenId_Consumer/_utilitaires---Storage.php.html |
|---|
| New file |
| 0,0 → 1,145 |
| <?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 page Storage.php</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="file-name">/utilitaires/Storage.php</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-classes">Classes</a> |
| </div> |
| <div class="info-box-body"> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Zend Framework</p> |
| <p class="description"><p>LICENSE</p><p>This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.</p></p> |
| <ul class="tags"> |
| <li><span class="field">version:</span> $Id: Storage.php 20096 2010-01-06 02:05:09Z bkarwin $</li> |
| <li><span class="field">copyright:</span> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</li> |
| <li><span class="field">filesource:</span> <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html">Source Code for this file</a></li> |
| <li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li> |
| </ul> |
| </div> |
| </div> |
| <a name="sec-classes"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Classes</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Classes</span> |
| </div> |
| <div class="info-box-body"> |
| <table cellpadding="2" cellspacing="0" class="class-table"> |
| <tr> |
| <th class="class-table-header">Class</th> |
| <th class="class-table-header">Description</th> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em; vertical-align: top"> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a> |
| </td> |
| <td> |
| Abstract class to implement external storage for OpenID consumer |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| <p class="notes" id="credit"> |
| Documentation generated on Tue, 18 Jan 2011 15:01:43 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
| </p> |
| </div></body> |
| </html> |
| /trunk/doc/HTMLframesConverter/Zend_OpenId/Zend_OpenId_Consumer/_utilitaires---StorageFile.php.html |
|---|
| New file |
| 0,0 → 1,145 |
| <?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 page StorageFile.php</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="file-name">/utilitaires/StorageFile.php</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-classes">Classes</a> |
| </div> |
| <div class="info-box-body"> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Zend Framework</p> |
| <p class="description"><p>LICENSE</p><p>This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.</p></p> |
| <ul class="tags"> |
| <li><span class="field">version:</span> $Id: File.php 23161 2010-10-19 16:08:36Z matthew $</li> |
| <li><span class="field">copyright:</span> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</li> |
| <li><span class="field">filesource:</span> <a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html">Source Code for this file</a></li> |
| <li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li> |
| </ul> |
| </div> |
| </div> |
| <a name="sec-classes"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Classes</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Classes</span> |
| </div> |
| <div class="info-box-body"> |
| <table cellpadding="2" cellspacing="0" class="class-table"> |
| <tr> |
| <th class="class-table-header">Class</th> |
| <th class="class-table-header">Description</th> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em; vertical-align: top"> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html">StorageFile</a> |
| </td> |
| <td> |
| External storage implemmentation using serialized files |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| <p class="notes" id="credit"> |
| Documentation generated on Tue, 18 Jan 2011 15:01:43 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
| </p> |
| </div></body> |
| </html> |
| /trunk/doc/HTMLframesConverter/Zend_OpenId/Zend_OpenId_Consumer/Storage.html |
|---|
| New file |
| 0,0 → 1,639 |
| <?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 Storage</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 Storage</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-descendents">Descendents</a> |
| | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| </div> |
| <div class="info-box-body"> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Abstract class to implement external storage for OpenID consumer</p> |
| <ul class="tags"> |
| <li><span class="field">copyright:</span> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</li> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li> |
| </ul> |
| <p class="notes"> |
| Located in <a class="field" href="_utilitaires---Storage.php.html">/utilitaires/Storage.php</a> (line <span class="field"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a33">33</a></span>) |
| </p> |
| <pre></pre> |
| </div> |
| </div> |
| <a name="sec-descendents"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Direct descendents</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Descendents</span> |
| | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| </div> |
| <div class="info-box-body"> |
| <table cellpadding="2" cellspacing="0" class="class-table"> |
| <tr> |
| <th class="class-table-header">Class</th> |
| <th class="class-table-header">Description</th> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html">StorageFile</a></td> |
| <td> |
| External storage implemmentation using serialized files |
| </td> |
| </tr> |
| </table> |
| </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-descendents">Descendents</a> | |
| <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| </div> |
| <div class="info-box-body"> |
| <div class="method-summary"> |
| <div class="method-definition"> |
| <span class="method-result">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">long</span> <span class="var-name">$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#addDiscoveryInfo" title="details" class="method-name">addDiscoveryInfo</a> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">$realId</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>, <span class="var-type">long</span> <span class="var-name">$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#delAssociation" title="details" class="method-name">delAssociation</a> |
| (<span class="var-type">string</span> <span class="var-name">$url</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#delDiscoveryInfo" title="details" class="method-name">delDiscoveryInfo</a> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</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">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#getAssociationByHandle" title="details" class="method-name">getAssociationByHandle</a> |
| (<span class="var-type">string</span> <span class="var-name">$handle</span>, <span class="var-type">string</span> <span class="var-name">&$url</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">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#getDiscoveryInfo" title="details" class="method-name">getDiscoveryInfo</a> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">&$realId</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>, <span class="var-type">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#isUniqueNonce" title="details" class="method-name">isUniqueNonce</a> |
| (<span class="var-type">string</span> <span class="var-name">$provider</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#purgeNonces" title="details" class="method-name">purgeNonces</a> |
| ([<span class="var-type">string</span> <span class="var-name">$date</span> = <span class="var-default">null</span>]) |
| </div> |
| </div> |
| </div> |
| </div> |
| <a name="sec-methods"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Methods</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-descendents">Descendents</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="methodaddAssociation" 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_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a46">46</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Stores information about association identified by $url/$handle</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</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">long</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">: assiciation 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">long</span> |
| <span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodaddAssociation">StorageFile::addAssociation()</a> |
| : Stores information about association identified by $url/$handle |
| </li> |
| </ul> |
| </div> |
| <a name="methodaddDiscoveryInfo" id="addDiscoveryInfo"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">addDiscoveryInfo</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a94">94</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Stores information discovered from identity $id</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| addDiscoveryInfo |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">$realId</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>, <span class="var-type">long</span> <span class="var-name">$expires</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$id</span><span class="var-description">: identity</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$realId</span><span class="var-description">: discovered real identity URL</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$server</span><span class="var-description">: discovered OpenID server URL</span> </li> |
| <li> |
| <span class="var-type">float</span> |
| <span class="var-name">$version</span><span class="var-description">: discovered OpenID protocol version</span> </li> |
| <li> |
| <span class="var-type">long</span> |
| <span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodaddDiscoveryInfo">StorageFile::addDiscoveryInfo()</a> |
| : Stores information discovered from identity $id |
| </li> |
| </ul> |
| </div> |
| <a name="methoddelAssociation" id="delAssociation"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">delAssociation</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a82">82</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Deletes association identified by $url</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| delAssociation |
| </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">: OpenID server URL</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methoddelAssociation">StorageFile::delAssociation()</a> |
| : Deletes association identified by $url |
| </li> |
| </ul> |
| </div> |
| <a name="methoddelDiscoveryInfo" id="delDiscoveryInfo"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">delDiscoveryInfo</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a115">115</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Removes cached information discovered from identity $id</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">bool</span> |
| <span class="method-name"> |
| delDiscoveryInfo |
| </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">: identity</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methoddelDiscoveryInfo">StorageFile::delDiscoveryInfo()</a> |
| : Removes cached information discovered from identity $id |
| </li> |
| </ul> |
| </div> |
| <a name="methodgetAssociation" id="getAssociation"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">getAssociation</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a60">60</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Gets information about association identified by $url Returns true if given association found and not expired and false otherwise</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">bool</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">long</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">: assiciation 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">long</span> |
| <span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodgetAssociation">StorageFile::getAssociation()</a> |
| : Gets information about association identified by $url Returns true if given association found and not expired and false otherwise |
| </li> |
| </ul> |
| </div> |
| <a name="methodgetAssociationByHandle" id="getAssociationByHandle"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">getAssociationByHandle</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a74">74</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Gets information about association identified by $handle Returns true if given association found and not expired and false othverwise</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">bool</span> |
| <span class="method-name"> |
| getAssociationByHandle |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$handle</span>, <span class="var-type">string</span> <span class="var-name">&$url</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">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$handle</span><span class="var-description">: assiciation handle</span> </li> |
| <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">&$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">long</span> |
| <span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodgetAssociationByHandle">StorageFile::getAssociationByHandle()</a> |
| : Gets information about association identified by $handle Returns true if given association found and not expired and false otherwise |
| </li> |
| </ul> |
| </div> |
| <a name="methodgetDiscoveryInfo" id="getDiscoveryInfo"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">getDiscoveryInfo</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a107">107</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Gets information discovered from identity $id Returns true if such information exists and false otherwise</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">bool</span> |
| <span class="method-name"> |
| getDiscoveryInfo |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">&$realId</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>, <span class="var-type">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$id</span><span class="var-description">: identity</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">&$realId</span><span class="var-description">: discovered real identity URL</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">&$server</span><span class="var-description">: discovered OpenID server URL</span> </li> |
| <li> |
| <span class="var-type">float</span> |
| <span class="var-name">&$version</span><span class="var-description">: discovered OpenID protocol version</span> </li> |
| <li> |
| <span class="var-type">long</span> |
| <span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodgetDiscoveryInfo">StorageFile::getDiscoveryInfo()</a> |
| : Gets information discovered from identity $id Returns true if such information exists and false otherwise |
| </li> |
| </ul> |
| </div> |
| <a name="methodisUniqueNonce" id="isUniqueNonce"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">isUniqueNonce</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a124">124</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">The function checks the uniqueness of openid.response_nonce</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">bool</span> |
| <span class="method-name"> |
| isUniqueNonce |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$provider</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$provider</span><span class="var-description">: openid.openid_op_endpoint field from authentication response</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$nonce</span><span class="var-description">: openid.response_nonce field from authentication response</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodisUniqueNonce">StorageFile::isUniqueNonce()</a> |
| : The function checks the uniqueness of openid.response_nonce |
| </li> |
| </ul> |
| </div> |
| <a name="methodpurgeNonces" id="purgeNonces"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">purgeNonces</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorage.php.html#a131">131</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Removes data from the uniqueness database that is older then given date</p> |
| <ul class="tags"> |
| <li><span class="field">abstract:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| purgeNonces |
| </span> |
| ([<span class="var-type">string</span> <span class="var-name">$date</span> = <span class="var-default">null</span>]) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$date</span><span class="var-description">: Date of expired data</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../../Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html#methodpurgeNonces">StorageFile::purgeNonces()</a> |
| : Removes data from the uniqueness database that is older then given date |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <p class="notes" id="credit"> |
| Documentation generated on Tue, 18 Jan 2011 15:01:43 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
| </p> |
| </div></body> |
| </html> |
| /trunk/doc/HTMLframesConverter/Zend_OpenId/Zend_OpenId_Consumer/StorageFile.html |
|---|
| New file |
| 0,0 → 1,637 |
| <?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 StorageFile</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 StorageFile</h2> |
| <a name="sec-description"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Description</div> |
| <div class="nav-bar"> |
| <span class="disabled">Description</span> | |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| </div> |
| <div class="info-box-body"> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">External storage implemmentation using serialized files</p> |
| <ul class="tags"> |
| <li><span class="field">copyright:</span> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</li> |
| <li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li> |
| </ul> |
| <p class="notes"> |
| Located in <a class="field" href="_utilitaires---StorageFile.php.html">/utilitaires/StorageFile.php</a> (line <span class="field"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a33">33</a></span>) |
| </p> |
| <pre><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a> |
| | |
| --StorageFile</pre> |
| </div> |
| </div> |
| <a name="sec-method-summary"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Method Summary</span></div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| </div> |
| <div class="info-box-body"> |
| <div class="method-summary"> |
| <div class="method-definition"> |
| <span class="method-result">StorageFile</span> |
| <a href="#__construct" title="details" class="method-name">__construct</a> |
| ([<span class="var-type">string</span> <span class="var-name">$dir</span> = <span class="var-default">null</span>]) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</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">long</span> <span class="var-name">$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#addDiscoveryInfo" title="details" class="method-name">addDiscoveryInfo</a> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">$realId</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>, <span class="var-type">long</span> <span class="var-name">$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#delAssociation" title="details" class="method-name">delAssociation</a> |
| (<span class="var-type">string</span> <span class="var-name">$url</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#delDiscoveryInfo" title="details" class="method-name">delDiscoveryInfo</a> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</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">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#getAssociationByHandle" title="details" class="method-name">getAssociationByHandle</a> |
| (<span class="var-type">string</span> <span class="var-name">$handle</span>, <span class="var-type">string</span> <span class="var-name">&$url</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">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#getDiscoveryInfo" title="details" class="method-name">getDiscoveryInfo</a> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">&$realId</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>, <span class="var-type">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">bool</span> |
| <a href="#isUniqueNonce" title="details" class="method-name">isUniqueNonce</a> |
| (<span class="var-type">string</span> <span class="var-name">$provider</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>) |
| </div> |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#purgeNonces" title="details" class="method-name">purgeNonces</a> |
| ([<span class="var-type">mixed</span> <span class="var-name">$date</span> = <span class="var-default">null</span>]) |
| </div> |
| </div> |
| </div> |
| </div> |
| <a name="sec-methods"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Methods</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| </div> |
| <div class="info-box-body"> |
| <A NAME='method_detail'></A> |
| <a name="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_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a49">49</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Constructs storage object and creates storage directory</p> |
| <ul class="tags"> |
| <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">StorageFile</span> |
| <span class="method-name"> |
| __construct |
| </span> |
| ([<span class="var-type">string</span> <span class="var-name">$dir</span> = <span class="var-default">null</span>]) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$dir</span><span class="var-description">: directory name to store data files in</span> </li> |
| </ul> |
| </div> |
| <a name="methodaddAssociation" 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_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a124">124</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Stores information about association identified by $url/$handle</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"> |
| 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">long</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">: assiciation 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">long</span> |
| <span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddAssociation">Storage::addAssociation()</a></dt> |
| <dd>Stores information about association identified by $url/$handle</dd> |
| </dl> |
| </div> |
| <a name="methodaddDiscoveryInfo" id="addDiscoveryInfo"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">addDiscoveryInfo</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a330">330</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Stores information discovered from identity $id</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"> |
| addDiscoveryInfo |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">$realId</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>, <span class="var-type">long</span> <span class="var-name">$expires</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$id</span><span class="var-description">: identity</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$realId</span><span class="var-description">: discovered real identity URL</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$server</span><span class="var-description">: discovered OpenID server URL</span> </li> |
| <li> |
| <span class="var-type">float</span> |
| <span class="var-name">$version</span><span class="var-description">: discovered OpenID protocol version</span> </li> |
| <li> |
| <span class="var-type">long</span> |
| <span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddDiscoveryInfo">Storage::addDiscoveryInfo()</a></dt> |
| <dd>Stores information discovered from identity $id</dd> |
| </dl> |
| </div> |
| <a name="methoddelAssociation" id="delAssociation"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">delAssociation</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a282">282</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Deletes association identified by $url</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"> |
| delAssociation |
| </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">: OpenID server URL</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelAssociation">Storage::delAssociation()</a></dt> |
| <dd>Deletes association identified by $url</dd> |
| </dl> |
| </div> |
| <a name="methoddelDiscoveryInfo" id="delDiscoveryInfo"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">delDiscoveryInfo</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a414">414</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Removes cached information discovered from identity $id</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"> |
| delDiscoveryInfo |
| </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">: identity</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelDiscoveryInfo">Storage::delDiscoveryInfo()</a></dt> |
| <dd>Removes cached information discovered from identity $id</dd> |
| </dl> |
| </div> |
| <a name="methodgetAssociation" id="getAssociation"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">getAssociation</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a182">182</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Gets information about association identified by $url Returns true if given association found and not expired and false otherwise</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"> |
| 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">long</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">: assiciation 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">long</span> |
| <span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociation">Storage::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> |
| </div> |
| <a name="methodgetAssociationByHandle" id="getAssociationByHandle"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">getAssociationByHandle</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a235">235</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Gets information about association identified by $handle Returns true if given association found and not expired and false otherwise</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"> |
| getAssociationByHandle |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$handle</span>, <span class="var-type">string</span> <span class="var-name">&$url</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">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$handle</span><span class="var-description">: assiciation handle</span> </li> |
| <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">&$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">long</span> |
| <span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociationByHandle">Storage::getAssociationByHandle()</a></dt> |
| <dd>Gets information about association identified by $handle Returns true if given association found and not expired and false othverwise</dd> |
| </dl> |
| </div> |
| <a name="methodgetDiscoveryInfo" id="getDiscoveryInfo"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">getDiscoveryInfo</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a369">369</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Gets information discovered from identity $id Returns true if such information exists and false otherwise</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"> |
| getDiscoveryInfo |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">string</span> <span class="var-name">&$realId</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>, <span class="var-type">long</span> <span class="var-name">&$expires</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$id</span><span class="var-description">: identity</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">&$realId</span><span class="var-description">: discovered real identity URL</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">&$server</span><span class="var-description">: discovered OpenID server URL</span> </li> |
| <li> |
| <span class="var-type">float</span> |
| <span class="var-name">&$version</span><span class="var-description">: discovered OpenID protocol version</span> </li> |
| <li> |
| <span class="var-type">long</span> |
| <span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetDiscoveryInfo">Storage::getDiscoveryInfo()</a></dt> |
| <dd>Gets information discovered from identity $id Returns true if such information exists and false otherwise</dd> |
| </dl> |
| </div> |
| <a name="methodisUniqueNonce" id="isUniqueNonce"><!-- --></a> |
| <div class="evenrow"> |
| <div class="method-header"> |
| <span class="method-title">isUniqueNonce</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a442">442</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">The function checks the uniqueness of openid.response_nonce</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"> |
| isUniqueNonce |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$provider</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$provider</span><span class="var-description">: openid.openid_op_endpoint field from authentication response</span> </li> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$nonce</span><span class="var-description">: openid.response_nonce field from authentication response</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodisUniqueNonce">Storage::isUniqueNonce()</a></dt> |
| <dd>The function checks the uniqueness of openid.response_nonce</dd> |
| </dl> |
| </div> |
| <a name="methodpurgeNonces" id="purgeNonces"><!-- --></a> |
| <div class="oddrow"> |
| <div class="method-header"> |
| <span class="method-title">purgeNonces</span> (line <span class="line-number"><a href="../../__filesource/fsource_Zend_OpenId_Zend_OpenId_Consumer_utilitairesStorageFile.php.html#a475">475</a></span>) |
| </div> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Removes data from the uniqueness database that is older then given date</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"> |
| purgeNonces |
| </span> |
| ([<span class="var-type">mixed</span> <span class="var-name">$date</span> = <span class="var-default">null</span>]) |
| </div> |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">mixed</span> |
| <span class="var-name">$date</span><span class="var-description">: date of expired data</span> </li> |
| </ul> |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodpurgeNonces">Storage::purgeNonces()</a></dt> |
| <dd>Removes data from the uniqueness database that is older then given date</dd> |
| </dl> |
| </div> |
| <h4>Inherited Methods</h4> |
| <a name='inherited_methods'><!-- --></a> |
| <!-- =========== Summary =========== --> |
| <p>Inherited From <span class="classname"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></span></p> |
| <blockquote> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddAssociation">Storage::addAssociation()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddDiscoveryInfo">Storage::addDiscoveryInfo()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelAssociation">Storage::delAssociation()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelDiscoveryInfo">Storage::delDiscoveryInfo()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociation">Storage::getAssociation()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociationByHandle">Storage::getAssociationByHandle()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetDiscoveryInfo">Storage::getDiscoveryInfo()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodisUniqueNonce">Storage::isUniqueNonce()</a></span><br> |
| <span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodpurgeNonces">Storage::purgeNonces()</a></span><br> |
| </blockquote> |
| </div> |
| </div> |
| <p class="notes" id="credit"> |
| Documentation generated on Tue, 18 Jan 2011 15:01:45 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
| </p> |
| </div></body> |
| </html> |