Subversion Repositories Applications.framework

Rev

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

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