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
|
<?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_PAPE_Response</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_PAPE_Response</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">A Provider Authentication Policy response, sent from a provider to</p>
<p class="description"><p>a relying party</p></p>
<p class="notes">
Located in <a class="field" href="_Auth---OpenID---PAPE.php.html">/Auth/OpenID/PAPE.php</a> (line <span class="field">157</span>)
</p>
<pre><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a>
|
--Auth_OpenID_PAPE_Response</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 class="var-title">
<span class="var-type">mixed</span>
<a href="#$ns_uri" title="details" class="var-name">$ns_uri</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">Auth_OpenID_PAPE_Response</span>
<a href="#Auth_OpenID_PAPE_Response" title="details" class="method-name">Auth_OpenID_PAPE_Response</a>
([<span class="var-type"></span> <span class="var-name">$auth_policies</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$auth_age</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$nist_auth_level</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#addPolicyURI" title="details" class="method-name">addPolicyURI</a>
(<span class="var-type">policy_uri:</span> <span class="var-name">$policy_uri</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#fromSuccessResponse" title="details" class="method-name">fromSuccessResponse</a>
(<span class="var-type">success_response</span> <span class="var-name">$success_response</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">null</span>
<a href="#parseExtensionArgs" title="details" class="method-name">parseExtensionArgs</a>
(<span class="var-type">args:</span> <span class="var-name">$args</span>, [<span class="var-type">strict:</span> <span class="var-name">$strict</span> = <span class="var-default">false</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-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="evenrow">
<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"> 'pape'</span> (line <span class="line-number">159</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>
<a name="var$ns_uri" id="$ns_uri"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$ns_uri</span>
= <span class="var-default"> Auth_OpenID_PAPE_NS_URI</span> (line <span class="line-number">160</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_uri">Auth_OpenID_Extension::$ns_uri</a></dt>
<dd>ns_uri: The namespace to which to add the arguments for this</dd>
</dl>
</div>
</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="methodAuth_OpenID_PAPE_Response" id="Auth_OpenID_PAPE_Response"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor Auth_OpenID_PAPE_Response</span> (line <span class="line-number">162</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">Auth_OpenID_PAPE_Response</span>
<span class="method-name">
Auth_OpenID_PAPE_Response
</span>
([<span class="var-type"></span> <span class="var-name">$auth_policies</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$auth_age</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$nist_auth_level</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$auth_policies</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$auth_age</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$nist_auth_level</span> </li>
</ul>
</div>
<a name="methodaddPolicyURI" id="addPolicyURI"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">addPolicyURI</span> (line <span class="line-number">185</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a authentication policy to this response</p>
<p class="description"><p>This method is intended to be used by the provider to add a policy that the provider conformed to when authenticating the user.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
addPolicyURI
</span>
(<span class="var-type">policy_uri:</span> <span class="var-name">$policy_uri</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">policy_uri:</span>
<span class="var-name">$policy_uri</span><span class="var-description">: The identifier for the preferred type of authentication.</span> </li>
</ul>
</div>
<a name="methodfromSuccessResponse" id="fromSuccessResponse"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">fromSuccessResponse</span> (line <span class="line-number">202</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create an Auth_OpenID_PAPE_Response object from a successful OpenID library response.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
fromSuccessResponse
</span>
(<span class="var-type">success_response</span> <span class="var-name">$success_response</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">success_response</span>
<span class="var-name">$success_response</span><span class="var-description">: A SuccessResponse from Auth_OpenID_Consumer::complete()</span> </li>
</ul>
</div>
<a name="methodgetExtensionArgs" id="getExtensionArgs"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getExtensionArgs</span> (line <span class="line-number">278</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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="evenrow">
<div class="method-header">
<span class="method-title">parseExtensionArgs</span> (line <span class="line-number">235</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse the provider authentication policy arguments into the internal state of this object</p>
<ul class="tags">
<li><span class="field">return:</span> The data is parsed into the internal fields of this object.</li>
</ul>
<div class="method-signature">
<span class="method-result">null</span>
<span class="method-name">
parseExtensionArgs
</span>
(<span class="var-type">args:</span> <span class="var-name">$args</span>, [<span class="var-type">strict:</span> <span class="var-name">$strict</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">args:</span>
<span class="var-name">$args</span><span class="var-description">: unqualified provider authentication policy arguments</span> </li>
<li>
<span class="var-type">strict:</span>
<span class="var-name">$strict</span><span class="var-description">: Whether to return false when bad data is encountered</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:13 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|
