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
|
<?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 page OpenID.php</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="file-name">/Auth/OpenID.php</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-includes">Includes</a>
| <a href="#sec-constants">Constants</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This is the PHP OpenID library by JanRain, Inc.</p>
<p class="description"><p>This module contains core utility functionality used by the library. See Consumer.php and Server.php for the consumer and server implementations.</p><p>PHP versions 4 and 5</p><p>LICENSE: See the COPYING file included in this distribution.</p></p>
<ul class="tags">
<li><span class="field">author:</span> JanRain, Inc. <<a href="mailto:openid@janrain.com">openid@janrain.com</a>></li>
<li><span class="field">copyright:</span> 2005 Janrain, Inc.</li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">LGPL</a></li>
</ul>
</div>
</div>
<a name="sec-includes"></a>
<div class="info-box">
<div class="info-box-title">Includes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Includes</span>
| <a href="#sec-constants">Constants</a>
</div>
<div class="info-box-body">
<a name="_Auth/Yadis/PlainHTTPFetcher_php"><!-- --></a>
<div class="evenrow">
<div>
<span class="include-title">
<span class="include-type">require_once</span>
(<span class="include-name">"Auth/Yadis/PlainHTTPFetcher.php"</span>)
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Require the fetcher code.</p>
</div>
<a name="_Auth/OpenID/BigMath_php"><!-- --></a>
<div class="oddrow">
<div>
<span class="include-title">
<span class="include-type">require_once</span>
(<span class="include-name">"Auth/OpenID/BigMath.php"</span>)
(line <span class="line-number">25</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="_Auth/Yadis/ParanoidHTTPFetcher_php"><!-- --></a>
<div class="evenrow">
<div>
<span class="include-title">
<span class="include-type">require_once</span>
(<span class="include-name">"Auth/Yadis/ParanoidHTTPFetcher.php"</span>)
(line <span class="line-number">24</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
</div>
<a name="sec-constants"></a>
<div class="info-box">
<div class="info-box-title">Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-includes">Includes</a>
| <span class="disabled">Constants</span>
</div>
<div class="info-box-body">
<a name="defineAuth_OpenID_digits"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_digits</span> = "0123456789"
(line <span class="line-number">93</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_DO_ABOUT"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_DO_ABOUT</span> = 'do_about'
(line <span class="line-number">85</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status code returned when there were no OpenID arguments passed. This code indicates that the caller should return a 200 OK response and display an HTML page that says that this is an OpenID server endpoint.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a></li>
</ul>
</div>
<a name="defineAuth_OpenID_DO_AUTH"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_DO_AUTH</span> = 'do_auth'
(line <span class="line-number">75</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status code returned when the caller needs to authenticate the</p>
<p class="description"><p>user. The associated value is a <a href="../OpenID/Auth_OpenID_ServerRequest.html">Auth_OpenID_ServerRequest</a> object that can be used to complete the authentication. If the user has taken some authentication action, use the retry() method of the <a href="../OpenID/Auth_OpenID_ServerRequest.html">Auth_OpenID_ServerRequest</a> object to complete the request.</p></p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a></li>
</ul>
</div>
<a name="defineAuth_OpenID_letters"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_letters</span> = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
(line <span class="line-number">90</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Defines for regexes and format checking.</p>
</div>
<a name="defineAuth_OpenID_LOCAL_ERROR"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_LOCAL_ERROR</span> = 'local_error'
(line <span class="line-number">35</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status code returned by the server when the only option is to show an error page, since we do not have enough information to redirect back to the consumer. The associated value is an error message that should be displayed on an HTML error page.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a></li>
</ul>
</div>
<a name="defineAuth_OpenID_punct"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_punct</span> = "!!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
(line <span class="line-number">96</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_REDIRECT"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_REDIRECT</span> = 'redirect'
(line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status code returned when there is a redirect back to the consumer. The value is the URL to redirect back to. The caller should return a 302 Found redirect with a Location: header containing the URL.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a></li>
</ul>
</div>
<a name="defineAuth_OpenID_REMOTE_ERROR"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_REMOTE_ERROR</span> = 'remote_error'
(line <span class="line-number">44</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status code returned when there is an error to return in key-value form to the consumer. The caller should return a 400 Bad Request response with content-type text/plain and the value as the body.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a></li>
</ul>
</div>
<a name="defineAuth_OpenID_REMOTE_OK"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_REMOTE_OK</span> = 'remote_ok'
(line <span class="line-number">54</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status code returned when there is a key-value form OK response to the consumer. The value associated with this code is the response. The caller should return a 200 OK response with content-type text/plain and the value as the body.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a></li>
</ul>
</div>
</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>
|
