首页 发现 帮助
登录
usic
/
ums
关注 2
点赞 0
派生 0
文件 工单管理 0 合并请求 0 Wiki
分支: master
分支列表 标签列表
ums
/
lib
/
php-openid
/
doc
/
OpenID
/
Auth_OpenID_SQLStore.html

Auth_OpenID_SQLStore.html 27 KB
永久链接 文件历史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696 
  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_SQLStore</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_SQLStore</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-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">This is the parent class for the SQL stores, which contains the  logic common to all of the SQL stores.</p>
    26. 

  26. <p class="description"><p>The table names used are determined by the class variables  associations_table_name and nonces_table_name.  To change the name  of the tables used, pass new table names into the constructor.</p><p>To create the tables with the proper schema, see the createTables  method.</p><p>This class shouldn't be used directly.  Use one of its subclasses  instead, as those contain the code necessary to use a specific  database.  If you're an OpenID integrator and you'd like to create  an SQL-driven store that wraps an application's database  abstraction, be sure to create a subclass of  <a href="../OpenID/Auth_OpenID_DatabaseConnection.html">Auth_OpenID_DatabaseConnection</a> that calls the application's  database abstraction calls.  Then, pass an instance of your new  database connection class to your SQLStore subclass constructor.</p><p>All methods other than the constructor and createTables should be  considered implementation details.</p></p>
    27. 

  27. 	<ul class="tags">
    28. 

  28. 				<li><span class="field">author:</span> JanRain, Inc. &lt;<a href="mailto:openid@janrain.com">openid@janrain.com</a>&gt;</li>
    29. 

  29. 			</ul>
    30. 

  30. 		<p class="notes">
    31. 

  31. 			Located in <a class="field" href="_Auth---OpenID---SQLStore.php.html">/Auth/OpenID/SQLStore.php</a> (line <span class="field">67</span>)
    32. 

  32. 		</p>
    33. 

  33. 		
    34. 

  34. 				
    35. 

  35. 		<pre><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a>
    36. 

  36.    |
    37. 

  37.    --Auth_OpenID_SQLStore</pre>
    38. 

  38. 	
    39. 

  39. 			</div>
    40. 

  40. </div>
    41. 

  41. 

  42. 	<a name="sec-descendents"></a>
    43. 

  43. 	<div class="info-box">
    44. 

  44. 		<div class="info-box-title">Direct descendents</div>
    45. 

  45. 		<div class="nav-bar">
    46. 

  46. 			<a href="#sec-description">Description</a> |
    47. 

  47. 			<span class="disabled">Descendents</span>
    48. 

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

  49. 							
    50. 

  50. 								</div>
    51. 

  51. 		<div class="info-box-body">
    52. 

  52. 			<table cellpadding="2" cellspacing="0" class="class-table">
    53. 

  53. 				<tr>
    54. 

  54. 					<th class="class-table-header">Class</th>
    55. 

  55. 					<th class="class-table-header">Description</th>
    56. 

  56. 				</tr>
    57. 

  57. 								<tr>
    58. 

  58. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_PostgreSQLStore.html">Auth_OpenID_PostgreSQLStore</a></td>
    59. 

  59. 					<td>
    60. 

  60. 											An SQL store that uses PostgreSQL as its backend.
    61. 

  61. 										</td>
    62. 

  62. 				</tr>
    63. 

  63. 								<tr>
    64. 

  64. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_MySQLStore.html">Auth_OpenID_MySQLStore</a></td>
    65. 

  65. 					<td>
    66. 

  66. 											An SQL store that uses MySQL as its backend.
    67. 

  67. 										</td>
    68. 

  68. 				</tr>
    69. 

  69. 								<tr>
    70. 

  70. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_SQLiteStore.html">Auth_OpenID_SQLiteStore</a></td>
    71. 

  71. 					<td>
    72. 

  72. 											An SQL store that uses SQLite as its backend.
    73. 

  73. 										</td>
    74. 

  74. 				</tr>
    75. 

  75. 							</table>
    76. 

  76. 		</div>
    77. 

  77. 	</div>
    78. 

  78. 

  79. 

  80. 

  81. 	<a name="sec-method-summary"></a>
    82. 

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

  83. 		<div class="info-box-title">Method Summary</span></div>
    84. 

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

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

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

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

  88. 		</div>
    89. 

  89. 		<div class="info-box-body">			
    90. 

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

  91. 																																																																																																																																																						
    92. 

  92. 				<div class="method-definition">
    93. 

  93. 											<span class="method-result">Auth_OpenID_SQLStore</span>
    94. 

  94. 										<a href="#Auth_OpenID_SQLStore" title="details" class="method-name">Auth_OpenID_SQLStore</a>
    95. 

  95. 											(<span class="var-type">connection</span>&nbsp;<span class="var-name">$connection</span>, [<span class="var-type">associations_table:</span>&nbsp;<span class="var-name">$associations_table</span> = <span class="var-default">null</span>], [<span class="var-type">nonces_table:</span>&nbsp;<span class="var-name">$nonces_table</span> = <span class="var-default">null</span>])
    96. 

  96. 									</div>
    97. 

  97. 														
    98. 

  98. 				<div class="method-definition">
    99. 

  99. 											<span class="method-result">void</span>
    100. 

  100. 										<a href="#blobDecode" title="details" class="method-name">blobDecode</a>
    101. 

  101. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$blob</span>)
    102. 

  102. 									</div>
    103. 

  103. 														
    104. 

  104. 				<div class="method-definition">
    105. 

  105. 											<span class="method-result">void</span>
    106. 

  106. 										<a href="#blobEncode" title="details" class="method-name">blobEncode</a>
    107. 

  107. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>)
    108. 

  108. 									</div>
    109. 

  109. 														
    110. 

  110. 				<div class="method-definition">
    111. 

  111. 											<span class="method-result">void</span>
    112. 

  112. 										<a href="#cleanupAssociations" title="details" class="method-name">cleanupAssociations</a>
    113. 

  113. 										()
    114. 

  114. 									</div>
    115. 

  115. 														
    116. 

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

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

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

  119. 										()
    120. 

  120. 									</div>
    121. 

  121. 														
    122. 

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

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

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

  125. 										()
    126. 

  126. 									</div>
    127. 

  127. 														
    128. 

  128. 				<div class="method-definition">
    129. 

  129. 											<span class="method-result">void</span>
    130. 

  130. 										<a href="#create_assoc_table" title="details" class="method-name">create_assoc_table</a>
    131. 

  131. 										()
    132. 

  132. 									</div>
    133. 

  133. 														
    134. 

  134. 				<div class="method-definition">
    135. 

  135. 											<span class="method-result">void</span>
    136. 

  136. 										<a href="#create_nonce_table" title="details" class="method-name">create_nonce_table</a>
    137. 

  137. 										()
    138. 

  138. 									</div>
    139. 

  139. 														
    140. 

  140. 				<div class="method-definition">
    141. 

  141. 											<span class="method-result">void</span>
    142. 

  142. 										<a href="#getAssociation" title="details" class="method-name">getAssociation</a>
    143. 

  143. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$handle</span> = <span class="var-default">null</span>])
    144. 

  144. 									</div>
    145. 

  145. 														
    146. 

  146. 				<div class="method-definition">
    147. 

  147. 											<span class="method-result">void</span>
    148. 

  148. 										<a href="#isError" title="details" class="method-name">isError</a>
    149. 

  149. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
    150. 

  150. 									</div>
    151. 

  151. 														
    152. 

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

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

  154. 										<a href="#removeAssociation" title="details" class="method-name">removeAssociation</a>
    155. 

  155. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$handle</span>)
    156. 

  156. 									</div>
    157. 

  157. 														
    158. 

  158. 				<div class="method-definition">
    159. 

  159. 											<span class="method-result">void</span>
    160. 

  160. 										<a href="#reset" title="details" class="method-name">reset</a>
    161. 

  161. 										()
    162. 

  162. 									</div>
    163. 

  163. 														
    164. 

  164. 				<div class="method-definition">
    165. 

  165. 											<span class="method-result">void</span>
    166. 

  166. 										<a href="#resultToBool" title="details" class="method-name">resultToBool</a>
    167. 

  167. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
    168. 

  168. 									</div>
    169. 

  169. 														
    170. 

  170. 				<div class="method-definition">
    171. 

  171. 											<span class="method-result">void</span>
    172. 

  172. 										<a href="#setSQL" title="details" class="method-name">setSQL</a>
    173. 

  173. 										()
    174. 

  174. 									</div>
    175. 

  175. 														
    176. 

  176. 				<div class="method-definition">
    177. 

  177. 											<span class="method-result">void</span>
    178. 

  178. 										<a href="#storeAssociation" title="details" class="method-name">storeAssociation</a>
    179. 

  179. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$association</span>)
    180. 

  180. 									</div>
    181. 

  181. 														
    182. 

  182. 				<div class="method-definition">
    183. 

  183. 											<span class="method-result">void</span>
    184. 

  184. 										<a href="#tableExists" title="details" class="method-name">tableExists</a>
    185. 

  185. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$table_name</span>)
    186. 

  186. 									</div>
    187. 

  187. 														
    188. 

  188. 				<div class="method-definition">
    189. 

  189. 											<span class="method-result">void</span>
    190. 

  190. 										<a href="#useNonce" title="details" class="method-name">useNonce</a>
    191. 

  191. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$timestamp</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$salt</span>)
    192. 

  192. 									</div>
    193. 

  193. 											</div>
    194. 

  194. 		</div>
    195. 

  195. 	</div>		
    196. 

  196. 

  197. 	
    198. 

  198. 	<a name="sec-methods"></a>
    199. 

  199. 	<div class="info-box">
    200. 

  200. 		<div class="info-box-title">Methods</div>
    201. 

  201. 		<div class="nav-bar">
    202. 

  202. 			<a href="#sec-description">Description</a> |
    203. 

  203. 							<a href="#sec-descendents">Descendents</a> |
    204. 

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

  205. 						
    206. 

  206. 		</div>
    207. 

  207. 		<div class="info-box-body">
    208. 

  208. 			<A NAME='method_detail'></A>
    209. 

  209. <a name="methodAuth_OpenID_SQLStore" id="Auth_OpenID_SQLStore"><!-- --></a>
    210. 

  210. <div class="evenrow">
    211. 

  211. 	
    212. 

  212. 	<div class="method-header">
    213. 

  213. 		<span class="method-title">Constructor Auth_OpenID_SQLStore</span> (line <span class="line-number">88</span>)
    214. 

  214. 	</div> 
    215. 

  215. 	
    216. 

  216. 	<!-- ========== Info from phpDoc block ========= -->
    217. 

  217. <p class="short-description">This creates a new SQLStore instance.  It requires an  established database connection be given to it, and it allows  overriding the default table names.</p>
    218. 

  218. 	
    219. 

  219. 	<div class="method-signature">
    220. 

  220. 		<span class="method-result">Auth_OpenID_SQLStore</span>
    221. 

  221. 		<span class="method-name">
    222. 

  222. 			Auth_OpenID_SQLStore
    223. 

  223. 		</span>
    224. 

  224. 					(<span class="var-type">connection</span>&nbsp;<span class="var-name">$connection</span>, [<span class="var-type">associations_table:</span>&nbsp;<span class="var-name">$associations_table</span> = <span class="var-default">null</span>], [<span class="var-type">nonces_table:</span>&nbsp;<span class="var-name">$nonces_table</span> = <span class="var-default">null</span>])
    225. 

  225. 			</div>
    226. 

  226. 	
    227. 

  227. 			<ul class="parameters">
    228. 

  228. 					<li>
    229. 

  229. 				<span class="var-type">connection</span>
    230. 

  230. 				<span class="var-name">$connection</span><span class="var-description">: This must be an established  connection to a database of the correct type for the SQLStore  subclass you're using.  This must either be an PEAR DB  connection handle or an instance of a subclass of  Auth_OpenID_DatabaseConnection.</span>			</li>
    231. 

  231. 					<li>
    232. 

  232. 				<span class="var-type">associations_table:</span>
    233. 

  233. 				<span class="var-name">$associations_table</span><span class="var-description">: This is an optional parameter to  specify the name of the table used for storing associations.  The default value is 'oid_associations'.</span>			</li>
    234. 

  234. 					<li>
    235. 

  235. 				<span class="var-type">nonces_table:</span>
    236. 

  236. 				<span class="var-name">$nonces_table</span><span class="var-description">: This is an optional parameter to specify  the name of the table used for storing nonces.  The default  value is 'oid_nonces'.</span>			</li>
    237. 

  237. 				</ul>
    238. 

  238. 		
    239. 

  239. 			
    240. 

  240. 	</div>
    241. 

  241. <a name="methodblobDecode" id="blobDecode"><!-- --></a>
    242. 

  242. <div class="oddrow">
    243. 

  243. 	
    244. 

  244. 	<div class="method-header">
    245. 

  245. 		<span class="method-title">blobDecode</span> (line <span class="line-number">288</span>)
    246. 

  246. 	</div> 
    247. 

  247. 	
    248. 

  248. 	<!-- ========== Info from phpDoc block ========= -->
    249. 

  249. 	
    250. 

  250. 	<div class="method-signature">
    251. 

  251. 		<span class="method-result">void</span>
    252. 

  252. 		<span class="method-name">
    253. 

  253. 			blobDecode
    254. 

  254. 		</span>
    255. 

  255. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$blob</span>)
    256. 

  256. 			</div>
    257. 

  257. 	
    258. 

  258. 			<ul class="parameters">
    259. 

  259. 					<li>
    260. 

  260. 				<span class="var-type"></span>
    261. 

  261. 				<span class="var-name">$blob</span>			</li>
    262. 

  262. 				</ul>
    263. 

  263. 		
    264. 

  264. 			
    265. 

  265. 	</div>
    266. 

  266. <a name="methodblobEncode" id="blobEncode"><!-- --></a>
    267. 

  267. <div class="evenrow">
    268. 

  268. 	
    269. 

  269. 	<div class="method-header">
    270. 

  270. 		<span class="method-title">blobEncode</span> (line <span class="line-number">293</span>)
    271. 

  271. 	</div> 
    272. 

  272. 	
    273. 

  273. 	<!-- ========== Info from phpDoc block ========= -->
    274. 

  274. 	
    275. 

  275. 	<div class="method-signature">
    276. 

  276. 		<span class="method-result">void</span>
    277. 

  277. 		<span class="method-name">
    278. 

  278. 			blobEncode
    279. 

  279. 		</span>
    280. 

  280. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>)
    281. 

  281. 			</div>
    282. 

  282. 	
    283. 

  283. 			<ul class="parameters">
    284. 

  284. 					<li>
    285. 

  285. 				<span class="var-type"></span>
    286. 

  286. 				<span class="var-name">$str</span>			</li>
    287. 

  287. 				</ul>
    288. 

  288. 		
    289. 

  289. 			
    290. 

  290. 	</div>
    291. 

  291. <a name="methodcleanupAssociations" id="cleanupAssociations"><!-- --></a>
    292. 

  292. <div class="oddrow">
    293. 

  293. 	
    294. 

  294. 	<div class="method-header">
    295. 

  295. 		<span class="method-title">cleanupAssociations</span> (line <span class="line-number">559</span>)
    296. 

  296. 	</div> 
    297. 

  297. 	
    298. 

  298. 	<!-- ========== Info from phpDoc block ========= -->
    299. 

  299. 	
    300. 

  300. 	<div class="method-signature">
    301. 

  301. 		<span class="method-result">void</span>
    302. 

  302. 		<span class="method-name">
    303. 

  303. 			cleanupAssociations
    304. 

  304. 		</span>
    305. 

  305. 				()
    306. 

  306. 			</div>
    307. 

  307. 	
    308. 

  308. 		
    309. 

  309. 			<hr class="separator" />
    310. 

  310. 		<div class="notes">Redefinition of:</div>
    311. 

  311. 		<dl>
    312. 

  312. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupAssociations">Auth_OpenID_OpenIDStore::cleanupAssociations()</a></dt>
    313. 

  313. 					</dl>
    314. 

  314. 			
    315. 

  315. 	</div>
    316. 

  316. <a name="methodcleanupNonces" id="cleanupNonces"><!-- --></a>
    317. 

  317. <div class="evenrow">
    318. 

  318. 	
    319. 

  319. 	<div class="method-header">
    320. 

  320. 		<span class="method-title">cleanupNonces</span> (line <span class="line-number">548</span>)
    321. 

  321. 	</div> 
    322. 

  322. 	
    323. 

  323. 	<!-- ========== Info from phpDoc block ========= -->
    324. 

  324. 	
    325. 

  325. 	<div class="method-signature">
    326. 

  326. 		<span class="method-result">void</span>
    327. 

  327. 		<span class="method-name">
    328. 

  328. 			cleanupNonces
    329. 

  329. 		</span>
    330. 

  330. 				()
    331. 

  331. 			</div>
    332. 

  332. 	
    333. 

  333. 		
    334. 

  334. 			<hr class="separator" />
    335. 

  335. 		<div class="notes">Redefinition of:</div>
    336. 

  336. 		<dl>
    337. 

  337. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupNonces">Auth_OpenID_OpenIDStore::cleanupNonces()</a></dt>
    338. 

  338. 					</dl>
    339. 

  339. 			
    340. 

  340. 	</div>
    341. 

  341. <a name="methodcreateTables" id="createTables"><!-- --></a>
    342. 

  342. <div class="oddrow">
    343. 

  343. 	
    344. 

  344. 	<div class="method-header">
    345. 

  345. 		<span class="method-title">createTables</span> (line <span class="line-number">298</span>)
    346. 

  346. 	</div> 
    347. 

  347. 	
    348. 

  348. 	<!-- ========== Info from phpDoc block ========= -->
    349. 

  349. 	
    350. 

  350. 	<div class="method-signature">
    351. 

  351. 		<span class="method-result">void</span>
    352. 

  352. 		<span class="method-name">
    353. 

  353. 			createTables
    354. 

  354. 		</span>
    355. 

  355. 				()
    356. 

  356. 			</div>
    357. 

  357. 	
    358. 

  358. 		
    359. 

  359. 			
    360. 

  360. 	</div>
    361. 

  361. <a name="methodcreate_assoc_table" id="create_assoc_table"><!-- --></a>
    362. 

  362. <div class="evenrow">
    363. 

  363. 	
    364. 

  364. 	<div class="method-header">
    365. 

  365. 		<span class="method-title">create_assoc_table</span> (line <span class="line-number">321</span>)
    366. 

  366. 	</div> 
    367. 

  367. 	
    368. 

  368. 	<!-- ========== Info from phpDoc block ========= -->
    369. 

  369. 	
    370. 

  370. 	<div class="method-signature">
    371. 

  371. 		<span class="method-result">void</span>
    372. 

  372. 		<span class="method-name">
    373. 

  373. 			create_assoc_table
    374. 

  374. 		</span>
    375. 

  375. 				()
    376. 

  376. 			</div>
    377. 

  377. 	
    378. 

  378. 		
    379. 

  379. 			
    380. 

  380. 	</div>
    381. 

  381. <a name="methodcreate_nonce_table" id="create_nonce_table"><!-- --></a>
    382. 

  382. <div class="oddrow">
    383. 

  383. 	
    384. 

  384. 	<div class="method-header">
    385. 

  385. 		<span class="method-title">create_nonce_table</span> (line <span class="line-number">312</span>)
    386. 

  386. 	</div> 
    387. 

  387. 	
    388. 

  388. 	<!-- ========== Info from phpDoc block ========= -->
    389. 

  389. 	
    390. 

  390. 	<div class="method-signature">
    391. 

  391. 		<span class="method-result">void</span>
    392. 

  392. 		<span class="method-name">
    393. 

  393. 			create_nonce_table
    394. 

  394. 		</span>
    395. 

  395. 				()
    396. 

  396. 			</div>
    397. 

  397. 	
    398. 

  398. 		
    399. 

  399. 			
    400. 

  400. 	</div>
    401. 

  401. <a name="methodgetAssociation" id="getAssociation"><!-- --></a>
    402. 

  402. <div class="evenrow">
    403. 

  403. 	
    404. 

  404. 	<div class="method-header">
    405. 

  405. 		<span class="method-title">getAssociation</span> (line <span class="line-number">409</span>)
    406. 

  406. 	</div> 
    407. 

  407. 	
    408. 

  408. 	<!-- ========== Info from phpDoc block ========= -->
    409. 

  409. 	
    410. 

  410. 	<div class="method-signature">
    411. 

  411. 		<span class="method-result">void</span>
    412. 

  412. 		<span class="method-name">
    413. 

  413. 			getAssociation
    414. 

  414. 		</span>
    415. 

  415. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$handle</span> = <span class="var-default">null</span>])
    416. 

  416. 			</div>
    417. 

  417. 	
    418. 

  418. 			<ul class="parameters">
    419. 

  419. 					<li>
    420. 

  420. 				<span class="var-type"></span>
    421. 

  421. 				<span class="var-name">$server_url</span>			</li>
    422. 

  422. 					<li>
    423. 

  423. 				<span class="var-type"></span>
    424. 

  424. 				<span class="var-name">$handle</span>			</li>
    425. 

  425. 				</ul>
    426. 

  426. 		
    427. 

  427. 			<hr class="separator" />
    428. 

  428. 		<div class="notes">Redefinition of:</div>
    429. 

  429. 		<dl>
    430. 

  430. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodgetAssociation">Auth_OpenID_OpenIDStore::getAssociation()</a></dt>
    431. 

  431. 						<dd>This method returns an Association object from storage that  matches the server URL and, if specified, handle. It returns  null if no such association is found or if the matching  association is expired.</dd>
    432. 

  432. 					</dl>
    433. 

  433. 			
    434. 

  434. 	</div>
    435. 

  435. <a name="methodisError" id="isError"><!-- --></a>
    436. 

  436. <div class="oddrow">
    437. 

  437. 	
    438. 

  438. 	<div class="method-header">
    439. 

  439. 		<span class="method-title">isError</span> (line <span class="line-number">179</span>)
    440. 

  440. 	</div> 
    441. 

  441. 	
    442. 

  442. 	<!-- ========== Info from phpDoc block ========= -->
    443. 

  443. <p class="short-description">Returns true if $value constitutes a database error; returns  false otherwise.</p>
    444. 

  444. 	
    445. 

  445. 	<div class="method-signature">
    446. 

  446. 		<span class="method-result">void</span>
    447. 

  447. 		<span class="method-name">
    448. 

  448. 			isError
    449. 

  449. 		</span>
    450. 

  450. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
    451. 

  451. 			</div>
    452. 

  452. 	
    453. 

  453. 			<ul class="parameters">
    454. 

  454. 					<li>
    455. 

  455. 				<span class="var-type"></span>
    456. 

  456. 				<span class="var-name">$value</span>			</li>
    457. 

  457. 				</ul>
    458. 

  458. 		
    459. 

  459. 			
    460. 

  460. 	</div>
    461. 

  461. <a name="methodremoveAssociation" id="removeAssociation"><!-- --></a>
    462. 

  462. <div class="evenrow">
    463. 

  463. 	
    464. 

  464. 	<div class="method-header">
    465. 

  465. 		<span class="method-title">removeAssociation</span> (line <span class="line-number">392</span>)
    466. 

  466. 	</div> 
    467. 

  467. 	
    468. 

  468. 	<!-- ========== Info from phpDoc block ========= -->
    469. 

  469. 	
    470. 

  470. 	<div class="method-signature">
    471. 

  471. 		<span class="method-result">void</span>
    472. 

  472. 		<span class="method-name">
    473. 

  473. 			removeAssociation
    474. 

  474. 		</span>
    475. 

  475. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$handle</span>)
    476. 

  476. 			</div>
    477. 

  477. 	
    478. 

  478. 			<ul class="parameters">
    479. 

  479. 					<li>
    480. 

  480. 				<span class="var-type"></span>
    481. 

  481. 				<span class="var-name">$server_url</span>			</li>
    482. 

  482. 					<li>
    483. 

  483. 				<span class="var-type"></span>
    484. 

  484. 				<span class="var-name">$handle</span>			</li>
    485. 

  485. 				</ul>
    486. 

  486. 		
    487. 

  487. 			<hr class="separator" />
    488. 

  488. 		<div class="notes">Redefinition of:</div>
    489. 

  489. 		<dl>
    490. 

  490. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodremoveAssociation">Auth_OpenID_OpenIDStore::removeAssociation()</a></dt>
    491. 

  491. 						<dd>This method removes the matching association if it's found, and  returns whether the association was removed or not.</dd>
    492. 

  492. 					</dl>
    493. 

  493. 			
    494. 

  494. 	</div>
    495. 

  495. <a name="methodreset" id="reset"><!-- --></a>
    496. 

  496. <div class="oddrow">
    497. 

  497. 	
    498. 

  498. 	<div class="method-header">
    499. 

  499. 		<span class="method-title">reset</span> (line <span class="line-number">211</span>)
    500. 

  500. 	</div> 
    501. 

  501. 	
    502. 

  502. 	<!-- ========== Info from phpDoc block ========= -->
    503. 

  503. <p class="short-description">Resets the store by removing all records from the store's  tables.</p>
    504. 

  504. 	
    505. 

  505. 	<div class="method-signature">
    506. 

  506. 		<span class="method-result">void</span>
    507. 

  507. 		<span class="method-name">
    508. 

  508. 			reset
    509. 

  509. 		</span>
    510. 

  510. 				()
    511. 

  511. 			</div>
    512. 

  512. 	
    513. 

  513. 		
    514. 

  514. 			<hr class="separator" />
    515. 

  515. 		<div class="notes">Redefinition of:</div>
    516. 

  516. 		<dl>
    517. 

  517. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodreset">Auth_OpenID_OpenIDStore::reset()</a></dt>
    518. 

  518. 						<dd>Removes all entries from the store; implementation is optional.</dd>
    519. 

  519. 					</dl>
    520. 

  520. 			
    521. 

  521. 	</div>
    522. 

  522. <a name="methodresultToBool" id="resultToBool"><!-- --></a>
    523. 

  523. <div class="evenrow">
    524. 

  524. 	
    525. 

  525. 	<div class="method-header">
    526. 

  526. 		<span class="method-title">resultToBool</span> (line <span class="line-number">189</span>)
    527. 

  527. 	</div> 
    528. 

  528. 	
    529. 

  529. 	<!-- ========== Info from phpDoc block ========= -->
    530. 

  530. <p class="short-description">Converts a query result to a boolean.  If the result is a  database error according to $this-&gt;isError(), this returns  false; otherwise, this returns true.</p>
    531. 

  531. 	
    532. 

  532. 	<div class="method-signature">
    533. 

  533. 		<span class="method-result">void</span>
    534. 

  534. 		<span class="method-name">
    535. 

  535. 			resultToBool
    536. 

  536. 		</span>
    537. 

  537. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
    538. 

  538. 			</div>
    539. 

  539. 	
    540. 

  540. 			<ul class="parameters">
    541. 

  541. 					<li>
    542. 

  542. 				<span class="var-type"></span>
    543. 

  543. 				<span class="var-name">$obj</span>			</li>
    544. 

  544. 				</ul>
    545. 

  545. 		
    546. 

  546. 			
    547. 

  547. 	</div>
    548. 

  548. <a name="methodsetSQL" id="setSQL"><!-- --></a>
    549. 

  549. <div class="oddrow">
    550. 

  550. 	
    551. 

  551. 	<div class="method-header">
    552. 

  552. 		<span class="method-title">setSQL</span> (line <span class="line-number">203</span>)
    553. 

  553. 	</div> 
    554. 

  554. 	
    555. 

  555. 	<!-- ========== Info from phpDoc block ========= -->
    556. 

  556. <p class="short-description">This method should be overridden by subclasses.  This method is  called by the constructor to set values in $this-&gt;sql, which is  an array keyed on sql name.</p>
    557. 

  557. 	
    558. 

  558. 	<div class="method-signature">
    559. 

  559. 		<span class="method-result">void</span>
    560. 

  560. 		<span class="method-name">
    561. 

  561. 			setSQL
    562. 

  562. 		</span>
    563. 

  563. 				()
    564. 

  564. 			</div>
    565. 

  565. 	
    566. 

  566. 		
    567. 

  567. 			
    568. 

  568. 			<hr class="separator" />
    569. 

  569. 		<div class="notes">Redefined in descendants as:</div>
    570. 

  570. 		<ul class="redefinitions">
    571. 

  571. 					<li>
    572. 

  572. 				<a href="../OpenID/Auth_OpenID_SQLiteStore.html#methodsetSQL">Auth_OpenID_SQLiteStore::setSQL()</a>
    573. 

  573. 							</li>
    574. 

  574. 				</ul>
    575. 

  575. 	</div>
    576. 

  576. <a name="methodstoreAssociation" id="storeAssociation"><!-- --></a>
    577. 

  577. <div class="evenrow">
    578. 

  578. 	
    579. 

  579. 	<div class="method-header">
    580. 

  580. 		<span class="method-title">storeAssociation</span> (line <span class="line-number">346</span>)
    581. 

  581. 	</div> 
    582. 

  582. 	
    583. 

  583. 	<!-- ========== Info from phpDoc block ========= -->
    584. 

  584. 	
    585. 

  585. 	<div class="method-signature">
    586. 

  586. 		<span class="method-result">void</span>
    587. 

  587. 		<span class="method-name">
    588. 

  588. 			storeAssociation
    589. 

  589. 		</span>
    590. 

  590. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$association</span>)
    591. 

  591. 			</div>
    592. 

  592. 	
    593. 

  593. 			<ul class="parameters">
    594. 

  594. 					<li>
    595. 

  595. 				<span class="var-type"></span>
    596. 

  596. 				<span class="var-name">$server_url</span>			</li>
    597. 

  597. 					<li>
    598. 

  598. 				<span class="var-type"></span>
    599. 

  599. 				<span class="var-name">$association</span>			</li>
    600. 

  600. 				</ul>
    601. 

  601. 		
    602. 

  602. 			<hr class="separator" />
    603. 

  603. 		<div class="notes">Redefinition of:</div>
    604. 

  604. 		<dl>
    605. 

  605. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodstoreAssociation">Auth_OpenID_OpenIDStore::storeAssociation()</a></dt>
    606. 

  606. 						<dd>This method puts an Association object into storage,  retrievable by server URL and handle.</dd>
    607. 

  607. 					</dl>
    608. 

  608. 			
    609. 

  609. 	</div>
    610. 

  610. <a name="methodtableExists" id="tableExists"><!-- --></a>
    611. 

  611. <div class="oddrow">
    612. 

  612. 	
    613. 

  613. 	<div class="method-header">
    614. 

  614. 		<span class="method-title">tableExists</span> (line <span class="line-number">167</span>)
    615. 

  615. 	</div> 
    616. 

  616. 	
    617. 

  617. 	<!-- ========== Info from phpDoc block ========= -->
    618. 

  618. 	
    619. 

  619. 	<div class="method-signature">
    620. 

  620. 		<span class="method-result">void</span>
    621. 

  621. 		<span class="method-name">
    622. 

  622. 			tableExists
    623. 

  623. 		</span>
    624. 

  624. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$table_name</span>)
    625. 

  625. 			</div>
    626. 

  626. 	
    627. 

  627. 			<ul class="parameters">
    628. 

  628. 					<li>
    629. 

  629. 				<span class="var-type"></span>
    630. 

  630. 				<span class="var-name">$table_name</span>			</li>
    631. 

  631. 				</ul>
    632. 

  632. 		
    633. 

  633. 			
    634. 

  634. 	</div>
    635. 

  635. <a name="methoduseNonce" id="useNonce"><!-- --></a>
    636. 

  636. <div class="evenrow">
    637. 

  637. 	
    638. 

  638. 	<div class="method-header">
    639. 

  639. 		<span class="method-title">useNonce</span> (line <span class="line-number">480</span>)
    640. 

  640. 	</div> 
    641. 

  641. 	
    642. 

  642. 	<!-- ========== Info from phpDoc block ========= -->
    643. 

  643. 	
    644. 

  644. 	<div class="method-signature">
    645. 

  645. 		<span class="method-result">void</span>
    646. 

  646. 		<span class="method-name">
    647. 

  647. 			useNonce
    648. 

  648. 		</span>
    649. 

  649. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$timestamp</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$salt</span>)
    650. 

  650. 			</div>
    651. 

  651. 	
    652. 

  652. 			<ul class="parameters">
    653. 

  653. 					<li>
    654. 

  654. 				<span class="var-type"></span>
    655. 

  655. 				<span class="var-name">$server_url</span>			</li>
    656. 

  656. 					<li>
    657. 

  657. 				<span class="var-type"></span>
    658. 

  658. 				<span class="var-name">$timestamp</span>			</li>
    659. 

  659. 					<li>
    660. 

  660. 				<span class="var-type"></span>
    661. 

  661. 				<span class="var-name">$salt</span>			</li>
    662. 

  662. 				</ul>
    663. 

  663. 		
    664. 

  664. 			<hr class="separator" />
    665. 

  665. 		<div class="notes">Redefinition of:</div>
    666. 

  666. 		<dl>
    667. 

  667. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methoduseNonce">Auth_OpenID_OpenIDStore::useNonce()</a></dt>
    668. 

  668. 						<dd>Called when using a nonce.</dd>
    669. 

  669. 					</dl>
    670. 

  670. 			
    671. 

  671. 	</div>
    672. 

  672. 							<h4>Inherited Methods</h4>
    673. 

  673. 				<a name='inherited_methods'><!-- --></a>	
    674. 

  674. 									<!-- =========== Summary =========== -->
    675. 

  675. 					<p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a></span></p>
    676. 

  676. 					<blockquote>
    677. 

  677. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanup">Auth_OpenID_OpenIDStore::cleanup()</a></span><br>
    678. 

  678. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupAssociations">Auth_OpenID_OpenIDStore::cleanupAssociations()</a></span><br>
    679. 

  679. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupNonces">Auth_OpenID_OpenIDStore::cleanupNonces()</a></span><br>
    680. 

  680. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodgetAssociation">Auth_OpenID_OpenIDStore::getAssociation()</a></span><br>
    681. 

  681. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodremoveAssociation">Auth_OpenID_OpenIDStore::removeAssociation()</a></span><br>
    682. 

  682. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodreset">Auth_OpenID_OpenIDStore::reset()</a></span><br>
    683. 

  683. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodstoreAssociation">Auth_OpenID_OpenIDStore::storeAssociation()</a></span><br>
    684. 

  684. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodsupportsCleanup">Auth_OpenID_OpenIDStore::supportsCleanup()</a></span><br>
    685. 

  685. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methoduseNonce">Auth_OpenID_OpenIDStore::useNonce()</a></span><br>
    686. 

  686. 											</blockquote>
    687. 

  687. 										
    688. 

  688. 		</div>
    689. 

  689. 	</div>
    690. 

  690. 

  691. 

  692. 	<p class="notes" id="credit">
    693. 

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

  694. 	</p>
    695. 

  695. 	</div></body>
    696. 

  696. </html>
    697.