Subversion Repositories Applications.framework

Rev

Rev 300 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
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 OpenIdClient</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 OpenIdClient</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
96
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
97
 
98
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
99
 
100
			</div>
101
	<div class="info-box-body">
102
        		<!-- ========== Info from phpDoc block ========= -->
103
<p class="short-description">La classe OpenIdClient est une implémentation d'un client OpenId, depuis une classe Zend.</p>
104
<p class="description"><p>Elle permet d'établir une connexion avec un serveur, en fonction d'un identifiant OpenId.  Elle permet de communiquer de manière sécurisée avec ce serveur, et doit aboutir a une  identification centralisée.</p></p>
105
		<p class="notes">
106
			Located in <a class="field" href="_OpenIdClient.php.html">/OpenIdClient.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a9">9</a></span>)
107
		</p>
108
 
109
 
110
		<pre></pre>
111
 
112
			</div>
113
</div>
114
 
115
 
116
	<a name="sec-const-summary"></a>
117
	<div class="info-box">
118
		<div class="info-box-title">Class Constant Summary</span></div>
119
		<div class="nav-bar">
120
			<a href="#sec-description">Description</a> |
121
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
122
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
123
 
124
				|
125
										|
126
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
127
 
128
					</div>
129
		<div class="info-box-body">
130
			<div class="const-summary">
131
								<div class="const-title">
132
					<img src="../media/images/Constant.png" alt=" " />
133
					<a href="#NS_2_0" title="details" class="const-name">NS_2_0</a> = 					<span class="var-type"> 'http://specs.openid.net/auth/2.0'</span>
134
 
135
				</div>
136
							</div>
137
		</div>
138
	</div>
139
 
140
	<a name="sec-var-summary"></a>
141
	<div class="info-box">
142
		<div class="info-box-title">Variable Summary</span></div>
143
		<div class="nav-bar">
144
			<a href="#sec-description">Description</a> |
145
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
146
							|
147
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
148
 
149
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
150
 
151
					</div>
152
		<div class="info-box-body">
153
			<div class="var-summary">
154
																																<div class="var-title">
155
					<span class="var-type">array</span>
156
					<a href="#$_cache" title="details" class="var-name">$_cache</a>
157
				</div>
158
																<div class="var-title">
159
					<span class="var-type"><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></span>
160
					<a href="#$_storage" title="details" class="var-name">$_storage</a>
161
				</div>
162
											</div>
163
		</div>
164
	</div>
165
 
166
	<a name="sec-method-summary"></a>
167
	<div class="info-box">
168
		<div class="info-box-title">Method Summary</span></div>
169
		<div class="nav-bar">
170
			<a href="#sec-description">Description</a> |
171
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
172
 
173
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
174
 
175
				|
176
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
177
		</div>
178
		<div class="info-box-body">
179
			<div class="method-summary">
180
 
181
				<div class="method-definition">
182
					static 						<span class="method-result">bool</span>
183
										<a href="#normalize" title="details" class="method-name">normalize</a>
184
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$id</span>)
185
									</div>
186
 
187
				<div class="method-definition">
188
					static 						<span class="method-result">bool</span>
189
										<a href="#normalizeUrl" title="details" class="method-name">normalizeUrl</a>
190
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$id</span>)
191
									</div>
192
 
193
				<div class="method-definition">
194
											<span class="method-result">string</span>
195
										<a href="#absoluteUrl" title="details" class="method-name">absoluteUrl</a>
196
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
197
									</div>
198
 
199
				<div class="method-definition">
200
											<span class="method-result">string</span>
201
										<a href="#digest" title="details" class="method-name">digest</a>
202
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$func</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
203
									</div>
204
 
205
				<div class="method-definition">
206
											<span class="method-result">void</span>
207
										<a href="#login" title="details" class="method-name">login</a>
208
											(<span class="var-type"></span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>])
209
									</div>
210
 
