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