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
|
<?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_AX_KeyValueMessage</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_AX_KeyValueMessage</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-descendents">Descendents</a>
| <a href="#sec-vars">Vars</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 abstract class that implements a message that has attribute keys and values. It contains the common code between fetch_response and store_request.</p>
<p class="notes">
Located in <a class="field" href="_Auth---OpenID---AX.php.html">/Auth/OpenID/AX.php</a> (line <span class="field">540</span>)
</p>
<pre><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a>
|
--<a href="../OpenID/Auth_OpenID_AX_Message.html">Auth_OpenID_AX_Message</a>
|
--Auth_OpenID_AX_KeyValueMessage</pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_AX_FetchResponse.html">Auth_OpenID_AX_FetchResponse</a></td>
<td>
A fetch_response attribute exchange message.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_AX_StoreRequest.html">Auth_OpenID_AX_StoreRequest</a></td>
<td>
A store request attribute exchange message representation.
</td>
</tr>
</table>
</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-descendents">Descendents</a> |
<a href="#sec-vars">Vars</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">Auth_OpenID_AX_KeyValueMessage</span>
<a href="#Auth_OpenID_AX_KeyValueMessage" title="details" class="method-name">Auth_OpenID_AX_KeyValueMessage</a>
()
</div>
<div class="method-definition">
<span class="method-result">null</span>
<a href="#addValue" title="details" class="method-name">addValue</a>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>, <span class="var-type">value:</span> <span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#count" title="details" class="method-name">count</a>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>)
</div>
<div class="method-definition">
<span class="method-result">$values</span>
<a href="#get" title="details" class="method-name">get</a>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>)
</div>
<div class="method-definition">
<span class="method-result">$value</span>
<a href="#getSingle" title="details" class="method-name">getSingle</a>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>, [<span class="var-type">default:</span> <span class="var-name">$default</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result"><a href="../OpenID/Auth_OpenID_AX_Error.html">Auth_OpenID_AX_Error</a></span>
<a href="#parseExtensionArgs" title="details" class="method-name">parseExtensionArgs</a>
(<span class="var-type">ax_args:</span> <span class="var-name">$ax_args</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setValues" title="details" class="method-name">setValues</a>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>, <span class="var-type">values:</span> <span class="var-name">&$values</span>)
</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-descendents">Descendents</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">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../OpenID/Auth_OpenID_AX_Message.html">Auth_OpenID_AX_Message</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$mode">Auth_OpenID_AX_Message::$mode</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$ns_alias">Auth_OpenID_AX_Message::$ns_alias</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$ns_uri">Auth_OpenID_AX_Message::$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-descendents">Descendents</a> |
<a href="#sec-vars">Vars</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="methodAuth_OpenID_AX_KeyValueMessage" id="Auth_OpenID_AX_KeyValueMessage"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor Auth_OpenID_AX_KeyValueMessage</span> (line <span class="line-number">542</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">Auth_OpenID_AX_KeyValueMessage</span>
<span class="method-name">
Auth_OpenID_AX_KeyValueMessage
</span>
()
</div>
</div>
<a name="methodaddValue" id="addValue"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">addValue</span> (line <span class="line-number">558</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a single value for the given attribute type to the message. If there are already values specified for this type, this value will be sent in addition to the values already specified.</p>
<div class="method-signature">
<span class="method-result">null</span>
<span class="method-name">
addValue
</span>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>, <span class="var-type">value:</span> <span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">type_uri:</span>
<span class="var-name">$type_uri</span><span class="var-description">: The URI for the attribute</span> </li>
<li>
<span class="var-type">value:</span>
<span class="var-name">$value</span><span class="var-description">: The value to add to the response to the relying party for this attribute</span> </li>
</ul>
</div>
<a name="methodcount" id="count"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">count</span> (line <span class="line-number">774</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the number of responses for a particular attribute in this fetch_response message.</p>
<ul class="tags">
<li><span class="field">return:</span> The number of values sent for this attribute. If the attribute was not sent in the response, returns Auth_OpenID_AX_Error.</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
count
</span>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">type_uri:</span>
<span class="var-name">$type_uri</span><span class="var-description">: The URI of the attribute</span> </li>
</ul>
</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">get</span> (line <span class="line-number">752</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the list of values for this attribute in the fetch_response.</p>
<p class="description"><p>XXX: what to do if the values are not present? default parameter? this is funny because it's always supposed to return a list, so the default may break that, though it's provided by the user's code, so it might be okay. If no default is supplied, should the return be None or []?</p></p>
<ul class="tags">
<li><span class="field">return:</span> The list of values for this attribute in the response. May be an empty list. If the attribute was not sent in the response, returns Auth_OpenID_AX_Error.</li>
</ul>
<div class="method-signature">
<span class="method-result">$values</span>
<span class="method-name">
get
</span>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">type_uri:</span>
<span class="var-name">$type_uri</span><span class="var-description">: The URI of the attribute</span> </li>
</ul>
</div>
<a name="methodgetSingle" id="getSingle"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getSingle</span> (line <span class="line-number">721</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get a single value for an attribute. If no value was sent for this attribute, use the supplied default. If there is more than one value for this attribute, this method will fail.</p>
<ul class="tags">
<li><span class="field">return:</span> Auth_OpenID_AX_Error on failure or the value of the attribute in the fetch_response message, or the default supplied</li>
</ul>
<div class="method-signature">
<span class="method-result">$value</span>
<span class="method-name">
getSingle
</span>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>, [<span class="var-type">default:</span> <span class="var-name">$default</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">type_uri:</span>
<span class="var-name">$type_uri</span><span class="var-description">: The URI for the attribute</span> </li>
<li>
<span class="var-type">default:</span>
<span class="var-name">$default</span><span class="var-description">: The value to return if the attribute was not sent in the fetch_response.</span> </li>
</ul>
</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">620</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse attribute exchange key/value arguments into this object.</p>
<ul class="tags">
<li><span class="field">return:</span> or true</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../OpenID/Auth_OpenID_AX_Error.html">Auth_OpenID_AX_Error</a></span>
<span class="method-name">
parseExtensionArgs
</span>
(<span class="var-type">ax_args:</span> <span class="var-name">$ax_args</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">ax_args:</span>
<span class="var-name">$ax_args</span><span class="var-description">: The attribute exchange fetch_response arguments, with namespacing removed.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_AX_FetchResponse.html#methodparseExtensionArgs">Auth_OpenID_AX_FetchResponse::parseExtensionArgs()</a>
</li>
</ul>
</div>
<a name="methodsetValues" id="setValues"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setValues</span> (line <span class="line-number">575</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the values for the given attribute type. This replaces any values that have already been set for this attribute.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setValues
</span>
(<span class="var-type">type_uri:</span> <span class="var-name">$type_uri</span>, <span class="var-type">values:</span> <span class="var-name">&$values</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">type_uri:</span>
<span class="var-name">$type_uri</span><span class="var-description">: The URI for the attribute</span> </li>
<li>
<span class="var-type">values:</span>
<span class="var-name">&$values</span><span class="var-description">: A list of values to send for this attribute.</span> </li>
</ul>
</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:10 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|