211
				<div class="method-definition">
212
											<span class="method-result">OpenIdClient</span>
213
										<a href="#__construct" title="details" class="method-name">__construct</a>
214
										()
215
									</div>
216
 
217
				<div class="method-definition">
218
											<span class="method-result">void</span>
219
										<a href="#redirect" title="details" class="method-name">redirect</a>
220
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
221
									</div>
222
 
223
				<div class="method-definition">
224
											<span class="method-result">string</span>
225
										<a href="#selfUrl" title="details" class="method-name">selfUrl</a>
226
										()
227
									</div>
228
 
229
				<div class="method-definition">
230
											<span class="method-result">void</span>
231
										<a href="#verifierVersion" title="details" class="method-name">verifierVersion</a>
232
											(<span class="var-type"></span>&nbsp;<span class="var-name">$reponseHtml</span>)
233
									</div>
234
 
235
				<div class="method-definition">
236
											<span class="method-result">bool</span>
237
										<a href="#verify" title="details" class="method-name">verify</a>
238
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">&$identity</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$extensions</span> = <span class="var-default">null</span>])
239
									</div>
240
 
241
				<div class="method-definition">
242
											<span class="method-result">void</span>
243
										<a href="#_addAssociation" title="details" class="method-name">_addAssociation</a>
244
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$handle</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$macFunc</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$secret</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$expires</span>)
245
									</div>
246
 
247
				<div class="method-definition">
248
											<span class="method-result">bool</span>
249
										<a href="#_associate" title="details" class="method-name">_associate</a>
250
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$version</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$priv_key</span> = <span class="var-default">null</span>])
251
									</div>
252
 
253
				<div class="method-definition">
254
											<span class="method-result">bool</span>
255
										<a href="#_discovery" title="details" class="method-name">_discovery</a>
256
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$server</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">&$version</span>)
257
									</div>
258
 
259
				<div class="method-definition">
260
											<span class="method-result">void</span>
261
										<a href="#_getAssociation" title="details" class="method-name">_getAssociation</a>
262
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$handle</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$macFunc</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$secret</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">&$expires</span>)
263
									</div>
264
											</div>
265
		</div>
266
	</div>
267
 
268
	<a name="sec-vars"></a>
269
	<div class="info-box">
270
		<div class="info-box-title">Variables</div>
271
		<div class="nav-bar">
272
			<a href="#sec-description">Description</a> |
273
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
274
 
275
 
276
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
277
 
278
										|
279
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
280
 
281
					</div>
282
		<div class="info-box-body">
283
 
284
<a name="var$_cache" id="$_cache"><!-- --></A>
285
<div class="oddrow">
286
 
287
	<div class="var-header">
288
		<span class="var-title">
289
			<span class="var-type">array</span>
290
			<span class="var-name">$_cache</span>
