_Auth---OpenID---Message.php.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs for page Message.php</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <div class="page-body">
  12. <h2 class="file-name">/Auth/OpenID/Message.php</h2>
  13. <a name="sec-description"></a>
  14. <div class="info-box">
  15. <div class="info-box-title">Description</div>
  16. <div class="nav-bar">
  17. <span class="disabled">Description</span> |
  18. <a href="#sec-classes">Classes</a>
  19. | <a href="#sec-includes">Includes</a>
  20. | <a href="#sec-constants">Constants</a>
  21. | <a href="#sec-functions">Functions</a>
  22. </div>
  23. <div class="info-box-body">
  24. <!-- ========== Info from phpDoc block ========= -->
  25. <p class="short-description">Extension argument processing code</p>
  26. </div>
  27. </div>
  28. <a name="sec-classes"></a>
  29. <div class="info-box">
  30. <div class="info-box-title">Classes</div>
  31. <div class="nav-bar">
  32. <a href="#sec-description">Description</a> |
  33. <span class="disabled">Classes</span>
  34. | <a href="#sec-includes">Includes</a>
  35. | <a href="#sec-constants">Constants</a>
  36. | <a href="#sec-functions">Functions</a>
  37. </div>
  38. <div class="info-box-body">
  39. <table cellpadding="2" cellspacing="0" class="class-table">
  40. <tr>
  41. <th class="class-table-header">Class</th>
  42. <th class="class-table-header">Description</th>
  43. </tr>
  44. <tr>
  45. <td style="padding-right: 2em; vertical-align: top">
  46. <a href="../OpenID/Auth_OpenID_Mapping.html">Auth_OpenID_Mapping</a>
  47. </td>
  48. <td>
  49. 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.)
  50. </td>
  51. </tr>
  52. <tr>
  53. <td style="padding-right: 2em; vertical-align: top">
  54. <a href="../OpenID/Auth_OpenID_NamespaceMap.html">Auth_OpenID_NamespaceMap</a>
  55. </td>
  56. <td>
  57. Maintains a bijective map between namespace uris and aliases.
  58. </td>
  59. </tr>
  60. <tr>
  61. <td style="padding-right: 2em; vertical-align: top">
  62. <a href="../OpenID/Auth_OpenID_Message.html">Auth_OpenID_Message</a>
  63. </td>
  64. <td>
  65. In the implementation of this object, null represents the global namespace as well as a namespace with no key.
  66. </td>
  67. </tr>
  68. </table>
  69. </div>
  70. </div>
  71. <a name="sec-includes"></a>
  72. <div class="info-box">
  73. <div class="info-box-title">Includes</div>
  74. <div class="nav-bar">
  75. <a href="#sec-description">Description</a> |
  76. <a href="#sec-classes">Classes</a>
  77. | <span class="disabled">Includes</span>
  78. | <a href="#sec-constants">Constants</a>
  79. | <a href="#sec-functions">Functions</a>
  80. </div>
  81. <div class="info-box-body">
  82. <a name="_Auth/OpenID_php"><!-- --></a>
  83. <div class="oddrow">
  84. <div>
  85. <span class="include-title">
  86. <span class="include-type">require_once</span>
  87. (<span class="include-name"><a href="../OpenID/_Auth---OpenID.php.html">'Auth/OpenID.php'</a></span>)
  88. (line <span class="line-number">12</span>)
  89. </span>
  90. </div>
  91. <!-- ========== Info from phpDoc block ========= -->
  92. <p class="short-description">Import tools needed to deal with messages.</p>
  93. </div>
  94. <a name="_Auth/OpenID/Consumer_php"><!-- --></a>
  95. <div class="evenrow">
  96. <div>
  97. <span class="include-title">
  98. <span class="include-type">require_once</span>
  99. (<span class="include-name"><a href="../OpenID/_Auth---OpenID---Consumer.php.html">'Auth/OpenID/Consumer.php'</a></span>)
  100. (line <span class="line-number">15</span>)
  101. </span>
  102. </div>
  103. <!-- ========== Info from phpDoc block ========= -->
  104. </div>
  105. <a name="_Auth/OpenID/KVForm_php"><!-- --></a>
  106. <div class="oddrow">
  107. <div>
  108. <span class="include-title">
  109. <span class="include-type">require_once</span>
  110. (<span class="include-name">'Auth/OpenID/KVForm.php'</span>)
  111. (line <span class="line-number">13</span>)
  112. </span>
  113. </div>
  114. <!-- ========== Info from phpDoc block ========= -->
  115. </div>
  116. <a name="_Auth/Yadis/XML_php"><!-- --></a>
  117. <div class="evenrow">
  118. <div>
  119. <span class="include-title">
  120. <span class="include-type">require_once</span>
  121. (<span class="include-name"><a href="../OpenID/_Auth---Yadis---XML.php.html">'Auth/Yadis/XML.php'</a></span>)
  122. (line <span class="line-number">14</span>)
  123. </span>
  124. </div>
  125. <!-- ========== Info from phpDoc block ========= -->
  126. </div>
  127. </div>
  128. </div>
  129. <a name="sec-constants"></a>
  130. <div class="info-box">
  131. <div class="info-box-title">Constants</div>
  132. <div class="nav-bar">
  133. <a href="#sec-description">Description</a> |
  134. <a href="#sec-classes">Classes</a>
  135. | <a href="#sec-includes">Includes</a>
  136. | <span class="disabled">Constants</span>
  137. | <a href="#sec-functions">Functions</a>
  138. </div>
  139. <div class="info-box-body">
  140. <a name="defineAuth_OpenID_BARE_NS"><!-- --></a>
  141. <div class="oddrow">
  142. <div>
  143. <span class="const-title">
  144. <span class="const-name">Auth_OpenID_BARE_NS</span> = 'Bare namespace'
  145. (line <span class="line-number">47</span>)
  146. </span>
  147. </div>
  148. <!-- ========== Info from phpDoc block ========= -->
  149. </div>
  150. <a name="defineAuth_OpenID_IDENTIFIER_SELECT"><!-- --></a>
  151. <div class="evenrow">
  152. <div>
  153. <span class="const-title">
  154. <span class="const-name">Auth_OpenID_IDENTIFIER_SELECT</span> = &quot;http://specs.openid.net/auth/2.0/identifier_select&quot;
  155. (line <span class="line-number">18</span>)
  156. </span>
  157. </div>
  158. <!-- ========== Info from phpDoc block ========= -->
  159. </div>
  160. <a name="defineAuth_OpenID_NO_DEFAULT"><!-- --></a>
  161. <div class="oddrow">
  162. <div>
  163. <span class="const-title">
  164. <span class="const-name">Auth_OpenID_NO_DEFAULT</span> = 'NO DEFAULT ALLOWED'
  165. (line <span class="line-number">51</span>)
  166. </span>
  167. </div>
  168. <!-- ========== Info from phpDoc block ========= -->
  169. </div>
  170. <a name="defineAuth_OpenID_NULL_NAMESPACE"><!-- --></a>
  171. <div class="evenrow">
  172. <div>
  173. <span class="const-title">
  174. <span class="const-name">Auth_OpenID_NULL_NAMESPACE</span> = 'Null namespace'
  175. (line <span class="line-number">40</span>)
  176. </span>
  177. </div>
  178. <!-- ========== Info from phpDoc block ========= -->
  179. </div>
  180. <a name="defineAuth_OpenID_OPENID1_NS"><!-- --></a>
  181. <div class="oddrow">
  182. <div>
  183. <span class="const-title">
  184. <span class="const-name">Auth_OpenID_OPENID1_NS</span> = 'http://openid.net/signon/1.0'
  185. (line <span class="line-number">26</span>)
  186. </span>
  187. </div>
  188. <!-- ========== Info from phpDoc block ========= -->
  189. </div>
  190. <a name="defineAuth_OpenID_OPENID1_URL_LIMIT"><!-- --></a>
  191. <div class="evenrow">
  192. <div>
  193. <span class="const-title">
  194. <span class="const-name">Auth_OpenID_OPENID1_URL_LIMIT</span> = 2047
  195. (line <span class="line-number">55</span>)
  196. </span>
  197. </div>
  198. <!-- ========== Info from phpDoc block ========= -->
  199. </div>
  200. <a name="defineAuth_OpenID_OPENID2_NS"><!-- --></a>
  201. <div class="oddrow">
  202. <div>
  203. <span class="const-title">
  204. <span class="const-name">Auth_OpenID_OPENID2_NS</span> = 'http://specs.openid.net/auth/2.0'
  205. (line <span class="line-number">36</span>)
  206. </span>
  207. </div>
  208. <!-- ========== Info from phpDoc block ========= -->
  209. </div>
  210. <a name="defineAuth_OpenID_OPENID_NS"><!-- --></a>
  211. <div class="evenrow">
  212. <div>
  213. <span class="const-title">
  214. <span class="const-name">Auth_OpenID_OPENID_NS</span> = 'OpenID namespace'
  215. (line <span class="line-number">43</span>)
  216. </span>
  217. </div>
  218. <!-- ========== Info from phpDoc block ========= -->
  219. </div>
  220. <a name="defineAuth_OpenID_SREG_URI"><!-- --></a>
  221. <div class="oddrow">
  222. <div>
  223. <span class="const-title">
  224. <span class="const-name">Auth_OpenID_SREG_URI</span> = 'http://openid.net/sreg/1.0'
  225. (line <span class="line-number">23</span>)
  226. </span>
  227. </div>
  228. <!-- ========== Info from phpDoc block ========= -->
  229. </div>
  230. <a name="defineAuth_OpenID_THE_OTHER_OPENID1_NS"><!-- --></a>
  231. <div class="evenrow">
  232. <div>
  233. <span class="const-title">
  234. <span class="const-name">Auth_OpenID_THE_OTHER_OPENID1_NS</span> = 'http://openid.net/signon/1.1'
  235. (line <span class="line-number">27</span>)
  236. </span>
  237. </div>
  238. <!-- ========== Info from phpDoc block ========= -->
  239. </div>
  240. </div>
  241. </div>
  242. <a name="sec-functions"></a>
  243. <div class="info-box">
  244. <div class="info-box-title">Functions</div>
  245. <div class="nav-bar">
  246. <a href="#sec-description">Description</a> |
  247. <a href="#sec-classes">Classes</a>
  248. | <a href="#sec-includes">Includes</a>
  249. | <a href="#sec-constants">Constants</a>
  250. | <span class="disabled">Functions</span>
  251. </div>
  252. <div class="info-box-body">
  253. <a name="functionAuth_OpenID_isOpenID1" id="functionAuth_OpenID_isOpenID1"><!-- --></a>
  254. <div class="oddrow">
  255. <div>
  256. <span class="method-title">Auth_OpenID_isOpenID1</span> (line <span class="line-number">29</span>)
  257. </div>
  258. <!-- ========== Info from phpDoc block ========= -->
  259. <div class="method-signature">
  260. <span class="method-result">void</span>
  261. <span class="method-name">
  262. Auth_OpenID_isOpenID1
  263. </span>
  264. (<span class="var-type"></span>&nbsp;<span class="var-name">$ns</span>)
  265. </div>
  266. <ul class="parameters">
  267. <li>
  268. <span class="var-type"></span>
  269. <span class="var-name">$ns</span> </li>
  270. </ul>
  271. </div>
  272. <a name="functionAuth_OpenID_registerNamespaceAlias" id="functionAuth_OpenID_registerNamespaceAlias"><!-- --></a>
  273. <div class="evenrow">
  274. <div>
  275. <span class="method-title">Auth_OpenID_registerNamespaceAlias</span> (line <span class="line-number">78</span>)
  276. </div>
  277. <!-- ========== Info from phpDoc block ========= -->
  278. <p class="short-description">Registers a (namespace URI, alias) mapping in a global namespace</p>
  279. <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>
  280. <div class="method-signature">
  281. <span class="method-result">void</span>
  282. <span class="method-name">
  283. Auth_OpenID_registerNamespaceAlias
  284. </span>
  285. (<span class="var-type"></span>&nbsp;<span class="var-name">$namespace_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$alias</span>)
  286. </div>
  287. <ul class="parameters">
  288. <li>
  289. <span class="var-type"></span>
  290. <span class="var-name">$namespace_uri</span> </li>
  291. <li>
  292. <span class="var-type"></span>
  293. <span class="var-name">$alias</span> </li>
  294. </ul>
  295. </div>
  296. <a name="functionAuth_OpenID_removeNamespaceAlias" id="functionAuth_OpenID_removeNamespaceAlias"><!-- --></a>
  297. <div class="oddrow">
  298. <div>
  299. <span class="method-title">Auth_OpenID_removeNamespaceAlias</span> (line <span class="line-number">105</span>)
  300. </div>
  301. <!-- ========== Info from phpDoc block ========= -->
  302. <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>
  303. <div class="method-signature">
  304. <span class="method-result">void</span>
  305. <span class="method-name">
  306. Auth_OpenID_removeNamespaceAlias
  307. </span>
  308. (<span class="var-type"></span>&nbsp;<span class="var-name">$namespace_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$alias</span>)
  309. </div>
  310. <ul class="parameters">
  311. <li>
  312. <span class="var-type"></span>
  313. <span class="var-name">$namespace_uri</span> </li>
  314. <li>
  315. <span class="var-type"></span>
  316. <span class="var-name">$alias</span> </li>
  317. </ul>
  318. </div>
  319. </div>
  320. </div>
  321. <p class="notes" id="credit">
  322. Documentation generated on Tue, 21 Apr 2009 11:31:31 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  323. </p>
  324. </div></body>
  325. </html>