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

Auth_Yadis_Discovery.html 7.6 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180 
  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_Yadis_Discovery</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_Yadis_Discovery</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">State management for discovery.</p>
    25. 

  25. <p class="description"><p>High-level usage pattern is to call .getNextService(discover) in  order to find the next available service for this user for this  session. Once a request completes, call .cleanup() to clean up the  session state.</p></p>
    26. 

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

  27. 			Located in <a class="field" href="_Auth---Yadis---Manager.php.html">/Auth/Yadis/Manager.php</a> (line <span class="field">369</span>)
    28. 

  28. 		</p>
    29. 

  29. 		
    30. 

  30. 				
    31. 

  31. 		<pre></pre>
    32. 

  32. 	
    33. 

  33. 			</div>
    34. 

  34. </div>
    35. 

  35. 

  36. 

  37. 

  38. 

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

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

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

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

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

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

  45. 		</div>
    46. 

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

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

  48. 																																						
    49. 

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

  50. 											<span class="method-result">Auth_Yadis_Discovery</span>
    51. 

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

  52. 											(<span class="var-type"></span>&nbsp;<span class="var-name">&$session</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$session_key_suffix</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../OpenID/Auth_Yadis_PHPSession.html">Auth_Yadis_PHPSession</a></span>&nbsp;<span class="var-name">$session</span>)
    53. 

  53. 									</div>
    54. 

  54. 														
    55. 

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

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

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

  58. 											([<span class="var-type">$force</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">false</span>])
    59. 

  59. 									</div>
    60. 

  60. 														
    61. 

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

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

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

  64. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$discover_cb</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$fetcher</span>)
    65. 

  65. 									</div>
    66. 

  66. 											</div>
    67. 

  67. 		</div>
    68. 

  68. 	</div>		
    69. 

  69. 

  70. 	
    71. 

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

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

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

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

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

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

  77. 						
    78. 

  78. 		</div>
    79. 

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

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

  81. <a name="methodAuth_Yadis_Discovery" id="Auth_Yadis_Discovery"><!-- --></a>
    82. 

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

  83. 	
    84. 

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

  85. 		<span class="method-title">Constructor Auth_Yadis_Discovery</span> (line <span class="line-number">390</span>)
    86. 

  86. 	</div> 
    87. 

  87. 	
    88. 

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

  89. <p class="short-description">Initialize a discovery object.</p>
    90. 

  90. 	
    91. 

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

  92. 		<span class="method-result">Auth_Yadis_Discovery</span>
    93. 

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

  94. 			Auth_Yadis_Discovery
    95. 

  95. 		</span>
    96. 

  96. 					(<span class="var-type"></span>&nbsp;<span class="var-name">&$session</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$session_key_suffix</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../OpenID/Auth_Yadis_PHPSession.html">Auth_Yadis_PHPSession</a></span>&nbsp;<span class="var-name">$session</span>)
    97. 

  97. 			</div>
    98. 

  98. 	
    99. 

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

  100. 					<li>
    101. 

  101. 				<span class="var-type"><a href="../OpenID/Auth_Yadis_PHPSession.html">Auth_Yadis_PHPSession</a></span>
    102. 

  102. 				<span class="var-name">$session</span><span class="var-description">: An object which  implements the Auth_Yadis_PHPSession API.</span>			</li>
    103. 

  103. 					<li>
    104. 

  104. 				<span class="var-type">string</span>
    105. 

  105. 				<span class="var-name">$url</span><span class="var-description">: The URL on which to attempt discovery.</span>			</li>
    106. 

  106. 					<li>
    107. 

  107. 				<span class="var-type">string</span>
    108. 

  108. 				<span class="var-name">$session_key_suffix</span><span class="var-description">: The optional session key  suffix override.</span>			</li>
    109. 

  109. 					<li>
    110. 

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

  111. 				<span class="var-name">&$session</span>			</li>
    112. 

  112. 				</ul>
    113. 

  113. 		
    114. 

  114. 			
    115. 

  115. 	</div>
    116. 

  116. <a name="methodcleanup" id="cleanup"><!-- --></a>
    117. 

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

  118. 	
    119. 

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

  120. 		<span class="method-title">cleanup</span> (line <span class="line-number">441</span>)
    121. 

  121. 	</div> 
    122. 

  122. 	
    123. 

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

  124. <p class="short-description">Clean up Yadis-related services in the session and return the  most-recently-attempted service from the manager, if one  exists.</p>
    125. 

  125. 	
    126. 

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

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

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

  129. 			cleanup
    130. 

  130. 		</span>
    131. 

  131. 					([<span class="var-type">$force</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">false</span>])
    132. 

  132. 			</div>
    133. 

  133. 	
    134. 

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

  135. 					<li>
    136. 

  136. 				<span class="var-type">$force</span>
    137. 

  137. 				<span class="var-name">$force</span><span class="var-description">: True if the manager should be deleted regardless  of whether it's a manager for $this-&gt;url.</span>			</li>
    138. 

  138. 				</ul>
    139. 

  139. 		
    140. 

  140. 			
    141. 

  141. 	</div>
    142. 

  142. <a name="methodgetNextService" id="getNextService"><!-- --></a>
    143. 

  143. <div class="oddrow">
    144. 

  144. 	
    145. 

  145. 	<div class="method-header">
    146. 

  146. 		<span class="method-title">getNextService</span> (line <span class="line-number">408</span>)
    147. 

  147. 	</div> 
    148. 

  148. 	
    149. 

  149. 	<!-- ========== Info from phpDoc block ========= -->
    150. 

  150. <p class="short-description">Return the next authentication service for the pair of  user_input and session. This function handles fallback.</p>
    151. 

  151. 	
    152. 

  152. 	<div class="method-signature">
    153. 

  153. 		<span class="method-result">void</span>
    154. 

  154. 		<span class="method-name">
    155. 

  155. 			getNextService
    156. 

  156. 		</span>
    157. 

  157. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$discover_cb</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$fetcher</span>)
    158. 

  158. 			</div>
    159. 

  159. 	
    160. 

  160. 			<ul class="parameters">
    161. 

  161. 					<li>
    162. 

  162. 				<span class="var-type"></span>
    163. 

  163. 				<span class="var-name">$discover_cb</span>			</li>
    164. 

  164. 					<li>
    165. 

  165. 				<span class="var-type"></span>
    166. 

  166. 				<span class="var-name">&$fetcher</span>			</li>
    167. 

  167. 				</ul>
    168. 

  168. 		
    169. 

  169. 			
    170. 

  170. 	</div>
    171. 

  171. 						
    172. 

  172. 		</div>
    173. 

  173. 	</div>
    174. 

  174. 

  175. 

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

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

  178. 	</p>
    179. 

  179. 	</div></body>
    180. 

  180. </html>
    181.