291
			 = <span class="var-default">array()</span>			(line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a26">26</a></span>)
292
		</span>
293
	</div>
294
 
295
	<!-- ========== Info from phpDoc block ========= -->
296
<p class="short-description">Tableau &quot;cache&quot; interne permettant d'éviter des accès inutiles au fichier storage</p>
297
	<ul class="tags">
298
				<li><span class="field">access:</span> protected</li>
299
			</ul>
300
 
301
 
302
 
303
 
304
 
305
</div>
306
<a name="var$_storage" id="$_storage"><!-- --></A>
307
<div class="evenrow">
308
 
309
	<div class="var-header">
310
		<span class="var-title">
311
			<span class="var-type"><a href="../Zend_OpenId/Zend_OpenId_Consumer/Storage.html">Storage</a></span>
312
			<span class="var-name">$_storage</span>
313
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a20">20</a></span>)
314
		</span>
315
	</div>
316
 
317
	<!-- ========== Info from phpDoc block ========= -->
318
<p class="short-description">Variable permettant le stockage d'informations, notammenent à propos des clés DiffieHellmann</p>
319
	<ul class="tags">
320
				<li><span class="field">access:</span> protected</li>
321
			</ul>
322
 
323
 
324
 
325
 
326
 
327
</div>
328
 
329
		</div>
330
	</div>
331
 
332
	<a name="sec-methods"></a>
333
	<div class="info-box">
334
		<div class="info-box-title">Methods</div>
335
		<div class="nav-bar">
336
			<a href="#sec-description">Description</a> |
337
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
338
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
339
 
340
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
341
 
342
		</div>
343
		<div class="info-box-body">
344
			<A NAME='method_detail'></A>
345
<a name="methodnormalize" id="normalize"><!-- --></a>
346
<div class="oddrow">
347
 
348
	<div class="method-header">
349
		<span class="method-title">static normalize</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a971">971</a></span>)
350
	</div>
351
 
352
	<!-- ========== Info from phpDoc block ========= -->
353
<p class="short-description">Normaliser l'identifiant OpenId qui peut être une URL ou nom XRI  Retourne true ou false en cas d'erreur.</p>
354
<p class="description"><p>Règles de normalisation : <ol><li>If the user's input starts with one of the &quot;xri://&quot;, &quot;xri://$ip*&quot;,
355
    or &quot;xri://$dns*&quot; prefixes, they MUST be stripped off, so that XRIs
356
    are used in the canonical form, and URI-authority XRIs are further
357
    considered URL identifiers.</li><li>If the first character of the resulting string is an XRI Global
358
    Context Symbol (&quot;=&quot;, &quot;@&quot;, &quot;+&quot;, &quot;$&quot;, &quot;!&quot;), then the input SHOULD be
359
    treated as an XRI.</li><li>Otherwise, the input SHOULD be treated as an http URL; if it does
360
    not include a &quot;http&quot; or &quot;https&quot; scheme, the Identifier MUST be
361
    prefixed with the string &quot;http://&quot;.</li><li>URL identifiers MUST then be further normalized by both following
362
    redirects when retrieving their content and finally applying the
363
    rules in Section 6 of [RFC3986] to the final destination URL.</li></ol></p></p>
364
	<ul class="tags">
365
				<li><span class="field">access:</span> public</li>
366
			</ul>
367
 
368
	<div class="method-signature">
369
		static <span class="method-result">bool</span>
370
		<span class="method-name">
371
			normalize
372
		</span>
373
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$id</span>)
374
			</div>
375
 
376
			<ul class="parameters">
377
					<li>
378
				<span class="var-type">string</span>
379
				<span class="var-name">&$id</span><span class="var-description">: identifier to be normalized</span>			</li>
380
				</ul>
381
 
382
 
383
	</div>
384
<a name="methodnormalizeUrl" id="normalizeUrl"><!-- --></a>
385
<div class="evenrow">
386
 
387
	<div class="method-header">
388
		<span class="method-title">static normalizeUrl</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a810">810</a></span>)
389
	</div>
390
 
391
	<!-- ========== Info from phpDoc block ========= -->
392
<p class="short-description">Normalizes URL according to RFC 3986 to use it in comparison operations.</p>
393
<p class="description"><p>The function gets URL argument by reference and modifies it.  It returns true on success and false of failure.</p></p>
394
	<ul class="tags">
395
				<li><span class="field">access:</span> public</li>
396
			</ul>
397
 
398
	<div class="method-signature">
399
		static <span class="method-result">bool</span>
400
		<span class="method-name">
401
			normalizeUrl
402
		</span>
403
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$id</span>)
404
			</div>
405
 
406
			<ul class="parameters">
407
					<li>
408
				<span class="var-type">string</span>
409
				<span class="var-name">&$id</span><span class="var-description">: url to be normalized</span>			</li>
410
				</ul>
411
 
412
 
413
	</div>
414
<a name="methodabsoluteUrl" id="absoluteUrl"><!-- --></a>
415
<div class="oddrow">
416
 
