Auth_Yadis_Service.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  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 Class Auth_Yadis_Service</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="class-name">Class Auth_Yadis_Service</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  19. </div>
  20. <div class="info-box-body">
  21. <!-- ========== Info from phpDoc block ========= -->
  22. <p class="short-description">This class represents a &lt;Service&gt; element in an XRDS document.</p>
  23. <p class="description"><p>Objects of this type are returned by Auth_Yadis_XRDS::services() and Auth_Yadis_Yadis::services(). Each object corresponds directly to a &lt;Service&gt; element in the XRDS and supplies a getElements($name) method which you should use to inspect the element's contents. See <a href="../OpenID/Auth_Yadis_Yadis.html">Auth_Yadis_Yadis</a> for more information on the role this class plays in Yadis discovery.</p></p>
  24. <p class="notes">
  25. Located in <a class="field" href="_Auth---Yadis---XRDS.php.html">/Auth/Yadis/XRDS.php</a> (line <span class="field">83</span>)
  26. </p>
  27. <pre></pre>
  28. </div>
  29. </div>
  30. <a name="sec-method-summary"></a>
  31. <div class="info-box">
  32. <div class="info-box-title">Method Summary</span></div>
  33. <div class="nav-bar">
  34. <a href="#sec-description">Description</a> |
  35. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  36. </div>
  37. <div class="info-box-body">
  38. <div class="method-summary">
  39. <div class="method-definition">
  40. <span class="method-result">Auth_Yadis_Service</span>
  41. <a href="#Auth_Yadis_Service" title="details" class="method-name">Auth_Yadis_Service</a>
  42. ()
  43. </div>
  44. <div class="method-definition">
  45. <span class="method-result">array</span>
  46. <a href="#getElements" title="details" class="method-name">getElements</a>
  47. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
  48. </div>
  49. <div class="method-definition">
  50. <span class="method-result">mixed</span>
  51. <a href="#getPriority" title="details" class="method-name">getPriority</a>
  52. ()
  53. </div>
  54. <div class="method-definition">
  55. <span class="method-result">array</span>
  56. <a href="#getTypes" title="details" class="method-name">getTypes</a>
  57. ()
  58. </div>
  59. <div class="method-definition">
  60. <span class="method-result">array</span>
  61. <a href="#getURIs" title="details" class="method-name">getURIs</a>
  62. ()
  63. </div>
  64. <div class="method-definition">
  65. <span class="method-result">void</span>
  66. <a href="#matchTypes" title="details" class="method-name">matchTypes</a>
  67. (<span class="var-type"></span>&nbsp;<span class="var-name">$type_uris</span>)
  68. </div>
  69. </div>
  70. </div>
  71. </div>
  72. <a name="sec-methods"></a>
  73. <div class="info-box">
  74. <div class="info-box-title">Methods</div>
  75. <div class="nav-bar">
  76. <a href="#sec-description">Description</a> |
  77. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  78. </div>
  79. <div class="info-box-body">
  80. <A NAME='method_detail'></A>
  81. <a name="methodAuth_Yadis_Service" id="Auth_Yadis_Service"><!-- --></a>
  82. <div class="evenrow">
  83. <div class="method-header">
  84. <span class="method-title">Constructor Auth_Yadis_Service</span> (line <span class="line-number">88</span>)
  85. </div>
  86. <!-- ========== Info from phpDoc block ========= -->
  87. <p class="short-description">Creates an empty service object.</p>
  88. <div class="method-signature">
  89. <span class="method-result">Auth_Yadis_Service</span>
  90. <span class="method-name">
  91. Auth_Yadis_Service
  92. </span>
  93. ()
  94. </div>
  95. </div>
  96. <a name="methodgetElements" id="getElements"><!-- --></a>
  97. <div class="oddrow">
  98. <div class="method-header">
  99. <span class="method-title">getElements</span> (line <span class="line-number">201</span>)
  100. </div>
  101. <!-- ========== Info from phpDoc block ========= -->
  102. <p class="short-description">Used to get XML elements from this object's &lt;Service&gt; element.</p>
  103. <p class="description"><p>This is what you should use to get all custom information out of this element. This is used by service filter functions to determine whether a service element contains specific tags, etc. NOTE: this only considers elements which are direct children of the &lt;Service&gt; element for this object.</p></p>
  104. <ul class="tags">
  105. <li><span class="field">return:</span> An array of elements with the specified name which are direct children of the &lt;Service&gt; element. The nodes returned by this function can be passed to $this-&gt;parser methods (see <a href="../OpenID/Auth_Yadis_XMLParser.html">Auth_Yadis_XMLParser</a>).</li>
  106. </ul>
  107. <div class="method-signature">
  108. <span class="method-result">array</span>
  109. <span class="method-name">
  110. getElements
  111. </span>
  112. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
  113. </div>
  114. <ul class="parameters">
  115. <li>
  116. <span class="var-type">string</span>
  117. <span class="var-name">$name</span><span class="var-description">: The name of the element to look for</span> </li>
  118. </ul>
  119. </div>
  120. <a name="methodgetPriority" id="getPriority"><!-- --></a>
  121. <div class="evenrow">
  122. <div class="method-header">
  123. <span class="method-title">getPriority</span> (line <span class="line-number">175</span>)
  124. </div>
  125. <!-- ========== Info from phpDoc block ========= -->
  126. <p class="short-description">Returns the &quot;priority&quot; attribute value of this &lt;Service&gt; element, if the attribute is present. Returns null if not.</p>
  127. <ul class="tags">
  128. <li><span class="field">return:</span> Null or integer, depending on whether this Service element has a 'priority' attribute.</li>
  129. </ul>
  130. <div class="method-signature">
  131. <span class="method-result">mixed</span>
  132. <span class="method-name">
  133. getPriority
  134. </span>
  135. ()
  136. </div>
  137. </div>
  138. <a name="methodgetTypes" id="getTypes"><!-- --></a>
  139. <div class="oddrow">
  140. <div class="method-header">
  141. <span class="method-title">getTypes</span> (line <span class="line-number">100</span>)
  142. </div>
  143. <!-- ========== Info from phpDoc block ========= -->
  144. <p class="short-description">Return the URIs in the &quot;Type&quot; elements, if any, of this Service element.</p>
  145. <ul class="tags">
  146. <li><span class="field">return:</span> An array of Type URI strings.</li>
  147. </ul>
  148. <div class="method-signature">
  149. <span class="method-result">array</span>
  150. <span class="method-name">
  151. getTypes
  152. </span>
  153. ()
  154. </div>
  155. </div>
  156. <a name="methodgetURIs" id="getURIs"><!-- --></a>
  157. <div class="evenrow">
  158. <div class="method-header">
  159. <span class="method-title">getURIs</span> (line <span class="line-number">131</span>)
  160. </div>
  161. <!-- ========== Info from phpDoc block ========= -->
  162. <p class="short-description">Return the URIs in the &quot;URI&quot; elements, if any, of this Service element. The URIs are returned sorted in priority order.</p>
  163. <ul class="tags">
  164. <li><span class="field">return:</span> An array of URI strings.</li>
  165. </ul>
  166. <div class="method-signature">
  167. <span class="method-result">array</span>
  168. <span class="method-name">
  169. getURIs
  170. </span>
  171. ()
  172. </div>
  173. </div>
  174. <a name="methodmatchTypes" id="matchTypes"><!-- --></a>
  175. <div class="oddrow">
  176. <div class="method-header">
  177. <span class="method-title">matchTypes</span> (line <span class="line-number">112</span>)
  178. </div>
  179. <!-- ========== Info from phpDoc block ========= -->
  180. <div class="method-signature">
  181. <span class="method-result">void</span>
  182. <span class="method-name">
  183. matchTypes
  184. </span>
  185. (<span class="var-type"></span>&nbsp;<span class="var-name">$type_uris</span>)
  186. </div>
  187. <ul class="parameters">
  188. <li>
  189. <span class="var-type"></span>
  190. <span class="var-name">$type_uris</span> </li>
  191. </ul>
  192. </div>
  193. </div>
  194. </div>
  195. <p class="notes" id="credit">
  196. 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>
  197. </p>
  198. </div></body>
  199. </html>