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_ConsumerResponse.html

Auth_OpenID_ConsumerResponse.html 9.3 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253 
  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_ConsumerResponse</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_ConsumerResponse</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-descendents">Descendents</a>
    20. 

  20. 			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    21. 

  21. 						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    22. 

  22. 						
    23. 

  23. 					</div>
    24. 

  24. 	<div class="info-box-body">
    25. 

  25.         		<!-- ========== Info from phpDoc block ========= -->
    26. 

  26. <p class="short-description">The base class for responses from the Auth_OpenID_Consumer.</p>
    27. 

  27. 		<p class="notes">
    28. 

  28. 			Located in <a class="field" href="_Auth---OpenID---Consumer.php.html">/Auth/OpenID/Consumer.php</a> (line <span class="field">1970</span>)
    29. 

  29. 		</p>
    30. 

  30. 		
    31. 

  31. 				
    32. 

  32. 		<pre></pre>
    33. 

  33. 	
    34. 

  34. 			</div>
    35. 

  35. </div>
    36. 

  36. 

  37. 	<a name="sec-descendents"></a>
    38. 

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

  39. 		<div class="info-box-title">Direct descendents</div>
    40. 

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

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

  42. 			<span class="disabled">Descendents</span>
    43. 

  43. 			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    44. 

  44. 								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    45. 

  45. 							
    46. 

  46. 								</div>
    47. 

  47. 		<div class="info-box-body">
    48. 

  48. 			<table cellpadding="2" cellspacing="0" class="class-table">
    49. 

  49. 				<tr>
    50. 

  50. 					<th class="class-table-header">Class</th>
    51. 

  51. 					<th class="class-table-header">Description</th>
    52. 

  52. 				</tr>
    53. 

  53. 								<tr>
    54. 

  54. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_SuccessResponse.html">Auth_OpenID_SuccessResponse</a></td>
    55. 

  55. 					<td>
    56. 

  56. 											A response with a status of Auth_OpenID_SUCCESS. Indicates that
    57. 

  57. 										</td>
    58. 

  58. 				</tr>
    59. 

  59. 								<tr>
    60. 

  60. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_FailureResponse.html">Auth_OpenID_FailureResponse</a></td>
    61. 

  61. 					<td>
    62. 

  62. 											A response with a status of Auth_OpenID_FAILURE. Indicates that the  OpenID protocol has failed. This could be locally or remotely  triggered.  This has three relevant attributes:
    63. 

  63. 										</td>
    64. 

  64. 				</tr>
    65. 

  65. 								<tr>
    66. 

  66. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_CancelResponse.html">Auth_OpenID_CancelResponse</a></td>
    67. 

  67. 					<td>
    68. 

  68. 											A response with a status of Auth_OpenID_CANCEL. Indicates that the  user cancelled the OpenID authentication request.  This has two  relevant attributes:
    69. 

  69. 										</td>
    70. 

  70. 				</tr>
    71. 

  71. 								<tr>
    72. 

  72. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_SetupNeededResponse.html">Auth_OpenID_SetupNeededResponse</a></td>
    73. 

  73. 					<td>
    74. 

  74. 											A response with a status of Auth_OpenID_SETUP_NEEDED. Indicates  that the request was in immediate mode, and the server is unable to  authenticate the user without further interaction.
    75. 

  75. 										</td>
    76. 

  76. 				</tr>
    77. 

  77. 							</table>
    78. 

  78. 		</div>
    79. 

  79. 	</div>
    80. 

  80. 

  81. 

  82. 	<a name="sec-var-summary"></a>
    83. 

  83. 	<div class="info-box">
    84. 

  84. 		<div class="info-box-title">Variable Summary</span></div>
    85. 

  85. 		<div class="nav-bar">
    86. 

  86. 			<a href="#sec-description">Description</a> |
    87. 

  87. 							<a href="#sec-descendents">Descendents</a> |
    88. 

  88. 						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
    89. 

  89. 							| 
    90. 

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

  91. 							
    92. 

  92. 								</div>
    93. 

  93. 		<div class="info-box-body">
    94. 

  94. 			<div class="var-summary">
    95. 

  95. 																								<div class="var-title">
    96. 

  96. 					<span class="var-type">mixed</span>
    97. 

  97. 					<a href="#$status" title="details" class="var-name">$status</a>
    98. 

  98. 				</div>
    99. 

  99. 											</div>
    100. 

  100. 		</div>
    101. 

  101. 	</div>
    102. 

  102. 

  103. 	<a name="sec-method-summary"></a>
    104. 

  104. 	<div class="info-box">
    105. 

  105. 		<div class="info-box-title">Method Summary</span></div>
    106. 

  106. 		<div class="nav-bar">
    107. 

  107. 			<a href="#sec-description">Description</a> |
    108. 

  108. 							<a href="#sec-descendents">Descendents</a> |
    109. 

  109. 																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    110. 

  110. 				 
    111. 

  111. 				|
    112. 

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

  113. 		</div>
    114. 

  114. 		<div class="info-box-body">			
    115. 

  115. 			<div class="method-summary">
    116. 

  116. 																														
    117. 

  117. 				<div class="method-definition">
    118. 

  118. 											<span class="method-result">void</span>
    119. 

  119. 										<a href="#getDisplayIdentifier" title="details" class="method-name">getDisplayIdentifier</a>
    120. 

  120. 										()
    121. 

  121. 									</div>
    122. 

  122. 														
    123. 

  123. 				<div class="method-definition">
    124. 

  124. 											<span class="method-result">void</span>
    125. 

  125. 										<a href="#setEndpoint" title="details" class="method-name">setEndpoint</a>
    126. 

  126. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$endpoint</span>)
    127. 

  127. 									</div>
    128. 

  128. 											</div>
    129. 

  129. 		</div>
    130. 

  130. 	</div>		
    131. 

  131. 

  132. 	<a name="sec-vars"></a>
    133. 

  133. 	<div class="info-box">
    134. 

  134. 		<div class="info-box-title">Variables</div>
    135. 

  135. 		<div class="nav-bar">
    136. 

  136. 			<a href="#sec-description">Description</a> |
    137. 

  137. 							<a href="#sec-descendents">Descendents</a> |
    138. 

  138. 										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
    139. 

  139. 						
    140. 

  140. 			
    141. 

  141. 										| 
    142. 

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

  143. 							
    144. 

  144. 					</div>
    145. 

  145. 		<div class="info-box-body">
    146. 

  146. 			
    147. 

  147. <a name="var$status" id="$status"><!-- --></A>
    148. 

  148. <div class="oddrow">
    149. 

  149. 

  150. 	<div class="var-header">
    151. 

  151. 		<span class="var-title">
    152. 

  152. 			<span class="var-type">mixed</span>
    153. 

  153. 			<span class="var-name">$status</span>
    154. 

  154. 			 = <span class="var-default"> null</span>			(line <span class="line-number">1971</span>)
    155. 

  155. 		</span>
    156. 

  156. 	</div>
    157. 

  157. 

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

  159. 	
    160. 

  160. 	
    161. 

  161. 		
    162. 

  162. 			<hr class="separator" />
    163. 

  163. 		<div class="notes">Redefined in descendants as:</div>
    164. 

  164. 		<ul class="redefinitions">
    165. 

  165. 					<li>
    166. 

  166. 				<a href="../OpenID/Auth_OpenID_SuccessResponse.html#var$status">Auth_OpenID_SuccessResponse::$status</a>
    167. 

  167. 							</li>
    168. 

  168. 					<li>
    169. 

  169. 				<a href="../OpenID/Auth_OpenID_FailureResponse.html#var$status">Auth_OpenID_FailureResponse::$status</a>
    170. 

  170. 							</li>
    171. 

  171. 					<li>
    172. 

  172. 				<a href="../OpenID/Auth_OpenID_CancelResponse.html#var$status">Auth_OpenID_CancelResponse::$status</a>
    173. 

  173. 							</li>
    174. 

  174. 					<li>
    175. 

  175. 				<a href="../OpenID/Auth_OpenID_SetupNeededResponse.html#var$status">Auth_OpenID_SetupNeededResponse::$status</a>
    176. 

  176. 							</li>
    177. 

  177. 				</ul>
    178. 

  178. 		
    179. 

  179. 

  180. </div>
    181. 

  181. 
						
    182. 

  182. 		</div>
    183. 

  183. 	</div>
    184. 

  184. 	
    185. 

  185. 	<a name="sec-methods"></a>
    186. 

  186. 	<div class="info-box">
    187. 

  187. 		<div class="info-box-title">Methods</div>
    188. 

  188. 		<div class="nav-bar">
    189. 

  189. 			<a href="#sec-description">Description</a> |
    190. 

  190. 							<a href="#sec-descendents">Descendents</a> |
    191. 

  191. 															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    192. 

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

  193. 						
    194. 

  194. 		</div>
    195. 

  195. 		<div class="info-box-body">
    196. 

  196. 			<A NAME='method_detail'></A>
    197. 

  197. <a name="methodgetDisplayIdentifier" id="getDisplayIdentifier"><!-- --></a>
    198. 

  198. <div class="evenrow">
    199. 

  199. 	
    200. 

  200. 	<div class="method-header">
    201. 

  201. 		<span class="method-title">getDisplayIdentifier</span> (line <span class="line-number">2000</span>)
    202. 

  202. 	</div> 
    203. 

  203. 	
    204. 

  204. 	<!-- ========== Info from phpDoc block ========= -->
    205. 

  205. <p class="short-description">Return the display identifier for this response.</p>
    206. 

  206. <p class="description"><p>The display identifier is related to the Claimed Identifier, but the  two are not always identical.  The display identifier is something the  user should recognize as what they entered, whereas the response's  claimed identifier (in the identity_url attribute) may have extra  information for better persistence.</p><p>URLs will be stripped of their fragments for display.  XRIs will  display the human-readable identifier (i-name) instead of the  persistent identifier (i-number).</p><p>Use the display identifier in your user interface.  Use  identity_url for querying your database or authorization server.</p></p>
    207. 

  207. 	
    208. 

  208. 	<div class="method-signature">
    209. 

  209. 		<span class="method-result">void</span>
    210. 

  210. 		<span class="method-name">
    211. 

  211. 			getDisplayIdentifier
    212. 

  212. 		</span>
    213. 

  213. 				()
    214. 

  214. 			</div>
    215. 

  215. 	
    216. 

  216. 		
    217. 

  217. 			
    218. 

  218. 	</div>
    219. 

  219. <a name="methodsetEndpoint" id="setEndpoint"><!-- --></a>
    220. 

  220. <div class="oddrow">
    221. 

  221. 	
    222. 

  222. 	<div class="method-header">
    223. 

  223. 		<span class="method-title">setEndpoint</span> (line <span class="line-number">1973</span>)
    224. 

  224. 	</div> 
    225. 

  225. 	
    226. 

  226. 	<!-- ========== Info from phpDoc block ========= -->
    227. 

  227. 	
    228. 

  228. 	<div class="method-signature">
    229. 

  229. 		<span class="method-result">void</span>
    230. 

  230. 		<span class="method-name">
    231. 

  231. 			setEndpoint
    232. 

  232. 		</span>
    233. 

  233. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$endpoint</span>)
    234. 

  234. 			</div>
    235. 

  235. 	
    236. 

  236. 			<ul class="parameters">
    237. 

  237. 					<li>
    238. 

  238. 				<span class="var-type"></span>
    239. 

  239. 				<span class="var-name">$endpoint</span>			</li>
    240. 

  240. 				</ul>
    241. 

  241. 		
    242. 

  242. 			
    243. 

  243. 	</div>
    244. 

  244. 						
    245. 

  245. 		</div>
    246. 

  246. 	</div>
    247. 

  247. 

  248. 

  249. 	<p class="notes" id="credit">
    250. 

  250. 		Documentation generated on Tue, 21 Apr 2009 11:31:30 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
    251. 

  251. 	</p>
    252. 

  252. 	</div></body>
    253. 

  253. </html>
    254.