417
	<div class="method-header">
418
		<span class="method-title">absoluteUrl</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1123">1123</a></span>)
419
	</div>
420
 
421
	<!-- ========== Info from phpDoc block ========= -->
422
<p class="short-description">Retourne l'url absolue d'une url donnée</p>
423
	<ul class="tags">
424
				<li><span class="field">access:</span> public</li>
425
			</ul>
426
 
427
	<div class="method-signature">
428
		<span class="method-result">string</span>
429
		<span class="method-name">
430
			absoluteUrl
431
		</span>
432
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
433
			</div>
434
 
435
			<ul class="parameters">
436
					<li>
437
				<span class="var-type">string</span>
438
				<span class="var-name">$url</span><span class="var-description">: absilute or relative URL</span>			</li>
439
				</ul>
440
 
441
 
442
	</div>
443
<a name="methoddigest" id="digest"><!-- --></a>
444
<div class="evenrow">
445
 
446
	<div class="method-header">
447
		<span class="method-title">digest</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1018">1018</a></span>)
448
	</div>
449
 
450
	<!-- ========== Info from phpDoc block ========= -->
451
<p class="short-description">Generates a hash value (message digest) according to given algorithm.</p>
452
<p class="description"><p>It returns RAW binary string.</p><p>This is a wrapper function that uses one of available internal function  dependent on given PHP configuration. It may use various functions from   ext/openssl, ext/hash, ext/mhash or ext/standard.</p></p>
453
	<ul class="tags">
454
				<li><span class="field">return:</span> RAW digital signature</li>
455
				<li><span class="field">throws:</span> Zend_OpenId_Exception</li>
456
				<li><span class="field">access:</span> public</li>
457
			</ul>
458
 
459
	<div class="method-signature">
460
		<span class="method-result">string</span>
461
		<span class="method-name">
462
			digest
463
		</span>
464
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$func</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
465
			</div>
466
 
467
			<ul class="parameters">
468
					<li>
469
				<span class="var-type">string</span>
470
				<span class="var-name">$func</span><span class="var-description">: digest algorithm</span>			</li>
471
					<li>
472
				<span class="var-type">string</span>
473
				<span class="var-name">$data</span><span class="var-description">: data to sign</span>			</li>
474
				</ul>
475
 
476
 
477
	</div>
478
<a name="methodlogin" id="login"><!-- --></a>
479
<div class="oddrow">
480
 
481
	<div class="method-header">
482
		<span class="method-title">login</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a48">48</a></span>)
483
	</div>
484
 
485
	<!-- ========== Info from phpDoc block ========= -->
486
<p class="short-description">Fonction login</p>
487
<p class="description"><p>Return true ou false  &gt; Ne retourne rien si true car redirige vers l'adresse du serveur OID</p></p>
488
 
489
	<div class="method-signature">
490
		<span class="method-result">void</span>
491
		<span class="method-name">
492
			login
493
		</span>
494
					(<span class="var-type"></span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>])
495
			</div>
496
 
497
			<ul class="parameters">
498
					<li>
499
				<span class="var-type"></span>
500
				<span class="var-name">$id</span>			</li>
501
					<li>
502
				<span class="var-type"></span>
503
				<span class="var-name">$immediate</span>			</li>
504
				</ul>
505
 
506
 
507
	</div>
508
<a name="method__construct" id="__construct"><!-- --></a>
509
<div class="evenrow">
510
 
511
	<div class="method-header">
512
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a34">34</a></span>)
513
	</div>
514
 
515
	<!-- ========== Info from phpDoc block ========= -->
516
<p class="short-description">Constructeur de l'application</p>
517
 
518
	<div class="method-signature">
519
		<span class="method-result">OpenIdClient</span>
520
		<span class="method-name">
521
			__construct
522
		</span>
523
				()
524
			</div>
525
 
526
 
527
 
528
	</div>
