1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Auth_OpenID_SRegRequest</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Auth_OpenID_SRegRequest</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An object to hold the state of a simple registration request.</p>
<p class="description"><p>required: A list of the required fields in this simple registration request</p><p>optional: A list of the optional fields in this simple registration request</p></p>
<p class="notes">
Located in <a class="field" href="_Auth---OpenID---SReg.php.html">/Auth/OpenID/SReg.php</a> (line <span class="field">169</span>)
</p>
<pre><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a>
|
--<a href="../OpenID/Auth_OpenID_SRegBase.html">Auth_OpenID_SRegBase</a>
|
--Auth_OpenID_SRegRequest</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$ns_alias" title="details" class="var-name">$ns_alias</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">void</span>
<a href="#allRequestedFields" title="details" class="method-name">allRequestedFields</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#build" title="details" class="method-name">build</a>
([<span class="var-type"></span> <span class="var-name">$required</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$optional</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$policy_url</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$sreg_ns_uri</span> = <span class="var-default">Auth_OpenID_SREG_NS_URI</span>], [<span class="var-type"></span> <span class="var-name">$cls</span> = <span class="var-default">'Auth_OpenID_SRegRequest'</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#contains" title="details" class="method-name">contains</a>
(<span class="var-type"></span> <span class="var-name">$field_name</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#fromOpenIDRequest" title="details" class="method-name">fromOpenIDRequest</a>
(<span class="var-type"></span> <span class="var-name">$request</span>, [<span class="var-type"></span> <span class="var-name">$cls</span> = <span class="var-default">'Auth_OpenID_SRegRequest'</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getExtensionArgs" title="details" class="method-name">getExtensionArgs</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseExtensionArgs" title="details" class="method-name">parseExtensionArgs</a>
(<span class="var-type"></span> <span class="var-name">$args</span>, [<span class="var-type"></span> <span class="var-name">$strict</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#requestField" title="details" class="method-name">requestField</a>
(<span class="var-type"></span> <span class="var-name">$field_name</span>, [<span class="var-type"></span> <span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$strict</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#requestFields" title="details" class="method-name">requestFields</a>
(<span class="var-type"></span> <span class="var-name">$field_names</span>, [<span class="var-type"></span> <span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$strict</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#wereFieldsRequested" title="details" class="method-name">wereFieldsRequested</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$ns_alias" id="$ns_alias"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$ns_alias</span>
= <span class="var-default"> 'sreg'</span> (line <span class="line-number">171</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../OpenID/Auth_OpenID_Extension.html#var$ns_alias">Auth_OpenID_Extension::$ns_alias</a></dt>
</dl>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../OpenID/Auth_OpenID_Extension.html#var$ns_uri">Auth_OpenID_Extension::$ns_uri</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodallRequestedFields" id="allRequestedFields"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">allRequestedFields</span> (line <span class="line-number">287</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A list of all of the simple registration fields that were requested, whether they were required or optional.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
allRequestedFields
</span>
()
</div>
</div>
<a name="methodbuild" id="build"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">build</span> (line <span class="line-number">176</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialize an empty simple registration request.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
build
</span>
([<span class="var-type"></span> <span class="var-name">$required</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$optional</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$policy_url</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$sreg_ns_uri</span> = <span class="var-default">Auth_OpenID_SREG_NS_URI</span>], [<span class="var-type"></span> <span class="var-name">$cls</span> = <span class="var-default">'Auth_OpenID_SRegRequest'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$required</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$optional</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$policy_url</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$sreg_ns_uri</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$cls</span> </li>
</ul>
</div>
<a name="methodcontains" id="contains"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">contains</span> (line <span class="line-number">303</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Was this field in the request?</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
contains
</span>
(<span class="var-type"></span> <span class="var-name">$field_name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$field_name</span> </li>
</ul>
</div>
<a name="methodfromOpenIDRequest" id="fromOpenIDRequest"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">fromOpenIDRequest</span> (line <span class="line-number">216</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create a simple registration request that contains the fields that were requested in the OpenID request with the given arguments</p>
<p class="description"><p>$request: The OpenID authentication request from which to extract an sreg request.</p><p>$cls: name of class to use when creating sreg request object. Used for testing.</p><p>Returns the newly created simple registration request</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
fromOpenIDRequest
</span>
(<span class="var-type"></span> <span class="var-name">$request</span>, [<span class="var-type"></span> <span class="var-name">$cls</span> = <span class="var-default">'Auth_OpenID_SRegRequest'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$request</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$cls</span> </li>
</ul>
</div>
<a name="methodgetExtensionArgs" id="getExtensionArgs"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getExtensionArgs</span> (line <span class="line-number">389</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get a dictionary of unqualified simple registration arguments representing this request.</p>
<p class="description"><p>This method is essentially the inverse of C{L{parseExtensionArgs}}. This method serializes the simple registration request fields.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getExtensionArgs
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></dt>
<dd>Get the string arguments that should be added to an OpenID message for this extension.</dd>
</dl>
</div>
<a name="methodparseExtensionArgs" id="parseExtensionArgs"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">parseExtensionArgs</span> (line <span class="line-number">262</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse the unqualified simple registration request parameters and add them to this object.</p>
<p class="description"><p>This method is essentially the inverse of getExtensionArgs. This method restores the serialized simple registration request fields.</p><p>If you are extracting arguments from a standard OpenID checkid_* request, you probably want to use fromOpenIDRequest, which will extract the sreg namespace and arguments from the OpenID request. This method is intended for cases where the OpenID server needs more control over how the arguments are parsed than that method provides.</p><p>$args == $message->getArgs($ns_uri); $request->parseExtensionArgs($args);</p><p>$args: The unqualified simple registration arguments</p><p>strict: Whether requests with fields that are not defined in the simple registration specification should be tolerated (and ignored)</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
parseExtensionArgs
</span>
(<span class="var-type"></span> <span class="var-name">$args</span>, [<span class="var-type"></span> <span class="var-name">$strict</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$args</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$strict</span> </li>
</ul>
</div>
<a name="methodrequestField" id="requestField"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">requestField</span> (line <span class="line-number">320</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Request the specified field from the OpenID user</p>
<p class="description"><p>$field_name: the unqualified simple registration field name</p><p>required: whether the given field should be presented to the user as being a required to successfully complete the request</p><p>strict: whether to raise an exception when a field is added to a request more than once</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
requestField
</span>
(<span class="var-type"></span> <span class="var-name">$field_name</span>, [<span class="var-type"></span> <span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$strict</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$field_name</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$required</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$strict</span> </li>
</ul>
</div>
<a name="methodrequestFields" id="requestFields"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">requestFields</span> (line <span class="line-number">366</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add the given list of fields to the request</p>
<p class="description"><p>field_names: The simple registration data fields to request</p><p>required: Whether these values should be presented to the user as required</p><p>strict: whether to raise an exception when a field is added to a request more than once</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
requestFields
</span>
(<span class="var-type"></span> <span class="var-name">$field_names</span>, [<span class="var-type"></span> <span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$strict</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$field_names</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$required</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$strict</span> </li>
</ul>
</div>
<a name="methodwereFieldsRequested" id="wereFieldsRequested"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">wereFieldsRequested</span> (line <span class="line-number">295</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Have any simple registration fields been requested?</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
wereFieldsRequested
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a></span></p>
<blockquote>
<span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></span><br>
<span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodtoMessage">Auth_OpenID_Extension::toMessage()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 05 Dec 2007 14:02:14 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|
