Home Explore Help
Sign In
usic
/
ums
Watch 2
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
ums
/
lib
/
php-openid
/
doc
/
OpenID
/
Auth_OpenID_AX_AttrInfo.html

Auth_OpenID_AX_AttrInfo.html 7.7 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 
  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos -->
    6. 

  6. 			<title>Docs For Class Auth_OpenID_AX_AttrInfo</title>
    7. 

  7. 			<link rel="stylesheet" href="../media/stylesheet.css" />
    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9. 

  9. 		</head>
    10. 

  10. 		<body>
    11. 

  11. 			<div class="page-body">			
    12. 

  12. <h2 class="class-name">Class Auth_OpenID_AX_AttrInfo</h2>
    13. 

  13. 

  14. <a name="sec-description"></a>
    15. 

  15. <div class="info-box">
    16. 

  16. 	<div class="info-box-title">Description</div>
    17. 

  17. 	<div class="nav-bar">
    18. 

  18. 					<span class="disabled">Description</span> |
    19. 

  19. 															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    20. 

  20. 						
    21. 

  21. 					</div>
    22. 

  22. 	<div class="info-box-body">
    23. 

  23.         		<!-- ========== Info from phpDoc block ========= -->
    24. 

  24. <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>
    25. 

  25. 		<p class="notes">
    26. 

  26. 			Located in <a class="field" href="_Auth---OpenID---AX.php.html">/Auth/OpenID/AX.php</a> (line <span class="field">139</span>)
    27. 

  27. 		</p>
    28. 

  28. 		
    29. 

  29. 				
    30. 

  30. 		<pre></pre>
    31. 

  31. 	
    32. 

  32. 			</div>
    33. 

  33. </div>
    34. 

  34. 

  35. 

  36. 

  37. 

  38. 	<a name="sec-method-summary"></a>
    39. 

  39. 	<div class="info-box">
    40. 

  40. 		<div class="info-box-title">Method Summary</span></div>
    41. 

  41. 		<div class="nav-bar">
    42. 

  42. 			<a href="#sec-description">Description</a> |
    43. 

  43. 												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    44. 

  44. 		</div>
    45. 

  45. 		<div class="info-box-body">			
    46. 

  46. 			<div class="method-summary">
    47. 

  47. 																																						
    48. 

  48. 				<div class="method-definition">
    49. 

  49. 											<span class="method-result">Auth_OpenID_AX_AttrInfo</span>
    50. 

  50. 										<a href="#Auth_OpenID_AX_AttrInfo" title="details" class="method-name">Auth_OpenID_AX_AttrInfo</a>
    51. 

  51. 											(<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>)
    52. 

  52. 									</div>
    53. 

  53. 														
    54. 

  54. 				<div class="method-definition">
    55. 

  55. 											<span class="method-result">void</span>
    56. 

  56. 										<a href="#make" title="details" class="method-name">make</a>
    57. 

  57. 											(<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>])
    58. 

  58. 									</div>
    59. 

  59. 														
    60. 

  60. 				<div class="method-definition">
    61. 

  61. 											<span class="method-result">void</span>
    62. 

  62. 										<a href="#wantsUnlimitedValues" title="details" class="method-name">wantsUnlimitedValues</a>
    63. 

  63. 										()
    64. 

  64. 									</div>
    65. 

  65. 											</div>
    66. 

  66. 		</div>
    67. 

  67. 	</div>		
    68. 

  68. 

  69. 	
    70. 

  70. 	<a name="sec-methods"></a>
    71. 

  71. 	<div class="info-box">
    72. 

  72. 		<div class="info-box-title">Methods</div>
    73. 

  73. 		<div class="nav-bar">
    74. 

  74. 			<a href="#sec-description">Description</a> |
    75. 

  75. 																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    76. 

  76. 						
    77. 

  77. 		</div>
    78. 

  78. 		<div class="info-box-body">
    79. 

  79. 			<A NAME='method_detail'></A>
    80. 

  80. <a name="methodAuth_OpenID_AX_AttrInfo" id="Auth_OpenID_AX_AttrInfo"><!-- --></a>
    81. 

  81. <div class="oddrow">
    82. 

  82. 	
    83. 

  83. 	<div class="method-header">
    84. 

  84. 		<span class="method-title">Constructor Auth_OpenID_AX_AttrInfo</span> (line <span class="line-number">154</span>)
    85. 

  85. 	</div> 
    86. 

  86. 	
    87. 

  87. 	<!-- ========== Info from phpDoc block ========= -->
    88. 

  88. <p class="short-description">Construct an attribute information object.  Do not call this  directly; call make(...) instead.</p>
    89. 

  89. 	
    90. 

  90. 	<div class="method-signature">
    91. 

  91. 		<span class="method-result">Auth_OpenID_AX_AttrInfo</span>
    92. 

  92. 		<span class="method-name">
    93. 

  93. 			Auth_OpenID_AX_AttrInfo
    94. 

  94. 		</span>
    95. 

  95. 					(<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>)
    96. 

  96. 			</div>
    97. 

  97. 	
    98. 

  98. 			<ul class="parameters">
    99. 

  99. 					<li>
    100. 

  100. 				<span class="var-type">string</span>
    101. 

  101. 				<span class="var-name">$type_uri</span><span class="var-description">: The type URI for this attribute.</span>			</li>
    102. 

  102. 					<li>
    103. 

  103. 				<span class="var-type">int</span>
    104. 

  104. 				<span class="var-name">$count</span><span class="var-description">: The number of values of this type to request.</span>			</li>
    105. 

  105. 					<li>
    106. 

  106. 				<span class="var-type">bool</span>
    107. 

  107. 				<span class="var-name">$required</span><span class="var-description">: Whether the attribute will be marked as  required in the request.</span>			</li>
    108. 

  108. 					<li>
    109. 

  109. 				<span class="var-type">string</span>
    110. 

  110. 				<span class="var-name">$alias</span><span class="var-description">: The name that should be given to this  attribute in the request.</span>			</li>
    111. 

  111. 				</ul>
    112. 

  112. 		
    113. 

  113. 			
    114. 

  114. 	</div>
    115. 

  115. <a name="methodmake" id="make"><!-- --></a>
    116. 

  116. <div class="evenrow">
    117. 

  117. 	
    118. 

  118. 	<div class="method-header">
    119. 

  119. 		<span class="method-title">make</span> (line <span class="line-number">194</span>)
    120. 

  120. 	</div> 
    121. 

  121. 	
    122. 

  122. 	<!-- ========== Info from phpDoc block ========= -->
    123. 

  123. <p class="short-description">Construct an attribute information object.  For parameter  details, see the constructor.</p>
    124. 

  124. 	
    125. 

  125. 	<div class="method-signature">
    126. 

  126. 		<span class="method-result">void</span>
    127. 

  127. 		<span class="method-name">
    128. 

  128. 			make
    129. 

  129. 		</span>
    130. 

  130. 					(<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>])
    131. 

  131. 			</div>
    132. 

  132. 	
    133. 

  133. 			<ul class="parameters">
    134. 

  134. 					<li>
    135. 

  135. 				<span class="var-type"></span>
    136. 

  136. 				<span class="var-name">$type_uri</span>			</li>
    137. 

  137. 					<li>
    138. 

  138. 				<span class="var-type"></span>
    139. 

  139. 				<span class="var-name">$count</span>			</li>
    140. 

  140. 					<li>
    141. 

  141. 				<span class="var-type"></span>
    142. 

  142. 				<span class="var-name">$required</span>			</li>
    143. 

  143. 					<li>
    144. 

  144. 				<span class="var-type"></span>
    145. 

  145. 				<span class="var-name">$alias</span>			</li>
    146. 

  146. 				</ul>
    147. 

  147. 		
    148. 

  148. 			
    149. 

  149. 	</div>
    150. 

  150. <a name="methodwantsUnlimitedValues" id="wantsUnlimitedValues"><!-- --></a>
    151. 

  151. <div class="oddrow">
    152. 

  152. 	
    153. 

  153. 	<div class="method-header">
    154. 

  154. 		<span class="method-title">wantsUnlimitedValues</span> (line <span class="line-number">216</span>)
    155. 

  155. 	</div> 
    156. 

  156. 	
    157. 

  157. 	<!-- ========== Info from phpDoc block ========= -->
    158. 

  158. <p class="short-description">When processing a request for this attribute, the OP should</p>
    159. 

  159. <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>
    160. 

  160. 	
    161. 

  161. 	<div class="method-signature">
    162. 

  162. 		<span class="method-result">void</span>
    163. 

  163. 		<span class="method-name">
    164. 

  164. 			wantsUnlimitedValues
    165. 

  165. 		</span>
    166. 

  166. 				()
    167. 

  167. 			</div>
    168. 

  168. 	
    169. 

  169. 		
    170. 

  170. 			
    171. 

  171. 	</div>
    172. 

  172. 						
    173. 

  173. 		</div>
    174. 

  174. 	</div>
    175. 

  175. 

  176. 

  177. 	<p class="notes" id="credit">
    178. 

  178. 		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>
    179. 

  179. 	</p>
    180. 

  180. 	</div></body>
    181. 

  181. </html>
    182.