529
<a name="methodredirect" id="redirect"><!-- --></a>
530
<div class="oddrow">
531
 
532
	<div class="method-header">
533
		<span class="method-title">redirect</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1178">1178</a></span>)
534
	</div>
535
 
536
	<!-- ========== Info from phpDoc block ========= -->
537
<p class="short-description">Rediriger vers la page du serveur avec les paramètres de confiration</p>
538
	<ul class="tags">
539
				<li><span class="field">access:</span> public</li>
540
			</ul>
541
 
542
	<div class="method-signature">
543
		<span class="method-result">void</span>
544
		<span class="method-name">
545
			redirect
546
		</span>
547
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
548
			</div>
549
 
550
			<ul class="parameters">
551
					<li>
552
				<span class="var-type">string</span>
553
				<span class="var-name">$url</span><span class="var-description">: URL de retour</span>			</li>
554
					<li>
555
				<span class="var-type">array</span>
556
				<span class="var-name">$params</span><span class="var-description">: paramètres additionnels</span>			</li>
557
				</ul>
558
 
559
 
560
	</div>
561
<a name="methodselfUrl" id="selfUrl"><!-- --></a>
562
<div class="evenrow">
563
 
564
	<div class="method-header">
565
		<span class="method-title">selfUrl</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a1050">1050</a></span>)
566
	</div>
567
 
568
	<!-- ========== Info from phpDoc block ========= -->
569
<p class="short-description">Returns a full URL that was requested on current HTTP request.</p>
570
	<ul class="tags">
571
				<li><span class="field">access:</span> public</li>
572
			</ul>
573
 
574
	<div class="method-signature">
575
		<span class="method-result">string</span>
576
		<span class="method-name">
577
			selfUrl
578
		</span>
579
				()
580
			</div>
581
 
582
 
583
 
584
	</div>
585
<a name="methodverifierVersion" id="verifierVersion"><!-- --></a>
586
<div class="oddrow">
587
 
588
	<div class="method-header">
589
		<span class="method-title">verifierVersion</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a477">477</a></span>)
590
	</div>
591
 
592
	<!-- ========== Info from phpDoc block ========= -->
593
 
594
	<div class="method-signature">
595
		<span class="method-result">void</span>
596
		<span class="method-name">
597
			verifierVersion
598
		</span>
599
					(<span class="var-type"></span>&nbsp;<span class="var-name">$reponseHtml</span>)
600
			</div>
601
 
602
			<ul class="parameters">
603
					<li>
604
				<span class="var-type"></span>
605
				<span class="var-name">$reponseHtml</span>			</li>
606
				</ul>
607
 
608
 
609
	</div>
610
<a name="methodverify" id="verify"><!-- --></a>
611
<div class="evenrow">
612
 
613
	<div class="method-header">
614
		<span class="method-title">verify</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a193">193</a></span>)
615
	</div>
616
 
617
	<!-- ========== Info from phpDoc block ========= -->
618
<p class="short-description">Verifies authentication response from OpenID server.</p>
619
<p class="description"><p>This is the second step of OpenID authentication process.  The function returns true on successful authentication and false on  failure.</p></p>
620
	<ul class="tags">
621
				<li><span class="field">access:</span> public</li>
622
			</ul>
623
 
624
	<div class="method-signature">
625
		<span class="method-result">bool</span>
626
		<span class="method-name">
627
			verify
628
		</span>
629
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">&$identity</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$extensions</span> = <span class="var-default">null</span>])
630
			</div>
631
 
632
			<ul class="parameters">
633
					<li>
634
				<span class="var-type">array</span>
635
				<span class="var-name">$params</span><span class="var-description">: HTTP query data from OpenID server</span>			</li>
636
					<li>
637
				<span class="var-type">string</span>
638
				<span class="var-name">&$identity</span><span class="var-description">: this argument is set to end-user's claimed   identifier or OpenID provider local identifier.</span>			</li>
