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
|
<?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_AuthRequest</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_AuthRequest</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class represents an authentication request from a consumer to an OpenID server.</p>
<p class="notes">
Located in <a class="field" href="_Auth---OpenID---Consumer.php.html">/Auth/OpenID/Consumer.php</a> (line <span class="field">1737</span>)
</p>
<pre></pre>
</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> |
<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_AuthRequest</span>
<a href="#Auth_OpenID_AuthRequest" title="details" class="method-name">Auth_OpenID_AuthRequest</a>
(<span class="var-type"></span> <span class="var-name">&$endpoint</span>, <span class="var-type"></span> <span class="var-name">$assoc</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#addExtension" title="details" class="method-name">addExtension</a>
(<span class="var-type"></span> <span class="var-name">&$extension_request</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#addExtensionArg" title="details" class="method-name">addExtensionArg</a>
(<span class="var-type">string</span> <span class="var-name">$namespace</span>, <span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#formMarkup" title="details" class="method-name">formMarkup</a>
(<span class="var-type"></span> <span class="var-name">$realm</span>, [<span class="var-type"></span> <span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$form_tag_attrs</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getMessage" title="details" class="method-name">getMessage</a>
(<span class="var-type">string</span> <span class="var-name">$realm</span>, [<span class="var-type">string</span> <span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#redirectURL" title="details" class="method-name">redirectURL</a>
(<span class="var-type"></span> <span class="var-name">$realm</span>, [<span class="var-type"></span> <span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setAnonymous" title="details" class="method-name">setAnonymous</a>
(<span class="var-type"></span> <span class="var-name">$is_anonymous</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#shouldSendRedirect" title="details" class="method-name">shouldSendRedirect</a>
()
</div>
</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-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodAuth_OpenID_AuthRequest" id="Auth_OpenID_AuthRequest"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor Auth_OpenID_AuthRequest</span> (line <span class="line-number">1747</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialize an authentication request with the specified token, association, and endpoint.</p>
<p class="description"><p>Users of this library should not create instances of this class. Instances of this class are created by the library when needed.</p></p>
<div class="method-signature">
<span class="method-result">Auth_OpenID_AuthRequest</span>
<span class="method-name">
Auth_OpenID_AuthRequest
</span>
(<span class="var-type"></span> <span class="var-name">&$endpoint</span>, <span class="var-type"></span> <span class="var-name">$assoc</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$endpoint</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$assoc</span> </li>
</ul>
</div>
<a name="methodaddExtension" id="addExtension"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">addExtension</span> (line <span class="line-number">1764</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add an extension to this checkid request.</p>
<p class="description"><p>$extension_request: An object that implements the extension request interface for adding arguments to an OpenID message.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
addExtension
</span>
(<span class="var-type"></span> <span class="var-name">&$extension_request</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$extension_request</span> </li>
</ul>
</div>
<a name="methodaddExtensionArg" id="addExtensionArg"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">addExtensionArg</span> (line <span class="line-number">1788</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add an extension argument to this OpenID authentication request.</p>
<p class="description"><p>Use caution when adding arguments, because they will be URL-escaped and appended to the redirect URL, which can easily get quite long.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
addExtensionArg
</span>
(<span class="var-type">string</span> <span class="var-name">$namespace</span>, <span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$namespace</span><span class="var-description">: The namespace for the extension. For example, the simple registration extension uses the namespace 'sreg'.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: The key within the extension namespace. For example, the nickname field in the simple registration extension's key is 'nickname'.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: The value to provide to the server for this argument.</span> </li>
</ul>
</div>
<a name="methodformMarkup" id="formMarkup"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">formMarkup</span> (line <span class="line-number">1925</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get html for a form to submit this request to the IDP.</p>
<p class="description"><p>form_tag_attrs: An array of attributes to be added to the form tag. 'accept-charset' and 'enctype' have defaults that can be overridden. If a value is supplied for 'action' or 'method', it will be replaced.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
formMarkup
</span>
(<span class="var-type"></span> <span class="var-name">$realm</span>, [<span class="var-type"></span> <span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$form_tag_attrs</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$realm</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$return_to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$immediate</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$form_tag_attrs</span> </li>
</ul>
</div>
<a name="methodgetMessage" id="getMessage"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getMessage</span> (line <span class="line-number">1832</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Produce a <a href="../OpenID/Auth_OpenID_Message.html">Auth_OpenID_Message</a> representing this request.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
getMessage
</span>
(<span class="var-type">string</span> <span class="var-name">$realm</span>, [<span class="var-type">string</span> <span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$realm</span><span class="var-description">: The URL (or URL pattern) that identifies your web site to the user when she is authorizing it.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$return_to</span><span class="var-description">: <p>The URL that the OpenID provider will send the user back to after attempting to verify her identity.</p><p>Not specifying a return_to URL means that the user will not be returned to the site issuing the request upon its completion.</p></span> </li>
<li>
<span class="var-type">bool</span>
<span class="var-name">$immediate</span><span class="var-description">: If true, the OpenID provider is to send back a response immediately, useful for behind-the-scenes authentication attempts. Otherwise the OpenID provider may engage the user before providing a response. This is the default case, as the user may need to provide credentials or approve the request before a positive response can be sent.</span> </li>
</ul>
</div>
<a name="methodredirectURL" id="redirectURL"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">redirectURL</span> (line <span class="line-number">1905</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
redirectURL
</span>
(<span class="var-type"></span> <span class="var-name">$realm</span>, [<span class="var-type"></span> <span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$immediate</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$realm</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$return_to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$immediate</span> </li>
</ul>
</div>
<a name="methodsetAnonymous" id="setAnonymous"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setAnonymous</span> (line <span class="line-number">1802</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set whether this request should be made anonymously. If a request is anonymous, the identifier will not be sent in the request. This is only useful if you are making another kind of request with an extension in this request.</p>
<p class="description"><p>Anonymous requests are not allowed when the request is made with OpenID 1.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setAnonymous
</span>
(<span class="var-type"></span> <span class="var-name">$is_anonymous</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$is_anonymous</span> </li>
</ul>
</div>
<a name="methodshouldSendRedirect" id="shouldSendRedirect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">shouldSendRedirect</span> (line <span class="line-number">1938</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
shouldSendRedirect
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 05 Dec 2007 14:02:11 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|
