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
|
<?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 Message.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/Message.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-classes">Classes</a>
| <a href="#sec-includes">Includes</a>
| <a href="#sec-constants">Constants</a>
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extension argument processing code</p>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
| <a href="#sec-includes">Includes</a>
| <a href="#sec-constants">Constants</a>
| <a href="#sec-functions">Functions</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; vertical-align: top">
<a href="../OpenID/Auth_OpenID_Mapping.html">Auth_OpenID_Mapping</a>
</td>
<td>
An Auth_OpenID_Mapping maintains a mapping from arbitrary keys to arbitrary values. (This is unlike an ordinary PHP array, whose keys may be only simple scalars.)
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../OpenID/Auth_OpenID_NamespaceMap.html">Auth_OpenID_NamespaceMap</a>
</td>
<td>
Maintains a bijective map between namespace uris and aliases.
</td>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../OpenID/Auth_OpenID_Message.html">Auth_OpenID_Message</a>
</td>
<td>
In the implementation of this object, null represents the global namespace as well as a namespace with no key.
</td>
</tr>
</table>
</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> |
<a href="#sec-classes">Classes</a>
| <span class="disabled">Includes</span>
| <a href="#sec-constants">Constants</a>
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<a name="_Auth/OpenID_php"><!-- --></a>
<div class="evenrow">
<div>
<span class="include-title">
<span class="include-type">require_once</span>
(<span class="include-name"><a href="../OpenID/_Auth---OpenID.php.html">'Auth/OpenID.php'</a></span>)
(line <span class="line-number">12</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Import tools needed to deal with messages.</p>
</div>
<a name="_Auth/OpenID/KVForm_php"><!-- --></a>
<div class="oddrow">
<div>
<span class="include-title">
<span class="include-type">require_once</span>
(<span class="include-name">'Auth/OpenID/KVForm.php'</span>)
(line <span class="line-number">13</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="_Auth/Yadis/XML_php"><!-- --></a>
<div class="evenrow">
<div>
<span class="include-title">
<span class="include-type">require_once</span>
(<span class="include-name"><a href="../OpenID/_Auth---Yadis---XML.php.html">'Auth/Yadis/XML.php'</a></span>)
(line <span class="line-number">14</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-classes">Classes</a>
| <a href="#sec-includes">Includes</a>
| <span class="disabled">Constants</span>
| <a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<a name="defineAuth_OpenID_BARE_NS"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_BARE_NS</span> = 'Bare namespace'
(line <span class="line-number">39</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_IDENTIFIER_SELECT"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_IDENTIFIER_SELECT</span> = "http://specs.openid.net/auth/2.0/identifier_select"
(line <span class="line-number">17</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_NO_DEFAULT"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_NO_DEFAULT</span> = 'NO DEFAULT ALLOWED'
(line <span class="line-number">43</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_NULL_NAMESPACE"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_NULL_NAMESPACE</span> = 'Null namespace'
(line <span class="line-number">32</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_OPENID1_NS"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_OPENID1_NS</span> = 'http://openid.net/signon/1.0'
(line <span class="line-number">25</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_OPENID1_URL_LIMIT"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_OPENID1_URL_LIMIT</span> = 2047
(line <span class="line-number">47</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_OPENID2_NS"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_OPENID2_NS</span> = 'http://specs.openid.net/auth/2.0'
(line <span class="line-number">28</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_OPENID_NS"><!-- --></a>
<div class="evenrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_OPENID_NS</span> = 'OpenID namespace'
(line <span class="line-number">35</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="defineAuth_OpenID_SREG_URI"><!-- --></a>
<div class="oddrow">
<div>
<span class="const-title">
<span class="const-name">Auth_OpenID_SREG_URI</span> = 'http://openid.net/sreg/1.0'
(line <span class="line-number">22</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
</div>
<a name="sec-functions"></a>
<div class="info-box">
<div class="info-box-title">Functions</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-classes">Classes</a>
| <a href="#sec-includes">Includes</a>
| <a href="#sec-constants">Constants</a>
| <span class="disabled">Functions</span>
</div>
<div class="info-box-body">
<a name="functionAuth_OpenID_registerNamespaceAlias" id="functionAuth_OpenID_registerNamespaceAlias"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">Auth_OpenID_registerNamespaceAlias</span> (line <span class="line-number">70</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers a (namespace URI, alias) mapping in a global namespace</p>
<p class="description"><p>alias map. Raises NamespaceAliasRegistrationError if either the namespace URI or alias has already been registered with a different value. This function is required if you want to use a namespace with an OpenID 1 message.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
Auth_OpenID_registerNamespaceAlias
</span>
(<span class="var-type"></span> <span class="var-name">$namespace_uri</span>, <span class="var-type"></span> <span class="var-name">$alias</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$namespace_uri</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$alias</span> </li>
</ul>
</div>
<a name="functionAuth_OpenID_removeNamespaceAlias" id="functionAuth_OpenID_removeNamespaceAlias"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">Auth_OpenID_removeNamespaceAlias</span> (line <span class="line-number">97</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes a (namespace_uri, alias) registration from the global namespace alias map. Returns true if the removal succeeded; false if not (if the mapping did not exist).</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
Auth_OpenID_removeNamespaceAlias
</span>
(<span class="var-type"></span> <span class="var-name">$namespace_uri</span>, <span class="var-type"></span> <span class="var-name">$alias</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$namespace_uri</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$alias</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 05 Dec 2007 14:02:12 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|