639
					<li>
640
				<span class="var-type">mixed</span>
641
				<span class="var-name">$extensions</span><span class="var-description">: extension object or array of extensions objects</span>			</li>
642
				</ul>
643
 
644
 
645
	</div>
646
<a name="method_addAssociation" id="_addAssociation"><!-- --></a>
647
<div class="oddrow">
648
 
649
	<div class="method-header">
650
		<span class="method-title">_addAssociation</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a759">759</a></span>)
651
	</div>
652
 
653
	<!-- ========== Info from phpDoc block ========= -->
654
<p class="short-description">Store assiciation in internal chace and external storage</p>
655
	<ul class="tags">
656
				<li><span class="field">access:</span> protected</li>
657
			</ul>
658
 
659
	<div class="method-signature">
660
		<span class="method-result">void</span>
661
		<span class="method-name">
662
			_addAssociation
663
		</span>
664
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$handle</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$macFunc</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$secret</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$expires</span>)
665
			</div>
666
 
667
			<ul class="parameters">
668
					<li>
669
				<span class="var-type">string</span>
670
				<span class="var-name">$url</span><span class="var-description">: OpenID server url</span>			</li>
671
					<li>
672
				<span class="var-type">string</span>
673
				<span class="var-name">$handle</span><span class="var-description">: association handle</span>			</li>
674
					<li>
675
				<span class="var-type">string</span>
676
				<span class="var-name">$macFunc</span><span class="var-description">: HMAC function (sha1 or sha256)</span>			</li>
677
					<li>
678
				<span class="var-type">string</span>
679
				<span class="var-name">$secret</span><span class="var-description">: shared secret</span>			</li>
680
					<li>
681
				<span class="var-type">integer</span>
682
				<span class="var-name">$expires</span><span class="var-description">: expiration UNIX time</span>			</li>
683
				</ul>
684
 
685
 
686
	</div>
687
<a name="method_associate" id="_associate"><!-- --></a>
688
<div class="evenrow">
689
 
690
	<div class="method-header">
691
		<span class="method-title">_associate</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a556">556</a></span>)
692
	</div>
693
 
694
	<!-- ========== Info from phpDoc block ========= -->
695
<p class="short-description">Create (or reuse existing) association between OpenID consumer and  OpenID server based on Diffie-Hellman key agreement. Returns true  on success and false on failure.</p>
696
	<ul class="tags">
697
				<li><span class="field">access:</span> protected</li>
698
			</ul>
699
 
700
	<div class="method-signature">
701
		<span class="method-result">bool</span>
702
		<span class="method-name">
703
			_associate
704
		</span>
705
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$version</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$priv_key</span> = <span class="var-default">null</span>])
706
			</div>
707
 
708
			<ul class="parameters">
709
					<li>
710
				<span class="var-type">string</span>
711
				<span class="var-name">$url</span><span class="var-description">: OpenID server url</span>			</li>
712
					<li>
713
				<span class="var-type">float</span>
714
				<span class="var-name">$version</span><span class="var-description">: OpenID protocol version</span>			</li>
715
					<li>
716
				<span class="var-type">string</span>
717
				<span class="var-name">$priv_key</span><span class="var-description">: for testing only</span>			</li>
718
				</ul>
719
 
720
 
721
	</div>
722
<a name="method_discovery" id="_discovery"><!-- --></a>
723
<div class="oddrow">
724
 
725
	<div class="method-header">
726
		<span class="method-title">_discovery</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a434">434</a></span>)
727
	</div>
728
 
729
	<!-- ========== Info from phpDoc block ========= -->
730
<p class="short-description">Performs discovery of identity and finds OpenID URL, OpenID server URL  and OpenID protocol version. Returns true on succees and false on  failure.</p>
731
	<ul class="tags">
732
				<li><span class="field">todo:</span> OpenID 2.0 (7.3) XRI and Yadis discovery</li>
