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

Auth_OpenID_AX_FetchResponse.html 14 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322 
  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_FetchResponse</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_FetchResponse</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    20. 

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

  21. 						
    22. 

  22. 					</div>
    23. 

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

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

  25. <p class="short-description">A fetch_response attribute exchange message.</p>
    26. 

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

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

  28. 		</p>
    29. 

  29. 		
    30. 

  30. 				
    31. 

  31. 		<pre><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a>
    32. 

  32.    |
    33. 

  33.    --<a href="../OpenID/Auth_OpenID_AX_Message.html">Auth_OpenID_AX_Message</a>
    34. 

  34.       |
    35. 

  35.       --<a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html">Auth_OpenID_AX_KeyValueMessage</a>
    36. 

  36.          |
    37. 

  37.          --Auth_OpenID_AX_FetchResponse</pre>
    38. 

  38. 	
    39. 

  39. 			</div>
    40. 

  40. </div>
    41. 

  41. 

  42. 

  43. 

  44. 	<a name="sec-var-summary"></a>
    45. 

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

  46. 		<div class="info-box-title">Variable Summary</span></div>
    47. 

  47. 		<div class="nav-bar">
    48. 

  48. 			<a href="#sec-description">Description</a> |
    49. 

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

  50. 							| 
    51. 

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

  52. 							
    53. 

  53. 								</div>
    54. 

  54. 		<div class="info-box-body">
    55. 

  55. 			<div class="var-summary">
    56. 

  56. 																								<div class="var-title">
    57. 

  57. 					<span class="var-type">mixed</span>
    58. 

  58. 					<a href="#$mode" title="details" class="var-name">$mode</a>
    59. 

  59. 				</div>
    60. 

  60. 											</div>
    61. 

  61. 		</div>
    62. 

  62. 	</div>
    63. 

  63. 

  64. 	<a name="sec-method-summary"></a>
    65. 

  65. 	<div class="info-box">
    66. 

  66. 		<div class="info-box-title">Method Summary</span></div>
    67. 

  67. 		<div class="nav-bar">
    68. 

  68. 			<a href="#sec-description">Description</a> |
    69. 

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

  70. 				 
    71. 

  71. 				|
    72. 

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

  73. 		</div>
    74. 

  74. 		<div class="info-box-body">			
    75. 

  75. 			<div class="method-summary">
    76. 

  76. 																																														
    77. 

  77. 				<div class="method-definition">
    78. 

  78. 											<span class="method-result">Auth_OpenID_AX_FetchResponse</span>
    79. 

  79. 										<a href="#Auth_OpenID_AX_FetchResponse" title="details" class="method-name">Auth_OpenID_AX_FetchResponse</a>
    80. 

  80. 											([<span class="var-type"></span>&nbsp;<span class="var-name">$update_url</span> = <span class="var-default">null</span>])
    81. 

  81. 									</div>
    82. 

  82. 														
    83. 

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

  84. 											<span class="method-result">$response</span>
    85. 

  85. 										<a href="#fromSuccessResponse" title="details" class="method-name">fromSuccessResponse</a>
    86. 

  86. 											(<span class="var-type">success_response:</span>&nbsp;<span class="var-name">$success_response</span>, [<span class="var-type">signed:</span>&nbsp;<span class="var-name">$signed</span> = <span class="var-default">true</span>])
    87. 

  87. 									</div>
    88. 

  88. 														
    89. 

  89. 				<div class="method-definition">
    90. 

  90. 											<span class="method-result">$args</span>
    91. 

  91. 										<a href="#getExtensionArgs" title="details" class="method-name">getExtensionArgs</a>
    92. 

  92. 											([<span class="var-type"></span>&nbsp;<span class="var-name">$request</span> = <span class="var-default">null</span>])
    93. 

  93. 									</div>
    94. 

  94. 														
    95. 

  95. 				<div class="method-definition">
    96. 

  96. 											<span class="method-result">$result</span>
    97. 

  97. 										<a href="#parseExtensionArgs" title="details" class="method-name">parseExtensionArgs</a>
    98. 

  98. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$ax_args</span>)
    99. 

  99. 									</div>
    100. 

  100. 											</div>
    101. 

  101. 		</div>
    102. 

  102. 	</div>		
    103. 

  103. 

  104. 	<a name="sec-vars"></a>
    105. 

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

  106. 		<div class="info-box-title">Variables</div>
    107. 

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

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

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

  110. 						
    111. 

  111. 			
    112. 

  112. 										| 
    113. 

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

  114. 							
    115. 

  115. 					</div>
    116. 

  116. 		<div class="info-box-body">
    117. 

  117. 			
    118. 

  118. <a name="var$mode" id="$mode"><!-- --></A>
    119. 

  119. <div class="oddrow">
    120. 

  120. 

  121. 	<div class="var-header">
    122. 

  122. 		<span class="var-title">
    123. 

  123. 			<span class="var-type">mixed</span>
    124. 

  124. 			<span class="var-name">$mode</span>
    125. 

  125. 			 = <span class="var-default"> 'fetch_response'</span>			(line <span class="line-number">794</span>)
    126. 

  126. 		</span>
    127. 

  127. 	</div>
    128. 

  128. 

  129. 	<!-- ========== Info from phpDoc block ========= -->
    130. 

  130. 	
    131. 

  131. 	
    132. 

  132. 			<hr class="separator" />
    133. 

  133. 		<div class="notes">Redefinition of:</div>
    134. 

  134. 		<dl>
    135. 

  135. 			<dt><a href="../OpenID/Auth_OpenID_AX_Message.html#var$mode">Auth_OpenID_AX_Message::$mode</a></dt>
    136. 

  136. 						<dd>mode: The type of this attribute exchange message. This must be  overridden in subclasses.</dd>
    137. 

  137. 					</dl>
    138. 

  138. 		
    139. 

  139. 		
    140. 

  140. 

  141. </div>
    142. 

  142. 
							<h4>Inherited Variables</h4>
    143. 

  143. 				<A NAME='inherited_vars'><!-- --></A>
    144. 

  144. 									<p>Inherited from <span class="classname"><a href="../OpenID/Auth_OpenID_AX_Message.html">Auth_OpenID_AX_Message</a></span></p>
    145. 

  145. 					<blockquote>
    146. 

  146. 													<span class="var-title">
    147. 

  147. 								<span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$ns_alias">Auth_OpenID_AX_Message::$ns_alias</a></span><br>
    148. 

  148. 							</span>
    149. 

  149. 													<span class="var-title">
    150. 

  150. 								<span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$ns_uri">Auth_OpenID_AX_Message::$ns_uri</a></span><br>
    151. 

  151. 							</span>
    152. 

  152. 											</blockquote> 
    153. 

  153. 										
    154. 

  154. 		</div>
    155. 

  155. 	</div>
    156. 

  156. 	
    157. 

  157. 	<a name="sec-methods"></a>
    158. 

  158. 	<div class="info-box">
    159. 

  159. 		<div class="info-box-title">Methods</div>
    160. 

  160. 		<div class="nav-bar">
    161. 

  161. 			<a href="#sec-description">Description</a> |
    162. 

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

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

  164. 						
    165. 

  165. 		</div>
    166. 

  166. 		<div class="info-box-body">
    167. 

  167. 			<A NAME='method_detail'></A>
    168. 

  168. <a name="methodAuth_OpenID_AX_FetchResponse" id="Auth_OpenID_AX_FetchResponse"><!-- --></a>
    169. 

  169. <div class="evenrow">
    170. 

  170. 	
    171. 

  171. 	<div class="method-header">
    172. 

  172. 		<span class="method-title">Constructor Auth_OpenID_AX_FetchResponse</span> (line <span class="line-number">796</span>)
    173. 

  173. 	</div> 
    174. 

  174. 	
    175. 

  175. 	<!-- ========== Info from phpDoc block ========= -->
    176. 

  176. 	
    177. 

  177. 	<div class="method-signature">
    178. 

  178. 		<span class="method-result">Auth_OpenID_AX_FetchResponse</span>
    179. 

  179. 		<span class="method-name">
    180. 

  180. 			Auth_OpenID_AX_FetchResponse
    181. 

  181. 		</span>
    182. 

  182. 					([<span class="var-type"></span>&nbsp;<span class="var-name">$update_url</span> = <span class="var-default">null</span>])
    183. 

  183. 			</div>
    184. 

  184. 	
    185. 

  185. 			<ul class="parameters">
    186. 

  186. 					<li>
    187. 

  187. 				<span class="var-type"></span>
    188. 

  188. 				<span class="var-name">$update_url</span>			</li>
    189. 

  189. 				</ul>
    190. 

  190. 		
    191. 

  191. 			
    192. 

  192. 	</div>
    193. 

  193. <a name="methodfromSuccessResponse" id="fromSuccessResponse"><!-- --></a>
    194. 

  194. <div class="oddrow">
    195. 

  195. 	
    196. 

  196. 	<div class="method-header">
    197. 

  197. 		<span class="method-title">fromSuccessResponse</span> (line <span class="line-number">925</span>)
    198. 

  198. 	</div> 
    199. 

  199. 	
    200. 

  200. 	<!-- ========== Info from phpDoc block ========= -->
    201. 

  201. <p class="short-description">Construct a FetchResponse object from an OpenID library  SuccessResponse object.</p>
    202. 

  202. 	<ul class="tags">
    203. 

  203. 				<li><span class="field">return:</span> A FetchResponse containing the data from the  OpenID message</li>
    204. 

  204. 			</ul>
    205. 

  205. 	
    206. 

  206. 	<div class="method-signature">
    207. 

  207. 		<span class="method-result">$response</span>
    208. 

  208. 		<span class="method-name">
    209. 

  209. 			fromSuccessResponse
    210. 

  210. 		</span>
    211. 

  211. 					(<span class="var-type">success_response:</span>&nbsp;<span class="var-name">$success_response</span>, [<span class="var-type">signed:</span>&nbsp;<span class="var-name">$signed</span> = <span class="var-default">true</span>])
    212. 

  212. 			</div>
    213. 

  213. 	
    214. 

  214. 			<ul class="parameters">
    215. 

  215. 					<li>
    216. 

  216. 				<span class="var-type">success_response:</span>
    217. 

  217. 				<span class="var-name">$success_response</span><span class="var-description">: A successful id_res response object</span>			</li>
    218. 

  218. 					<li>
    219. 

  219. 				<span class="var-type">signed:</span>
    220. 

  220. 				<span class="var-name">$signed</span><span class="var-description">: Whether non-signed args should be processsed. If  True (the default), only signed arguments will be processsed.</span>			</li>
    221. 

  221. 				</ul>
    222. 

  222. 		
    223. 

  223. 			
    224. 

  224. 	</div>
    225. 

  225. <a name="methodgetExtensionArgs" id="getExtensionArgs"><!-- --></a>
    226. 

  226. <div class="evenrow">
    227. 

  227. 	
    228. 

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

  229. 		<span class="method-title">getExtensionArgs</span> (line <span class="line-number">810</span>)
    230. 

  230. 	</div> 
    231. 

  231. 	
    232. 

  232. 	<!-- ========== Info from phpDoc block ========= -->
    233. 

  233. <p class="short-description">Serialize this object into arguments in the attribute exchange  namespace</p>
    234. 

  234. 	<ul class="tags">
    235. 

  235. 				<li><span class="field">return:</span> The dictionary of unqualified attribute exchange  arguments that represent this fetch_response, or  Auth_OpenID_AX_Error on error.</li>
    236. 

  236. 			</ul>
    237. 

  237. 	
    238. 

  238. 	<div class="method-signature">
    239. 

  239. 		<span class="method-result">$args</span>
    240. 

  240. 		<span class="method-name">
    241. 

  241. 			getExtensionArgs
    242. 

  242. 		</span>
    243. 

  243. 					([<span class="var-type"></span>&nbsp;<span class="var-name">$request</span> = <span class="var-default">null</span>])
    244. 

  244. 			</div>
    245. 

  245. 	
    246. 

  246. 			<ul class="parameters">
    247. 

  247. 					<li>
    248. 

  248. 				<span class="var-type"></span>
    249. 

  249. 				<span class="var-name">$request</span>			</li>
    250. 

  250. 				</ul>
    251. 

  251. 		
    252. 

  252. 			<hr class="separator" />
    253. 

  253. 		<div class="notes">Redefinition of:</div>
    254. 

  254. 		<dl>
    255. 

  255. 			<dt><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></dt>
    256. 

  256. 						<dd>Get the string arguments that should be added to an OpenID  message for this extension.</dd>
    257. 

  257. 					</dl>
    258. 

  258. 			
    259. 

  259. 	</div>
    260. 

  260. <a name="methodparseExtensionArgs" id="parseExtensionArgs"><!-- --></a>
    261. 

  261. <div class="oddrow">
    262. 

  262. 	
    263. 

  263. 	<div class="method-header">
    264. 

  264. 		<span class="method-title">parseExtensionArgs</span> (line <span class="line-number">900</span>)
    265. 

  265. 	</div> 
    266. 

  266. 	
    267. 

  267. 	<!-- ========== Info from phpDoc block ========= -->
    268. 

  268. 	<ul class="tags">
    269. 

  269. 				<li><span class="field">return:</span> Auth_OpenID_AX_Error on failure or true on  success.</li>
    270. 

  270. 			</ul>
    271. 

  271. 	
    272. 

  272. 	<div class="method-signature">
    273. 

  273. 		<span class="method-result">$result</span>
    274. 

  274. 		<span class="method-name">
    275. 

  275. 			parseExtensionArgs
    276. 

  276. 		</span>
    277. 

  277. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$ax_args</span>)
    278. 

  278. 			</div>
    279. 

  279. 	
    280. 

  280. 			<ul class="parameters">
    281. 

  281. 					<li>
    282. 

  282. 				<span class="var-type"></span>
    283. 

  283. 				<span class="var-name">$ax_args</span>			</li>
    284. 

  284. 				</ul>
    285. 

  285. 		
    286. 

  286. 			<hr class="separator" />
    287. 

  287. 		<div class="notes">Redefinition of:</div>
    288. 

  288. 		<dl>
    289. 

  289. 			<dt><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodparseExtensionArgs">Auth_OpenID_AX_KeyValueMessage::parseExtensionArgs()</a></dt>
    290. 

  290. 						<dd>Parse attribute exchange key/value arguments into this object.</dd>
    291. 

  291. 					</dl>
    292. 

  292. 			
    293. 

  293. 	</div>
    294. 

  294. 							<h4>Inherited Methods</h4>
    295. 

  295. 				<a name='inherited_methods'><!-- --></a>	
    296. 

  296. 									<!-- =========== Summary =========== -->
    297. 

  297. 					<p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html">Auth_OpenID_AX_KeyValueMessage</a></span></p>
    298. 

  298. 					<blockquote>
    299. 

  299. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodAuth_OpenID_AX_KeyValueMessage">Auth_OpenID_AX_KeyValueMessage::Auth_OpenID_AX_KeyValueMessage()</a></span><br>
    300. 

  300. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodaddValue">Auth_OpenID_AX_KeyValueMessage::addValue()</a></span><br>
    301. 

  301. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodcount">Auth_OpenID_AX_KeyValueMessage::count()</a></span><br>
    302. 

  302. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodget">Auth_OpenID_AX_KeyValueMessage::get()</a></span><br>
    303. 

  303. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodgetSingle">Auth_OpenID_AX_KeyValueMessage::getSingle()</a></span><br>
    304. 

  304. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodparseExtensionArgs">Auth_OpenID_AX_KeyValueMessage::parseExtensionArgs()</a></span><br>
    305. 

  305. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html#methodsetValues">Auth_OpenID_AX_KeyValueMessage::setValues()</a></span><br>
    306. 

  306. 											</blockquote>
    307. 

  307. 									<!-- =========== Summary =========== -->
    308. 

  308. 					<p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a></span></p>
    309. 

  309. 					<blockquote>
    310. 

  310. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></span><br>
    311. 

  311. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodtoMessage">Auth_OpenID_Extension::toMessage()</a></span><br>
    312. 

  312. 											</blockquote>
    313. 

  313. 										
    314. 

  314. 		</div>
    315. 

  315. 	</div>
    316. 

  316. 

  317. 

  318. 	<p class="notes" id="credit">
    319. 

  319. 		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>
    320. 

  320. 	</p>
    321. 

  321. 	</div></body>
    322. 

  322. </html>
    323.