_Auth---Yadis---XRDS.php.html 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  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 XRDS.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/Yadis/XRDS.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">This module contains the XRDS parsing code.</p>
  26. <p class="description"><p>PHP versions 4 and 5</p><p>LICENSE: See the COPYING file included in this distribution.</p></p>
  27. <ul class="tags">
  28. <li><span class="field">author:</span> JanRain, Inc. &lt;<a href="mailto:openid@janrain.com">openid@janrain.com</a>&gt;</li>
  29. <li><span class="field">copyright:</span> 2005-2008 Janrain, Inc.</li>
  30. <li><span class="field">license:</span> <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache</a></li>
  31. </ul>
  32. </div>
  33. </div>
  34. <a name="sec-classes"></a>
  35. <div class="info-box">
  36. <div class="info-box-title">Classes</div>
  37. <div class="nav-bar">
  38. <a href="#sec-description">Description</a> |
  39. <span class="disabled">Classes</span>
  40. | <a href="#sec-includes">Includes</a>
  41. | <a href="#sec-constants">Constants</a>
  42. | <a href="#sec-functions">Functions</a>
  43. </div>
  44. <div class="info-box-body">
  45. <table cellpadding="2" cellspacing="0" class="class-table">
  46. <tr>
  47. <th class="class-table-header">Class</th>
  48. <th class="class-table-header">Description</th>
  49. </tr>
  50. <tr>
  51. <td style="padding-right: 2em; vertical-align: top">
  52. <a href="../OpenID/Auth_Yadis_Service.html">Auth_Yadis_Service</a>
  53. </td>
  54. <td>
  55. This class represents a &lt;Service&gt; element in an XRDS document.
  56. </td>
  57. </tr>
  58. <tr>
  59. <td style="padding-right: 2em; vertical-align: top">
  60. <a href="../OpenID/Auth_Yadis_XRDS.html">Auth_Yadis_XRDS</a>
  61. </td>
  62. <td>
  63. This class performs parsing of XRDS documents.
  64. </td>
  65. </tr>
  66. </table>
  67. </div>
  68. </div>
  69. <a name="sec-includes"></a>
  70. <div class="info-box">
  71. <div class="info-box-title">Includes</div>
  72. <div class="nav-bar">
  73. <a href="#sec-description">Description</a> |
  74. <a href="#sec-classes">Classes</a>
  75. | <span class="disabled">Includes</span>
  76. | <a href="#sec-constants">Constants</a>
  77. | <a href="#sec-functions">Functions</a>
  78. </div>
  79. <div class="info-box-body">
  80. <a name="_Auth/Yadis/XML_php"><!-- --></a>
  81. <div class="oddrow">
  82. <div>
  83. <span class="include-title">
  84. <span class="include-type">require_once</span>
  85. (<span class="include-name"><a href="../OpenID/_Auth---Yadis---XML.php.html">'Auth/Yadis/XML.php'</a></span>)
  86. (line <span class="line-number">19</span>)
  87. </span>
  88. </div>
  89. <!-- ========== Info from phpDoc block ========= -->
  90. <p class="short-description">Require the XPath implementation.</p>
  91. </div>
  92. </div>
  93. </div>
  94. <a name="sec-constants"></a>
  95. <div class="info-box">
  96. <div class="info-box-title">Constants</div>
  97. <div class="nav-bar">
  98. <a href="#sec-description">Description</a> |
  99. <a href="#sec-classes">Classes</a>
  100. | <a href="#sec-includes">Includes</a>
  101. | <span class="disabled">Constants</span>
  102. | <a href="#sec-functions">Functions</a>
  103. </div>
  104. <div class="info-box-body">
  105. <a name="defineAuth_Yadis_XMLNS_XRDS"><!-- --></a>
  106. <div class="evenrow">
  107. <div>
  108. <span class="const-title">
  109. <span class="const-name">Auth_Yadis_XMLNS_XRDS</span> = 'xri://$xrds'
  110. (line <span class="line-number">47</span>)
  111. </span>
  112. </div>
  113. <!-- ========== Info from phpDoc block ========= -->
  114. <p class="short-description">XRDS XML namespace</p>
  115. </div>
  116. <a name="defineAuth_Yadis_XMLNS_XRD_2_0"><!-- --></a>
  117. <div class="oddrow">
  118. <div>
  119. <span class="const-title">
  120. <span class="const-name">Auth_Yadis_XMLNS_XRD_2_0</span> = 'xri://$xrd*($v*2.0)'
  121. (line <span class="line-number">42</span>)
  122. </span>
  123. </div>
  124. <!-- ========== Info from phpDoc block ========= -->
  125. <p class="short-description">XRD XML namespace</p>
  126. </div>
  127. <a name="defineSERVICES_YADIS_MATCH_ALL"><!-- --></a>
  128. <div class="evenrow">
  129. <div>
  130. <span class="const-title">
  131. <span class="const-name">SERVICES_YADIS_MATCH_ALL</span> = 101
  132. (line <span class="line-number">25</span>)
  133. </span>
  134. </div>
  135. <!-- ========== Info from phpDoc block ========= -->
  136. <p class="short-description">This match mode means a given service must match ALL filters passed to the Auth_Yadis_XRDS::services() call.</p>
  137. </div>
  138. <a name="defineSERVICES_YADIS_MATCH_ANY"><!-- --></a>
  139. <div class="oddrow">
  140. <div>
  141. <span class="const-title">
  142. <span class="const-name">SERVICES_YADIS_MATCH_ANY</span> = 102
  143. (line <span class="line-number">31</span>)
  144. </span>
  145. </div>
  146. <!-- ========== Info from phpDoc block ========= -->
  147. <p class="short-description">This match mode means a given service must match ANY filters (at least one) passed to the Auth_Yadis_XRDS::services() call.</p>
  148. </div>
  149. <a name="defineSERVICES_YADIS_MAX_PRIORITY"><!-- --></a>
  150. <div class="evenrow">
  151. <div>
  152. <span class="const-title">
  153. <span class="const-name">SERVICES_YADIS_MAX_PRIORITY</span> = pow(2,30)
  154. (line <span class="line-number">37</span>)
  155. </span>
  156. </div>
  157. <!-- ========== Info from phpDoc block ========= -->
  158. <p class="short-description">The priority value used for service elements with no priority specified.</p>
  159. </div>
  160. </div>
  161. </div>
  162. <a name="sec-functions"></a>
  163. <div class="info-box">
  164. <div class="info-box-title">Functions</div>
  165. <div class="nav-bar">
  166. <a href="#sec-description">Description</a> |
  167. <a href="#sec-classes">Classes</a>
  168. | <a href="#sec-includes">Includes</a>
  169. | <a href="#sec-constants">Constants</a>
  170. | <span class="disabled">Functions</span>
  171. </div>
  172. <div class="info-box-body">
  173. <a name="functionAuth_Yadis_getNSMap" id="functionAuth_Yadis_getNSMap"><!-- --></a>
  174. <div class="oddrow">
  175. <div>
  176. <span class="method-title">Auth_Yadis_getNSMap</span> (line <span class="line-number">49</span>)
  177. </div>
  178. <!-- ========== Info from phpDoc block ========= -->
  179. <div class="method-signature">
  180. <span class="method-result">void</span>
  181. <span class="method-name">
  182. Auth_Yadis_getNSMap
  183. </span>
  184. ()
  185. </div>
  186. </div>
  187. <a name="functionAuth_Yadis_getXRDExpiration" id="functionAuth_Yadis_getXRDExpiration"><!-- --></a>
  188. <div class="evenrow">
  189. <div>
  190. <span class="method-title">Auth_Yadis_getXRDExpiration</span> (line <span class="line-number">214</span>)
  191. </div>
  192. <!-- ========== Info from phpDoc block ========= -->
  193. <div class="method-signature">
  194. <span class="method-result">void</span>
  195. <span class="method-name">
  196. Auth_Yadis_getXRDExpiration
  197. </span>
  198. (<span class="var-type"></span>&nbsp;<span class="var-name">$xrd_element</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
  199. </div>
  200. <ul class="parameters">
  201. <li>
  202. <span class="var-type"></span>
  203. <span class="var-name">$xrd_element</span> </li>
  204. <li>
  205. <span class="var-type"></span>
  206. <span class="var-name">$default</span> </li>
  207. </ul>
  208. </div>
  209. </div>
  210. </div>
  211. <p class="notes" id="credit">
  212. Documentation generated on Tue, 21 Apr 2009 11:31:33 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  213. </p>
  214. </div></body>
  215. </html>