733
				<li><span class="field">access:</span> protected</li>
734
			</ul>
735
 
736
	<div class="method-signature">
737
		<span class="method-result">bool</span>
738
		<span class="method-name">
739
			_discovery
740
		</span>
741
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$server</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">&$version</span>)
742
			</div>
743
 
744
			<ul class="parameters">
745
					<li>
746
				<span class="var-type">string</span>
747
				<span class="var-name">&$id</span><span class="var-description">: OpenID identity URL</span>			</li>
748
					<li>
749
				<span class="var-type">string</span>
750
				<span class="var-name">&$server</span><span class="var-description">: OpenID server URL</span>			</li>
751
					<li>
752
				<span class="var-type">float</span>
753
				<span class="var-name">&$version</span><span class="var-description">: OpenID protocol version</span>			</li>
754
				</ul>
755
 
756
 
757
	</div>
758
<a name="method_getAssociation" id="_getAssociation"><!-- --></a>
759
<div class="evenrow">
760
 
761
	<div class="method-header">
762
		<span class="method-title">_getAssociation</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a781">781</a></span>)
763
	</div>
764
 
765
	<!-- ========== Info from phpDoc block ========= -->
766
<p class="short-description">Retrive assiciation information for given $url from internal cahce or  external storage</p>
767
	<ul class="tags">
768
				<li><span class="field">access:</span> protected</li>
769
			</ul>
770
 
771
	<div class="method-signature">
772
		<span class="method-result">void</span>
773
		<span class="method-name">
774
			_getAssociation
775
		</span>
776
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$handle</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$macFunc</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$secret</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">&$expires</span>)
777
			</div>
778
 
779
			<ul class="parameters">
780
					<li>
781
				<span class="var-type">string</span>
782
				<span class="var-name">$url</span><span class="var-description">: OpenID server url</span>			</li>
783
					<li>
784
				<span class="var-type">string</span>
785
				<span class="var-name">&$handle</span><span class="var-description">: association handle</span>			</li>
786
					<li>
787
				<span class="var-type">string</span>
788
				<span class="var-name">&$macFunc</span><span class="var-description">: HMAC function (sha1 or sha256)</span>			</li>
789
					<li>
790
				<span class="var-type">string</span>
791
				<span class="var-name">&$secret</span><span class="var-description">: shared secret</span>			</li>
792
					<li>
793
				<span class="var-type">integer</span>
794
				<span class="var-name">&$expires</span><span class="var-description">: expiration UNIX time</span>			</li>
795
				</ul>
796
 
797
 
798
	</div>
799
 
800
		</div>
801
	</div>
802
 
803
	<a name="sec-consts"></a>
804
	<div class="info-box">
805
		<div class="info-box-title">Class Constants</div>
806
		<div class="nav-bar">
807
			<a href="#sec-description">Description</a> |
808
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
809
 
810
 
811
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
812
														|
813
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
814
 
815
					</div>
816
		<div class="info-box-body">
817
			<a name="constNS_2_0" id="NS_2_0"><!-- --></A>
818
<div class="oddrow">
819
 
820
	<div class="const-header">
821
		<img src="../media/images/Variable.png" />
822
		<span class="const-title">
823
			<span class="const-name">NS_2_0</span>
824
			 = <span class="const-default"> 'http://specs.openid.net/auth/2.0'</span>
825
			(line <span class="line-number"><a href="../__filesource/fsource_Framework__OpenIdClient.php.html#a12">12</a></span>)
826
		</span>
827
	</div>
828
 
829
	<!-- ========== Info from phpDoc block ========= -->
830
 
831
 
832
</div>
833
 
834
		</div>
835
	</div>
836
 
837
	<p class="notes" id="credit">
302 jpm 838
		Documentation generated on Tue, 18 Jan 2011 15:30:55 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
297 jpm 839
	</p>
840
	</div></body>
841
</html>