Auth_OpenID_AX_AttrInfo.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  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_OpenID_AX_AttrInfo</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_OpenID_AX_AttrInfo</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">Represents a single attribute in an attribute exchange request. This should be added to an AXRequest object in order to request the attribute.</p>
  23. <p class="notes">
  24. Located in <a class="field" href="_Auth---OpenID---AX.php.html">/Auth/OpenID/AX.php</a> (line <span class="field">139</span>)
  25. </p>
  26. <pre></pre>
  27. </div>
  28. </div>
  29. <a name="sec-method-summary"></a>
  30. <div class="info-box">
  31. <div class="info-box-title">Method Summary</span></div>
  32. <div class="nav-bar">
  33. <a href="#sec-description">Description</a> |
  34. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  35. </div>
  36. <div class="info-box-body">
  37. <div class="method-summary">
  38. <div class="method-definition">
  39. <span class="method-result">Auth_OpenID_AX_AttrInfo</span>
  40. <a href="#Auth_OpenID_AX_AttrInfo" title="details" class="method-name">Auth_OpenID_AX_AttrInfo</a>
  41. (<span class="var-type">string</span>&nbsp;<span class="var-name">$type_uri</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$alias</span>)
  42. </div>
  43. <div class="method-definition">
  44. <span class="method-result">void</span>
  45. <a href="#make" title="details" class="method-name">make</a>
  46. (<span class="var-type"></span>&nbsp;<span class="var-name">$type_uri</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">1</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$alias</span> = <span class="var-default">null</span>])
  47. </div>
  48. <div class="method-definition">
  49. <span class="method-result">void</span>
  50. <a href="#wantsUnlimitedValues" title="details" class="method-name">wantsUnlimitedValues</a>
  51. ()
  52. </div>
  53. </div>
  54. </div>
  55. </div>
  56. <a name="sec-methods"></a>
  57. <div class="info-box">
  58. <div class="info-box-title">Methods</div>
  59. <div class="nav-bar">
  60. <a href="#sec-description">Description</a> |
  61. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  62. </div>
  63. <div class="info-box-body">
  64. <A NAME='method_detail'></A>
  65. <a name="methodAuth_OpenID_AX_AttrInfo" id="Auth_OpenID_AX_AttrInfo"><!-- --></a>
  66. <div class="oddrow">
  67. <div class="method-header">
  68. <span class="method-title">Constructor Auth_OpenID_AX_AttrInfo</span> (line <span class="line-number">154</span>)
  69. </div>
  70. <!-- ========== Info from phpDoc block ========= -->
  71. <p class="short-description">Construct an attribute information object. Do not call this directly; call make(...) instead.</p>
  72. <div class="method-signature">
  73. <span class="method-result">Auth_OpenID_AX_AttrInfo</span>
  74. <span class="method-name">
  75. Auth_OpenID_AX_AttrInfo
  76. </span>
  77. (<span class="var-type">string</span>&nbsp;<span class="var-name">$type_uri</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$alias</span>)
  78. </div>
  79. <ul class="parameters">
  80. <li>
  81. <span class="var-type">string</span>
  82. <span class="var-name">$type_uri</span><span class="var-description">: The type URI for this attribute.</span> </li>
  83. <li>
  84. <span class="var-type">int</span>
  85. <span class="var-name">$count</span><span class="var-description">: The number of values of this type to request.</span> </li>
  86. <li>
  87. <span class="var-type">bool</span>
  88. <span class="var-name">$required</span><span class="var-description">: Whether the attribute will be marked as required in the request.</span> </li>
  89. <li>
  90. <span class="var-type">string</span>
  91. <span class="var-name">$alias</span><span class="var-description">: The name that should be given to this attribute in the request.</span> </li>
  92. </ul>
  93. </div>
  94. <a name="methodmake" id="make"><!-- --></a>
  95. <div class="evenrow">
  96. <div class="method-header">
  97. <span class="method-title">make</span> (line <span class="line-number">194</span>)
  98. </div>
  99. <!-- ========== Info from phpDoc block ========= -->
  100. <p class="short-description">Construct an attribute information object. For parameter details, see the constructor.</p>
  101. <div class="method-signature">
  102. <span class="method-result">void</span>
  103. <span class="method-name">
  104. make
  105. </span>
  106. (<span class="var-type"></span>&nbsp;<span class="var-name">$type_uri</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">1</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$alias</span> = <span class="var-default">null</span>])
  107. </div>
  108. <ul class="parameters">
  109. <li>
  110. <span class="var-type"></span>
  111. <span class="var-name">$type_uri</span> </li>
  112. <li>
  113. <span class="var-type"></span>
  114. <span class="var-name">$count</span> </li>
  115. <li>
  116. <span class="var-type"></span>
  117. <span class="var-name">$required</span> </li>
  118. <li>
  119. <span class="var-type"></span>
  120. <span class="var-name">$alias</span> </li>
  121. </ul>
  122. </div>
  123. <a name="methodwantsUnlimitedValues" id="wantsUnlimitedValues"><!-- --></a>
  124. <div class="oddrow">
  125. <div class="method-header">
  126. <span class="method-title">wantsUnlimitedValues</span> (line <span class="line-number">216</span>)
  127. </div>
  128. <!-- ========== Info from phpDoc block ========= -->
  129. <p class="short-description">When processing a request for this attribute, the OP should</p>
  130. <p class="description"><p>call this method to determine whether all available attribute values were requested. If self.count == UNLIMITED_VALUES, this returns True. Otherwise this returns False, in which case self.count is an integer.</p></p>
  131. <div class="method-signature">
  132. <span class="method-result">void</span>
  133. <span class="method-name">
  134. wantsUnlimitedValues
  135. </span>
  136. ()
  137. </div>
  138. </div>
  139. </div>
  140. </div>
  141. <p class="notes" id="credit">
  142. Documentation generated on Tue, 21 Apr 2009 11:31:29 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  143. </p>
  144. </div></body>
  145. </html>