| 297 |
jpm |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
3 |
<head>
|
|
|
4 |
<!-- template designed by Marco Von Ballmoos -->
|
|
|
5 |
<title>Docs For Class StorageFile</title>
|
|
|
6 |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
|
|
|
7 |
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
|
|
8 |
<script src="../../media/lib/classTree.js"></script>
|
|
|
9 |
<script language="javascript" type="text/javascript">
|
|
|
10 |
var imgPlus = new Image();
|
|
|
11 |
var imgMinus = new Image();
|
|
|
12 |
imgPlus.src = "../../media/images/plus.png";
|
|
|
13 |
imgMinus.src = "../../media/images/minus.png";
|
|
|
14 |
|
|
|
15 |
function showNode(Node){
|
|
|
16 |
switch(navigator.family){
|
|
|
17 |
case 'nn4':
|
|
|
18 |
// Nav 4.x code fork...
|
|
|
19 |
var oTable = document.layers["span" + Node];
|
|
|
20 |
var oImg = document.layers["img" + Node];
|
|
|
21 |
break;
|
|
|
22 |
case 'ie4':
|
|
|
23 |
// IE 4/5 code fork...
|
|
|
24 |
var oTable = document.all["span" + Node];
|
|
|
25 |
var oImg = document.all["img" + Node];
|
|
|
26 |
break;
|
|
|
27 |
case 'gecko':
|
|
|
28 |
// Standards Compliant code fork...
|
|
|
29 |
var oTable = document.getElementById("span" + Node);
|
|
|
30 |
var oImg = document.getElementById("img" + Node);
|
|
|
31 |
break;
|
|
|
32 |
}
|
|
|
33 |
oImg.src = imgMinus.src;
|
|
|
34 |
oTable.style.display = "block";
|
|
|
35 |
}
|
|
|
36 |
|
|
|
37 |
function hideNode(Node){
|
|
|
38 |
switch(navigator.family){
|
|
|
39 |
case 'nn4':
|
|
|
40 |
// Nav 4.x code fork...
|
|
|
41 |
var oTable = document.layers["span" + Node];
|
|
|
42 |
var oImg = document.layers["img" + Node];
|
|
|
43 |
break;
|
|
|
44 |
case 'ie4':
|
|
|
45 |
// IE 4/5 code fork...
|
|
|
46 |
var oTable = document.all["span" + Node];
|
|
|
47 |
var oImg = document.all["img" + Node];
|
|
|
48 |
break;
|
|
|
49 |
case 'gecko':
|
|
|
50 |
// Standards Compliant code fork...
|
|
|
51 |
var oTable = document.getElementById("span" + Node);
|
|
|
52 |
var oImg = document.getElementById("img" + Node);
|
|
|
53 |
break;
|
|
|
54 |
}
|
|
|
55 |
oImg.src = imgPlus.src;
|
|
|
56 |
oTable.style.display = "none";
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
function nodeIsVisible(Node){
|
|
|
60 |
switch(navigator.family){
|
|
|
61 |
case 'nn4':
|
|
|
62 |
// Nav 4.x code fork...
|
|
|
63 |
var oTable = document.layers["span" + Node];
|
|
|
64 |
break;
|
|
|
65 |
case 'ie4':
|
|
|
66 |
// IE 4/5 code fork...
|
|
|
67 |
var oTable = document.all["span" + Node];
|
|
|
68 |
break;
|
|
|
69 |
case 'gecko':
|
|
|
70 |
// Standards Compliant code fork...
|
|
|
71 |
var oTable = document.getElementById("span" + Node);
|
|
|
72 |
break;
|
|
|
73 |
}
|
|
|
74 |
return (oTable && oTable.style.display == "block");
|
|
|
75 |
}
|
|
|
76 |
|
|
|
77 |
function toggleNodeVisibility(Node){
|
|
|
78 |
if (nodeIsVisible(Node)){
|
|
|
79 |
hideNode(Node);
|
|
|
80 |
}else{
|
|
|
81 |
showNode(Node);
|
|
|
82 |
}
|
|
|
83 |
}
|
|
|
84 |
</script>
|
|
|
85 |
</head>
|
|
|
86 |
<body>
|
|
|
87 |
<div class="page-body">
|
|
|
88 |
<h2 class="class-name">Class StorageFile</h2>
|
|
|
89 |
|
|
|
90 |
<a name="sec-description"></a>
|
|
|
91 |
<div class="info-box">
|
|
|
92 |
<div class="info-box-title">Description</div>
|
|
|
93 |
<div class="nav-bar">
|
|
|
94 |
<span class="disabled">Description</span> |
|
|
|
95 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
96 |
|
|
|
97 |
</div>
|
|
|
98 |
<div class="info-box-body">
|
|
|
99 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
100 |
<p class="short-description">External storage implemmentation using serialized files</p>
|
|
|
101 |
<ul class="tags">
|
|
|
102 |
<li><span class="field">copyright:</span> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</li>
|
|
|
103 |
<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li>
|
|
|
104 |
</ul>
|
|
|
105 |
<p class="notes">
|
|
|
106 |
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>)
|
|
|
107 |
</p>
|
|
|
108 |
|
|
|
109 |
|
|
|
110 |
<pre><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a>
|
|
|
111 |
|
|
|
|
112 |
--StorageFile</pre>
|
|
|
113 |
|
|
|
114 |
</div>
|
|
|
115 |
</div>
|
|
|
116 |
|
|
|
117 |
|
|
|
118 |
|
|
|
119 |
|
|
|
120 |
<a name="sec-method-summary"></a>
|
|
|
121 |
<div class="info-box">
|
|
|
122 |
<div class="info-box-title">Method Summary</span></div>
|
|
|
123 |
<div class="nav-bar">
|
|
|
124 |
<a href="#sec-description">Description</a> |
|
|
|
125 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
|
126 |
</div>
|
|
|
127 |
<div class="info-box-body">
|
|
|
128 |
<div class="method-summary">
|
|
|
129 |
|
|
|
130 |
<div class="method-definition">
|
|
|
131 |
<span class="method-result">StorageFile</span>
|
|
|
132 |
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
|
133 |
([<span class="var-type">string</span> <span class="var-name">$dir</span> = <span class="var-default">null</span>])
|
|
|
134 |
</div>
|
|
|
135 |
|
|
|
136 |
<div class="method-definition">
|
|
|
137 |
<span class="method-result">bool</span>
|
|
|
138 |
<a href="#addAssociation" title="details" class="method-name">addAssociation</a>
|
|
|
139 |
(<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>)
|
|
|
140 |
</div>
|
|
|
141 |
|
|
|
142 |
<div class="method-definition">
|
|
|
143 |
<span class="method-result">bool</span>
|
|
|
144 |
<a href="#addDiscoveryInfo" title="details" class="method-name">addDiscoveryInfo</a>
|
|
|
145 |
(<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>)
|
|
|
146 |
</div>
|
|
|
147 |
|
|
|
148 |
<div class="method-definition">
|
|
|
149 |
<span class="method-result">bool</span>
|
|
|
150 |
<a href="#delAssociation" title="details" class="method-name">delAssociation</a>
|
|
|
151 |
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
|
|
152 |
</div>
|
|
|
153 |
|
|
|
154 |
<div class="method-definition">
|
|
|
155 |
<span class="method-result">bool</span>
|
|
|
156 |
<a href="#delDiscoveryInfo" title="details" class="method-name">delDiscoveryInfo</a>
|
|
|
157 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
158 |
</div>
|
|
|
159 |
|
|
|
160 |
<div class="method-definition">
|
|
|
161 |
<span class="method-result">bool</span>
|
|
|
162 |
<a href="#getAssociation" title="details" class="method-name">getAssociation</a>
|
|
|
163 |
(<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>)
|
|
|
164 |
</div>
|
|
|
165 |
|
|
|
166 |
<div class="method-definition">
|
|
|
167 |
<span class="method-result">bool</span>
|
|
|
168 |
<a href="#getAssociationByHandle" title="details" class="method-name">getAssociationByHandle</a>
|
|
|
169 |
(<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>)
|
|
|
170 |
</div>
|
|
|
171 |
|
|
|
172 |
<div class="method-definition">
|
|
|
173 |
<span class="method-result">bool</span>
|
|
|
174 |
<a href="#getDiscoveryInfo" title="details" class="method-name">getDiscoveryInfo</a>
|
|
|
175 |
(<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>)
|
|
|
176 |
</div>
|
|
|
177 |
|
|
|
178 |
<div class="method-definition">
|
|
|
179 |
<span class="method-result">bool</span>
|
|
|
180 |
<a href="#isUniqueNonce" title="details" class="method-name">isUniqueNonce</a>
|
|
|
181 |
(<span class="var-type">string</span> <span class="var-name">$provider</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>)
|
|
|
182 |
</div>
|
|
|
183 |
|
|
|
184 |
<div class="method-definition">
|
|
|
185 |
<span class="method-result">void</span>
|
|
|
186 |
<a href="#purgeNonces" title="details" class="method-name">purgeNonces</a>
|
|
|
187 |
([<span class="var-type">mixed</span> <span class="var-name">$date</span> = <span class="var-default">null</span>])
|
|
|
188 |
</div>
|
|
|
189 |
</div>
|
|
|
190 |
</div>
|
|
|
191 |
</div>
|
|
|
192 |
|
|
|
193 |
|
|
|
194 |
<a name="sec-methods"></a>
|
|
|
195 |
<div class="info-box">
|
|
|
196 |
<div class="info-box-title">Methods</div>
|
|
|
197 |
<div class="nav-bar">
|
|
|
198 |
<a href="#sec-description">Description</a> |
|
|
|
199 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
200 |
|
|
|
201 |
</div>
|
|
|
202 |
<div class="info-box-body">
|
|
|
203 |
<A NAME='method_detail'></A>
|
|
|
204 |
<a name="method__construct" id="__construct"><!-- --></a>
|
|
|
205 |
<div class="evenrow">
|
|
|
206 |
|
|
|
207 |
<div class="method-header">
|
|
|
208 |
<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>)
|
|
|
209 |
</div>
|
|
|
210 |
|
|
|
211 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
212 |
<p class="short-description">Constructs storage object and creates storage directory</p>
|
|
|
213 |
<ul class="tags">
|
|
|
214 |
<li><span class="field">throws:</span> Zend_OpenId_Exception</li>
|
|
|
215 |
<li><span class="field">access:</span> public</li>
|
|
|
216 |
</ul>
|
|
|
217 |
|
|
|
218 |
<div class="method-signature">
|
|
|
219 |
<span class="method-result">StorageFile</span>
|
|
|
220 |
<span class="method-name">
|
|
|
221 |
__construct
|
|
|
222 |
</span>
|
|
|
223 |
([<span class="var-type">string</span> <span class="var-name">$dir</span> = <span class="var-default">null</span>])
|
|
|
224 |
</div>
|
|
|
225 |
|
|
|
226 |
<ul class="parameters">
|
|
|
227 |
<li>
|
|
|
228 |
<span class="var-type">string</span>
|
|
|
229 |
<span class="var-name">$dir</span><span class="var-description">: directory name to store data files in</span> </li>
|
|
|
230 |
</ul>
|
|
|
231 |
|
|
|
232 |
|
|
|
233 |
</div>
|
|
|
234 |
<a name="methodaddAssociation" id="addAssociation"><!-- --></a>
|
|
|
235 |
<div class="oddrow">
|
|
|
236 |
|
|
|
237 |
<div class="method-header">
|
|
|
238 |
<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>)
|
|
|
239 |
</div>
|
|
|
240 |
|
|
|
241 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
242 |
<p class="short-description">Stores information about association identified by $url/$handle</p>
|
|
|
243 |
<ul class="tags">
|
|
|
244 |
<li><span class="field">access:</span> public</li>
|
|
|
245 |
</ul>
|
|
|
246 |
|
|
|
247 |
<div class="method-signature">
|
|
|
248 |
<span class="method-result">bool</span>
|
|
|
249 |
<span class="method-name">
|
|
|
250 |
addAssociation
|
|
|
251 |
</span>
|
|
|
252 |
(<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>)
|
|
|
253 |
</div>
|
|
|
254 |
|
|
|
255 |
<ul class="parameters">
|
|
|
256 |
<li>
|
|
|
257 |
<span class="var-type">string</span>
|
|
|
258 |
<span class="var-name">$url</span><span class="var-description">: OpenID server URL</span> </li>
|
|
|
259 |
<li>
|
|
|
260 |
<span class="var-type">string</span>
|
|
|
261 |
<span class="var-name">$handle</span><span class="var-description">: assiciation handle</span> </li>
|
|
|
262 |
<li>
|
|
|
263 |
<span class="var-type">string</span>
|
|
|
264 |
<span class="var-name">$macFunc</span><span class="var-description">: HMAC function (sha1 or sha256)</span> </li>
|
|
|
265 |
<li>
|
|
|
266 |
<span class="var-type">string</span>
|
|
|
267 |
<span class="var-name">$secret</span><span class="var-description">: shared secret</span> </li>
|
|
|
268 |
<li>
|
|
|
269 |
<span class="var-type">long</span>
|
|
|
270 |
<span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span> </li>
|
|
|
271 |
</ul>
|
|
|
272 |
|
|
|
273 |
<hr class="separator" />
|
|
|
274 |
<div class="notes">Redefinition of:</div>
|
|
|
275 |
<dl>
|
|
|
276 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddAssociation">Storage::addAssociation()</a></dt>
|
|
|
277 |
<dd>Stores information about association identified by $url/$handle</dd>
|
|
|
278 |
</dl>
|
|
|
279 |
|
|
|
280 |
</div>
|
|
|
281 |
<a name="methodaddDiscoveryInfo" id="addDiscoveryInfo"><!-- --></a>
|
|
|
282 |
<div class="evenrow">
|
|
|
283 |
|
|
|
284 |
<div class="method-header">
|
|
|
285 |
<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>)
|
|
|
286 |
</div>
|
|
|
287 |
|
|
|
288 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
289 |
<p class="short-description">Stores information discovered from identity $id</p>
|
|
|
290 |
<ul class="tags">
|
|
|
291 |
<li><span class="field">access:</span> public</li>
|
|
|
292 |
</ul>
|
|
|
293 |
|
|
|
294 |
<div class="method-signature">
|
|
|
295 |
<span class="method-result">bool</span>
|
|
|
296 |
<span class="method-name">
|
|
|
297 |
addDiscoveryInfo
|
|
|
298 |
</span>
|
|
|
299 |
(<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>)
|
|
|
300 |
</div>
|
|
|
301 |
|
|
|
302 |
<ul class="parameters">
|
|
|
303 |
<li>
|
|
|
304 |
<span class="var-type">string</span>
|
|
|
305 |
<span class="var-name">$id</span><span class="var-description">: identity</span> </li>
|
|
|
306 |
<li>
|
|
|
307 |
<span class="var-type">string</span>
|
|
|
308 |
<span class="var-name">$realId</span><span class="var-description">: discovered real identity URL</span> </li>
|
|
|
309 |
<li>
|
|
|
310 |
<span class="var-type">string</span>
|
|
|
311 |
<span class="var-name">$server</span><span class="var-description">: discovered OpenID server URL</span> </li>
|
|
|
312 |
<li>
|
|
|
313 |
<span class="var-type">float</span>
|
|
|
314 |
<span class="var-name">$version</span><span class="var-description">: discovered OpenID protocol version</span> </li>
|
|
|
315 |
<li>
|
|
|
316 |
<span class="var-type">long</span>
|
|
|
317 |
<span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span> </li>
|
|
|
318 |
</ul>
|
|
|
319 |
|
|
|
320 |
<hr class="separator" />
|
|
|
321 |
<div class="notes">Redefinition of:</div>
|
|
|
322 |
<dl>
|
|
|
323 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddDiscoveryInfo">Storage::addDiscoveryInfo()</a></dt>
|
|
|
324 |
<dd>Stores information discovered from identity $id</dd>
|
|
|
325 |
</dl>
|
|
|
326 |
|
|
|
327 |
</div>
|
|
|
328 |
<a name="methoddelAssociation" id="delAssociation"><!-- --></a>
|
|
|
329 |
<div class="oddrow">
|
|
|
330 |
|
|
|
331 |
<div class="method-header">
|
|
|
332 |
<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>)
|
|
|
333 |
</div>
|
|
|
334 |
|
|
|
335 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
336 |
<p class="short-description">Deletes association identified by $url</p>
|
|
|
337 |
<ul class="tags">
|
|
|
338 |
<li><span class="field">access:</span> public</li>
|
|
|
339 |
</ul>
|
|
|
340 |
|
|
|
341 |
<div class="method-signature">
|
|
|
342 |
<span class="method-result">bool</span>
|
|
|
343 |
<span class="method-name">
|
|
|
344 |
delAssociation
|
|
|
345 |
</span>
|
|
|
346 |
(<span class="var-type">string</span> <span class="var-name">$url</span>)
|
|
|
347 |
</div>
|
|
|
348 |
|
|
|
349 |
<ul class="parameters">
|
|
|
350 |
<li>
|
|
|
351 |
<span class="var-type">string</span>
|
|
|
352 |
<span class="var-name">$url</span><span class="var-description">: OpenID server URL</span> </li>
|
|
|
353 |
</ul>
|
|
|
354 |
|
|
|
355 |
<hr class="separator" />
|
|
|
356 |
<div class="notes">Redefinition of:</div>
|
|
|
357 |
<dl>
|
|
|
358 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelAssociation">Storage::delAssociation()</a></dt>
|
|
|
359 |
<dd>Deletes association identified by $url</dd>
|
|
|
360 |
</dl>
|
|
|
361 |
|
|
|
362 |
</div>
|
|
|
363 |
<a name="methoddelDiscoveryInfo" id="delDiscoveryInfo"><!-- --></a>
|
|
|
364 |
<div class="evenrow">
|
|
|
365 |
|
|
|
366 |
<div class="method-header">
|
|
|
367 |
<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>)
|
|
|
368 |
</div>
|
|
|
369 |
|
|
|
370 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
371 |
<p class="short-description">Removes cached information discovered from identity $id</p>
|
|
|
372 |
<ul class="tags">
|
|
|
373 |
<li><span class="field">access:</span> public</li>
|
|
|
374 |
</ul>
|
|
|
375 |
|
|
|
376 |
<div class="method-signature">
|
|
|
377 |
<span class="method-result">bool</span>
|
|
|
378 |
<span class="method-name">
|
|
|
379 |
delDiscoveryInfo
|
|
|
380 |
</span>
|
|
|
381 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
382 |
</div>
|
|
|
383 |
|
|
|
384 |
<ul class="parameters">
|
|
|
385 |
<li>
|
|
|
386 |
<span class="var-type">string</span>
|
|
|
387 |
<span class="var-name">$id</span><span class="var-description">: identity</span> </li>
|
|
|
388 |
</ul>
|
|
|
389 |
|
|
|
390 |
<hr class="separator" />
|
|
|
391 |
<div class="notes">Redefinition of:</div>
|
|
|
392 |
<dl>
|
|
|
393 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelDiscoveryInfo">Storage::delDiscoveryInfo()</a></dt>
|
|
|
394 |
<dd>Removes cached information discovered from identity $id</dd>
|
|
|
395 |
</dl>
|
|
|
396 |
|
|
|
397 |
</div>
|
|
|
398 |
<a name="methodgetAssociation" id="getAssociation"><!-- --></a>
|
|
|
399 |
<div class="oddrow">
|
|
|
400 |
|
|
|
401 |
<div class="method-header">
|
|
|
402 |
<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>)
|
|
|
403 |
</div>
|
|
|
404 |
|
|
|
405 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
406 |
<p class="short-description">Gets information about association identified by $url Returns true if given association found and not expired and false otherwise</p>
|
|
|
407 |
<ul class="tags">
|
|
|
408 |
<li><span class="field">access:</span> public</li>
|
|
|
409 |
</ul>
|
|
|
410 |
|
|
|
411 |
<div class="method-signature">
|
|
|
412 |
<span class="method-result">bool</span>
|
|
|
413 |
<span class="method-name">
|
|
|
414 |
getAssociation
|
|
|
415 |
</span>
|
|
|
416 |
(<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>)
|
|
|
417 |
</div>
|
|
|
418 |
|
|
|
419 |
<ul class="parameters">
|
|
|
420 |
<li>
|
|
|
421 |
<span class="var-type">string</span>
|
|
|
422 |
<span class="var-name">$url</span><span class="var-description">: OpenID server URL</span> </li>
|
|
|
423 |
<li>
|
|
|
424 |
<span class="var-type">string</span>
|
|
|
425 |
<span class="var-name">&$handle</span><span class="var-description">: assiciation handle</span> </li>
|
|
|
426 |
<li>
|
|
|
427 |
<span class="var-type">string</span>
|
|
|
428 |
<span class="var-name">&$macFunc</span><span class="var-description">: HMAC function (sha1 or sha256)</span> </li>
|
|
|
429 |
<li>
|
|
|
430 |
<span class="var-type">string</span>
|
|
|
431 |
<span class="var-name">&$secret</span><span class="var-description">: shared secret</span> </li>
|
|
|
432 |
<li>
|
|
|
433 |
<span class="var-type">long</span>
|
|
|
434 |
<span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li>
|
|
|
435 |
</ul>
|
|
|
436 |
|
|
|
437 |
<hr class="separator" />
|
|
|
438 |
<div class="notes">Redefinition of:</div>
|
|
|
439 |
<dl>
|
|
|
440 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociation">Storage::getAssociation()</a></dt>
|
|
|
441 |
<dd>Gets information about association identified by $url Returns true if given association found and not expired and false otherwise</dd>
|
|
|
442 |
</dl>
|
|
|
443 |
|
|
|
444 |
</div>
|
|
|
445 |
<a name="methodgetAssociationByHandle" id="getAssociationByHandle"><!-- --></a>
|
|
|
446 |
<div class="evenrow">
|
|
|
447 |
|
|
|
448 |
<div class="method-header">
|
|
|
449 |
<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>)
|
|
|
450 |
</div>
|
|
|
451 |
|
|
|
452 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
453 |
<p class="short-description">Gets information about association identified by $handle Returns true if given association found and not expired and false otherwise</p>
|
|
|
454 |
<ul class="tags">
|
|
|
455 |
<li><span class="field">access:</span> public</li>
|
|
|
456 |
</ul>
|
|
|
457 |
|
|
|
458 |
<div class="method-signature">
|
|
|
459 |
<span class="method-result">bool</span>
|
|
|
460 |
<span class="method-name">
|
|
|
461 |
getAssociationByHandle
|
|
|
462 |
</span>
|
|
|
463 |
(<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>)
|
|
|
464 |
</div>
|
|
|
465 |
|
|
|
466 |
<ul class="parameters">
|
|
|
467 |
<li>
|
|
|
468 |
<span class="var-type">string</span>
|
|
|
469 |
<span class="var-name">$handle</span><span class="var-description">: assiciation handle</span> </li>
|
|
|
470 |
<li>
|
|
|
471 |
<span class="var-type">string</span>
|
|
|
472 |
<span class="var-name">&$url</span><span class="var-description">: OpenID server URL</span> </li>
|
|
|
473 |
<li>
|
|
|
474 |
<span class="var-type">string</span>
|
|
|
475 |
<span class="var-name">&$macFunc</span><span class="var-description">: HMAC function (sha1 or sha256)</span> </li>
|
|
|
476 |
<li>
|
|
|
477 |
<span class="var-type">string</span>
|
|
|
478 |
<span class="var-name">&$secret</span><span class="var-description">: shared secret</span> </li>
|
|
|
479 |
<li>
|
|
|
480 |
<span class="var-type">long</span>
|
|
|
481 |
<span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li>
|
|
|
482 |
</ul>
|
|
|
483 |
|
|
|
484 |
<hr class="separator" />
|
|
|
485 |
<div class="notes">Redefinition of:</div>
|
|
|
486 |
<dl>
|
|
|
487 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociationByHandle">Storage::getAssociationByHandle()</a></dt>
|
|
|
488 |
<dd>Gets information about association identified by $handle Returns true if given association found and not expired and false othverwise</dd>
|
|
|
489 |
</dl>
|
|
|
490 |
|
|
|
491 |
</div>
|
|
|
492 |
<a name="methodgetDiscoveryInfo" id="getDiscoveryInfo"><!-- --></a>
|
|
|
493 |
<div class="oddrow">
|
|
|
494 |
|
|
|
495 |
<div class="method-header">
|
|
|
496 |
<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>)
|
|
|
497 |
</div>
|
|
|
498 |
|
|
|
499 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
500 |
<p class="short-description">Gets information discovered from identity $id Returns true if such information exists and false otherwise</p>
|
|
|
501 |
<ul class="tags">
|
|
|
502 |
<li><span class="field">access:</span> public</li>
|
|
|
503 |
</ul>
|
|
|
504 |
|
|
|
505 |
<div class="method-signature">
|
|
|
506 |
<span class="method-result">bool</span>
|
|
|
507 |
<span class="method-name">
|
|
|
508 |
getDiscoveryInfo
|
|
|
509 |
</span>
|
|
|
510 |
(<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>)
|
|
|
511 |
</div>
|
|
|
512 |
|
|
|
513 |
<ul class="parameters">
|
|
|
514 |
<li>
|
|
|
515 |
<span class="var-type">string</span>
|
|
|
516 |
<span class="var-name">$id</span><span class="var-description">: identity</span> </li>
|
|
|
517 |
<li>
|
|
|
518 |
<span class="var-type">string</span>
|
|
|
519 |
<span class="var-name">&$realId</span><span class="var-description">: discovered real identity URL</span> </li>
|
|
|
520 |
<li>
|
|
|
521 |
<span class="var-type">string</span>
|
|
|
522 |
<span class="var-name">&$server</span><span class="var-description">: discovered OpenID server URL</span> </li>
|
|
|
523 |
<li>
|
|
|
524 |
<span class="var-type">float</span>
|
|
|
525 |
<span class="var-name">&$version</span><span class="var-description">: discovered OpenID protocol version</span> </li>
|
|
|
526 |
<li>
|
|
|
527 |
<span class="var-type">long</span>
|
|
|
528 |
<span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span> </li>
|
|
|
529 |
</ul>
|
|
|
530 |
|
|
|
531 |
<hr class="separator" />
|
|
|
532 |
<div class="notes">Redefinition of:</div>
|
|
|
533 |
<dl>
|
|
|
534 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetDiscoveryInfo">Storage::getDiscoveryInfo()</a></dt>
|
|
|
535 |
<dd>Gets information discovered from identity $id Returns true if such information exists and false otherwise</dd>
|
|
|
536 |
</dl>
|
|
|
537 |
|
|
|
538 |
</div>
|
|
|
539 |
<a name="methodisUniqueNonce" id="isUniqueNonce"><!-- --></a>
|
|
|
540 |
<div class="evenrow">
|
|
|
541 |
|
|
|
542 |
<div class="method-header">
|
|
|
543 |
<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>)
|
|
|
544 |
</div>
|
|
|
545 |
|
|
|
546 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
547 |
<p class="short-description">The function checks the uniqueness of openid.response_nonce</p>
|
|
|
548 |
<ul class="tags">
|
|
|
549 |
<li><span class="field">access:</span> public</li>
|
|
|
550 |
</ul>
|
|
|
551 |
|
|
|
552 |
<div class="method-signature">
|
|
|
553 |
<span class="method-result">bool</span>
|
|
|
554 |
<span class="method-name">
|
|
|
555 |
isUniqueNonce
|
|
|
556 |
</span>
|
|
|
557 |
(<span class="var-type">string</span> <span class="var-name">$provider</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>)
|
|
|
558 |
</div>
|
|
|
559 |
|
|
|
560 |
<ul class="parameters">
|
|
|
561 |
<li>
|
|
|
562 |
<span class="var-type">string</span>
|
|
|
563 |
<span class="var-name">$provider</span><span class="var-description">: openid.openid_op_endpoint field from authentication response</span> </li>
|
|
|
564 |
<li>
|
|
|
565 |
<span class="var-type">string</span>
|
|
|
566 |
<span class="var-name">$nonce</span><span class="var-description">: openid.response_nonce field from authentication response</span> </li>
|
|
|
567 |
</ul>
|
|
|
568 |
|
|
|
569 |
<hr class="separator" />
|
|
|
570 |
<div class="notes">Redefinition of:</div>
|
|
|
571 |
<dl>
|
|
|
572 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodisUniqueNonce">Storage::isUniqueNonce()</a></dt>
|
|
|
573 |
<dd>The function checks the uniqueness of openid.response_nonce</dd>
|
|
|
574 |
</dl>
|
|
|
575 |
|
|
|
576 |
</div>
|
|
|
577 |
<a name="methodpurgeNonces" id="purgeNonces"><!-- --></a>
|
|
|
578 |
<div class="oddrow">
|
|
|
579 |
|
|
|
580 |
<div class="method-header">
|
|
|
581 |
<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>)
|
|
|
582 |
</div>
|
|
|
583 |
|
|
|
584 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
585 |
<p class="short-description">Removes data from the uniqueness database that is older then given date</p>
|
|
|
586 |
<ul class="tags">
|
|
|
587 |
<li><span class="field">access:</span> public</li>
|
|
|
588 |
</ul>
|
|
|
589 |
|
|
|
590 |
<div class="method-signature">
|
|
|
591 |
<span class="method-result">void</span>
|
|
|
592 |
<span class="method-name">
|
|
|
593 |
purgeNonces
|
|
|
594 |
</span>
|
|
|
595 |
([<span class="var-type">mixed</span> <span class="var-name">$date</span> = <span class="var-default">null</span>])
|
|
|
596 |
</div>
|
|
|
597 |
|
|
|
598 |
<ul class="parameters">
|
|
|
599 |
<li>
|
|
|
600 |
<span class="var-type">mixed</span>
|
|
|
601 |
<span class="var-name">$date</span><span class="var-description">: date of expired data</span> </li>
|
|
|
602 |
</ul>
|
|
|
603 |
|
|
|
604 |
<hr class="separator" />
|
|
|
605 |
<div class="notes">Redefinition of:</div>
|
|
|
606 |
<dl>
|
|
|
607 |
<dt><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodpurgeNonces">Storage::purgeNonces()</a></dt>
|
|
|
608 |
<dd>Removes data from the uniqueness database that is older then given date</dd>
|
|
|
609 |
</dl>
|
|
|
610 |
|
|
|
611 |
</div>
|
|
|
612 |
<h4>Inherited Methods</h4>
|
|
|
613 |
<a name='inherited_methods'><!-- --></a>
|
|
|
614 |
<!-- =========== Summary =========== -->
|
|
|
615 |
<p>Inherited From <span class="classname"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></span></p>
|
|
|
616 |
<blockquote>
|
|
|
617 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddAssociation">Storage::addAssociation()</a></span><br>
|
|
|
618 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodaddDiscoveryInfo">Storage::addDiscoveryInfo()</a></span><br>
|
|
|
619 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelAssociation">Storage::delAssociation()</a></span><br>
|
|
|
620 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methoddelDiscoveryInfo">Storage::delDiscoveryInfo()</a></span><br>
|
|
|
621 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociation">Storage::getAssociation()</a></span><br>
|
|
|
622 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetAssociationByHandle">Storage::getAssociationByHandle()</a></span><br>
|
|
|
623 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodgetDiscoveryInfo">Storage::getDiscoveryInfo()</a></span><br>
|
|
|
624 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodisUniqueNonce">Storage::isUniqueNonce()</a></span><br>
|
|
|
625 |
<span class="method-name"><a href="../../Zend_OpenId/Zend_OpenId_Consumer/Storage.html#methodpurgeNonces">Storage::purgeNonces()</a></span><br>
|
|
|
626 |
</blockquote>
|
|
|
627 |
|
|
|
628 |
</div>
|
|
|
629 |
</div>
|
|
|
630 |
|
|
|
631 |
|
|
|
632 |
<p class="notes" id="credit">
|
| 302 |
jpm |
633 |
Documentation generated on Tue, 18 Jan 2011 15:31:01 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
| 297 |
jpm |
634 |
</p>
|
|
|
635 |
</div></body>
|
|
|
636 |
</html>
|