Auth_OpenID_SQLStore.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class Auth_OpenID_SQLStore</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <div class="page-body">
  12. <h2 class="class-name">Class Auth_OpenID_SQLStore</h2>
  13. <a name="sec-description"></a>
  14. <div class="info-box">
  15. <div class="info-box-title">Description</div>
  16. <div class="nav-bar">
  17. <span class="disabled">Description</span> |
  18. <a href="#sec-descendents">Descendents</a>
  19. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20. </div>
  21. <div class="info-box-body">
  22. <!-- ========== Info from phpDoc block ========= -->
  23. <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>
  24. <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>
  25. <ul class="tags">
  26. <li><span class="field">author:</span> JanRain, Inc. &lt;<a href="mailto:openid@janrain.com">openid@janrain.com</a>&gt;</li>
  27. </ul>
  28. <p class="notes">
  29. Located in <a class="field" href="_Auth---OpenID---SQLStore.php.html">/Auth/OpenID/SQLStore.php</a> (line <span class="field">67</span>)
  30. </p>
  31. <pre><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a>
  32. |
  33. --Auth_OpenID_SQLStore</pre>
  34. </div>
  35. </div>
  36. <a name="sec-descendents"></a>
  37. <div class="info-box">
  38. <div class="info-box-title">Direct descendents</div>
  39. <div class="nav-bar">
  40. <a href="#sec-description">Description</a> |
  41. <span class="disabled">Descendents</span>
  42. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  43. </div>
  44. <div class="info-box-body">
  45. <table cellpadding="2" cellspacing="0" class="class-table">
  46. <tr>
  47. <th class="class-table-header">Class</th>
  48. <th class="class-table-header">Description</th>
  49. </tr>
  50. <tr>
  51. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_PostgreSQLStore.html">Auth_OpenID_PostgreSQLStore</a></td>
  52. <td>
  53. An SQL store that uses PostgreSQL as its backend.
  54. </td>
  55. </tr>
  56. <tr>
  57. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_MySQLStore.html">Auth_OpenID_MySQLStore</a></td>
  58. <td>
  59. An SQL store that uses MySQL as its backend.
  60. </td>
  61. </tr>
  62. <tr>
  63. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_SQLiteStore.html">Auth_OpenID_SQLiteStore</a></td>
  64. <td>
  65. An SQL store that uses SQLite as its backend.
  66. </td>
  67. </tr>
  68. </table>
  69. </div>
  70. </div>
  71. <a name="sec-method-summary"></a>
  72. <div class="info-box">
  73. <div class="info-box-title">Method Summary</span></div>
  74. <div class="nav-bar">
  75. <a href="#sec-description">Description</a> |
  76. <a href="#sec-descendents">Descendents</a> |
  77. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  78. </div>
  79. <div class="info-box-body">
  80. <div class="method-summary">
  81. <div class="method-definition">
  82. <span class="method-result">Auth_OpenID_SQLStore</span>
  83. <a href="#Auth_OpenID_SQLStore" title="details" class="method-name">Auth_OpenID_SQLStore</a>
  84. (<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>])
  85. </div>
  86. <div class="method-definition">
  87. <span class="method-result">void</span>
  88. <a href="#blobDecode" title="details" class="method-name">blobDecode</a>
  89. (<span class="var-type"></span>&nbsp;<span class="var-name">$blob</span>)
  90. </div>
  91. <div class="method-definition">
  92. <span class="method-result">void</span>
  93. <a href="#blobEncode" title="details" class="method-name">blobEncode</a>
  94. (<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>)
  95. </div>
  96. <div class="method-definition">
  97. <span class="method-result">void</span>
  98. <a href="#cleanupAssociations" title="details" class="method-name">cleanupAssociations</a>
  99. ()
  100. </div>
  101. <div class="method-definition">
  102. <span class="method-result">void</span>
  103. <a href="#cleanupNonces" title="details" class="method-name">cleanupNonces</a>
  104. ()
  105. </div>
  106. <div class="method-definition">
  107. <span class="method-result">void</span>
  108. <a href="#createTables" title="details" class="method-name">createTables</a>
  109. ()
  110. </div>
  111. <div class="method-definition">
  112. <span class="method-result">void</span>
  113. <a href="#create_assoc_table" title="details" class="method-name">create_assoc_table</a>
  114. ()
  115. </div>
  116. <div class="method-definition">
  117. <span class="method-result">void</span>
  118. <a href="#create_nonce_table" title="details" class="method-name">create_nonce_table</a>
  119. ()
  120. </div>
  121. <div class="method-definition">
  122. <span class="method-result">void</span>
  123. <a href="#getAssociation" title="details" class="method-name">getAssociation</a>
  124. (<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>])
  125. </div>
  126. <div class="method-definition">
  127. <span class="method-result">void</span>
  128. <a href="#isError" title="details" class="method-name">isError</a>
  129. (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  130. </div>
  131. <div class="method-definition">
  132. <span class="method-result">void</span>
  133. <a href="#removeAssociation" title="details" class="method-name">removeAssociation</a>
  134. (<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>)
  135. </div>
  136. <div class="method-definition">
  137. <span class="method-result">void</span>
  138. <a href="#reset" title="details" class="method-name">reset</a>
  139. ()
  140. </div>
  141. <div class="method-definition">
  142. <span class="method-result">void</span>
  143. <a href="#resultToBool" title="details" class="method-name">resultToBool</a>
  144. (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
  145. </div>
  146. <div class="method-definition">
  147. <span class="method-result">void</span>
  148. <a href="#setSQL" title="details" class="method-name">setSQL</a>
  149. ()
  150. </div>
  151. <div class="method-definition">
  152. <span class="method-result">void</span>
  153. <a href="#storeAssociation" title="details" class="method-name">storeAssociation</a>
  154. (<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>)
  155. </div>
  156. <div class="method-definition">
  157. <span class="method-result">void</span>
  158. <a href="#tableExists" title="details" class="method-name">tableExists</a>
  159. (<span class="var-type"></span>&nbsp;<span class="var-name">$table_name</span>)
  160. </div>
  161. <div class="method-definition">
  162. <span class="method-result">void</span>
  163. <a href="#useNonce" title="details" class="method-name">useNonce</a>
  164. (<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>)
  165. </div>
  166. </div>
  167. </div>
  168. </div>
  169. <a name="sec-methods"></a>
  170. <div class="info-box">
  171. <div class="info-box-title">Methods</div>
  172. <div class="nav-bar">
  173. <a href="#sec-description">Description</a> |
  174. <a href="#sec-descendents">Descendents</a> |
  175. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  176. </div>
  177. <div class="info-box-body">
  178. <A NAME='method_detail'></A>
  179. <a name="methodAuth_OpenID_SQLStore" id="Auth_OpenID_SQLStore"><!-- --></a>
  180. <div class="evenrow">
  181. <div class="method-header">
  182. <span class="method-title">Constructor Auth_OpenID_SQLStore</span> (line <span class="line-number">88</span>)
  183. </div>
  184. <!-- ========== Info from phpDoc block ========= -->
  185. <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>
  186. <div class="method-signature">
  187. <span class="method-result">Auth_OpenID_SQLStore</span>
  188. <span class="method-name">
  189. Auth_OpenID_SQLStore
  190. </span>
  191. (<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>])
  192. </div>
  193. <ul class="parameters">
  194. <li>
  195. <span class="var-type">connection</span>
  196. <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>
  197. <li>
  198. <span class="var-type">associations_table:</span>
  199. <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>
  200. <li>
  201. <span class="var-type">nonces_table:</span>
  202. <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>
  203. </ul>
  204. </div>
  205. <a name="methodblobDecode" id="blobDecode"><!-- --></a>
  206. <div class="oddrow">
  207. <div class="method-header">
  208. <span class="method-title">blobDecode</span> (line <span class="line-number">288</span>)
  209. </div>
  210. <!-- ========== Info from phpDoc block ========= -->
  211. <div class="method-signature">
  212. <span class="method-result">void</span>
  213. <span class="method-name">
  214. blobDecode
  215. </span>
  216. (<span class="var-type"></span>&nbsp;<span class="var-name">$blob</span>)
  217. </div>
  218. <ul class="parameters">
  219. <li>
  220. <span class="var-type"></span>
  221. <span class="var-name">$blob</span> </li>
  222. </ul>
  223. </div>
  224. <a name="methodblobEncode" id="blobEncode"><!-- --></a>
  225. <div class="evenrow">
  226. <div class="method-header">
  227. <span class="method-title">blobEncode</span> (line <span class="line-number">293</span>)
  228. </div>
  229. <!-- ========== Info from phpDoc block ========= -->
  230. <div class="method-signature">
  231. <span class="method-result">void</span>
  232. <span class="method-name">
  233. blobEncode
  234. </span>
  235. (<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>)
  236. </div>
  237. <ul class="parameters">
  238. <li>
  239. <span class="var-type"></span>
  240. <span class="var-name">$str</span> </li>
  241. </ul>
  242. </div>
  243. <a name="methodcleanupAssociations" id="cleanupAssociations"><!-- --></a>
  244. <div class="oddrow">
  245. <div class="method-header">
  246. <span class="method-title">cleanupAssociations</span> (line <span class="line-number">559</span>)
  247. </div>
  248. <!-- ========== Info from phpDoc block ========= -->
  249. <div class="method-signature">
  250. <span class="method-result">void</span>
  251. <span class="method-name">
  252. cleanupAssociations
  253. </span>
  254. ()
  255. </div>
  256. <hr class="separator" />
  257. <div class="notes">Redefinition of:</div>
  258. <dl>
  259. <dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupAssociations">Auth_OpenID_OpenIDStore::cleanupAssociations()</a></dt>
  260. </dl>
  261. </div>
  262. <a name="methodcleanupNonces" id="cleanupNonces"><!-- --></a>
  263. <div class="evenrow">
  264. <div class="method-header">
  265. <span class="method-title">cleanupNonces</span> (line <span class="line-number">548</span>)
  266. </div>
  267. <!-- ========== Info from phpDoc block ========= -->
  268. <div class="method-signature">
  269. <span class="method-result">void</span>
  270. <span class="method-name">
  271. cleanupNonces
  272. </span>
  273. ()
  274. </div>
  275. <hr class="separator" />
  276. <div class="notes">Redefinition of:</div>
  277. <dl>
  278. <dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupNonces">Auth_OpenID_OpenIDStore::cleanupNonces()</a></dt>
  279. </dl>
  280. </div>
  281. <a name="methodcreateTables" id="createTables"><!-- --></a>
  282. <div class="oddrow">
  283. <div class="method-header">
  284. <span class="method-title">createTables</span> (line <span class="line-number">298</span>)
  285. </div>
  286. <!-- ========== Info from phpDoc block ========= -->
  287. <div class="method-signature">
  288. <span class="method-result">void</span>
  289. <span class="method-name">
  290. createTables
  291. </span>
  292. ()
  293. </div>
  294. </div>
  295. <a name="methodcreate_assoc_table" id="create_assoc_table"><!-- --></a>
  296. <div class="evenrow">
  297. <div class="method-header">
  298. <span class="method-title">create_assoc_table</span> (line <span class="line-number">321</span>)
  299. </div>
  300. <!-- ========== Info from phpDoc block ========= -->
  301. <div class="method-signature">
  302. <span class="method-result">void</span>
  303. <span class="method-name">
  304. create_assoc_table
  305. </span>
  306. ()
  307. </div>
  308. </div>
  309. <a name="methodcreate_nonce_table" id="create_nonce_table"><!-- --></a>
  310. <div class="oddrow">
  311. <div class="method-header">
  312. <span class="method-title">create_nonce_table</span> (line <span class="line-number">312</span>)
  313. </div>
  314. <!-- ========== Info from phpDoc block ========= -->
  315. <div class="method-signature">
  316. <span class="method-result">void</span>
  317. <span class="method-name">
  318. create_nonce_table
  319. </span>
  320. ()
  321. </div>
  322. </div>
  323. <a name="methodgetAssociation" id="getAssociation"><!-- --></a>
  324. <div class="evenrow">
  325. <div class="method-header">
  326. <span class="method-title">getAssociation</span> (line <span class="line-number">409</span>)
  327. </div>
  328. <!-- ========== Info from phpDoc block ========= -->
  329. <div class="method-signature">
  330. <span class="method-result">void</span>
  331. <span class="method-name">
  332. getAssociation
  333. </span>
  334. (<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>])
  335. </div>
  336. <ul class="parameters">
  337. <li>
  338. <span class="var-type"></span>
  339. <span class="var-name">$server_url</span> </li>
  340. <li>
  341. <span class="var-type"></span>
  342. <span class="var-name">$handle</span> </li>
  343. </ul>
  344. <hr class="separator" />
  345. <div class="notes">Redefinition of:</div>
  346. <dl>
  347. <dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodgetAssociation">Auth_OpenID_OpenIDStore::getAssociation()</a></dt>
  348. <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>
  349. </dl>
  350. </div>
  351. <a name="methodisError" id="isError"><!-- --></a>
  352. <div class="oddrow">
  353. <div class="method-header">
  354. <span class="method-title">isError</span> (line <span class="line-number">179</span>)
  355. </div>
  356. <!-- ========== Info from phpDoc block ========= -->
  357. <p class="short-description">Returns true if $value constitutes a database error; returns false otherwise.</p>
  358. <div class="method-signature">
  359. <span class="method-result">void</span>
  360. <span class="method-name">
  361. isError
  362. </span>
  363. (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  364. </div>
  365. <ul class="parameters">
  366. <li>
  367. <span class="var-type"></span>
  368. <span class="var-name">$value</span> </li>
  369. </ul>
  370. </div>
  371. <a name="methodremoveAssociation" id="removeAssociation"><!-- --></a>
  372. <div class="evenrow">
  373. <div class="method-header">
  374. <span class="method-title">removeAssociation</span> (line <span class="line-number">392</span>)
  375. </div>
  376. <!-- ========== Info from phpDoc block ========= -->
  377. <div class="method-signature">
  378. <span class="method-result">void</span>
  379. <span class="method-name">
  380. removeAssociation
  381. </span>
  382. (<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>)
  383. </div>
  384. <ul class="parameters">
  385. <li>
  386. <span class="var-type"></span>
  387. <span class="var-name">$server_url</span> </li>
  388. <li>
  389. <span class="var-type"></span>
  390. <span class="var-name">$handle</span> </li>
  391. </ul>
  392. <hr class="separator" />
  393. <div class="notes">Redefinition of:</div>
  394. <dl>
  395. <dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodremoveAssociation">Auth_OpenID_OpenIDStore::removeAssociation()</a></dt>
  396. <dd>This method removes the matching association if it's found, and returns whether the association was removed or not.</dd>
  397. </dl>
  398. </div>
  399. <a name="methodreset" id="reset"><!-- --></a>
  400. <div class="oddrow">
  401. <div class="method-header">
  402. <span class="method-title">reset</span> (line <span class="line-number">211</span>)
  403. </div>
  404. <!-- ========== Info from phpDoc block ========= -->
  405. <p class="short-description">Resets the store by removing all records from the store's tables.</p>
  406. <div class="method-signature">
  407. <span class="method-result">void</span>
  408. <span class="method-name">
  409. reset
  410. </span>
  411. ()
  412. </div>
  413. <hr class="separator" />
  414. <div class="notes">Redefinition of:</div>
  415. <dl>
  416. <dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodreset">Auth_OpenID_OpenIDStore::reset()</a></dt>
  417. <dd>Removes all entries from the store; implementation is optional.</dd>
  418. </dl>
  419. </div>
  420. <a name="methodresultToBool" id="resultToBool"><!-- --></a>
  421. <div class="evenrow">
  422. <div class="method-header">
  423. <span class="method-title">resultToBool</span> (line <span class="line-number">189</span>)
  424. </div>
  425. <!-- ========== Info from phpDoc block ========= -->
  426. <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>
  427. <div class="method-signature">
  428. <span class="method-result">void</span>
  429. <span class="method-name">
  430. resultToBool
  431. </span>
  432. (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
  433. </div>
  434. <ul class="parameters">
  435. <li>
  436. <span class="var-type"></span>
  437. <span class="var-name">$obj</span> </li>
  438. </ul>
  439. </div>
  440. <a name="methodsetSQL" id="setSQL"><!-- --></a>
  441. <div class="oddrow">
  442. <div class="method-header">
  443. <span class="method-title">setSQL</span> (line <span class="line-number">203</span>)
  444. </div>
  445. <!-- ========== Info from phpDoc block ========= -->
  446. <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>
  447. <div class="method-signature">
  448. <span class="method-result">void</span>
  449. <span class="method-name">
  450. setSQL
  451. </span>
  452. ()
  453. </div>
  454. <hr class="separator" />
  455. <div class="notes">Redefined in descendants as:</div>
  456. <ul class="redefinitions">
  457. <li>
  458. <a href="../OpenID/Auth_OpenID_SQLiteStore.html#methodsetSQL">Auth_OpenID_SQLiteStore::setSQL()</a>
  459. </li>
  460. </ul>
  461. </div>
  462. <a name="methodstoreAssociation" id="storeAssociation"><!-- --></a>
  463. <div class="evenrow">
  464. <div class="method-header">
  465. <span class="method-title">storeAssociation</span> (line <span class="line-number">346</span>)
  466. </div>
  467. <!-- ========== Info from phpDoc block ========= -->
  468. <div class="method-signature">
  469. <span class="method-result">void</span>
  470. <span class="method-name">
  471. storeAssociation
  472. </span>
  473. (<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>)
  474. </div>
  475. <ul class="parameters">
  476. <li>
  477. <span class="var-type"></span>
  478. <span class="var-name">$server_url</span> </li>
  479. <li>
  480. <span class="var-type"></span>
  481. <span class="var-name">$association</span> </li>
  482. </ul>
  483. <hr class="separator" />
  484. <div class="notes">Redefinition of:</div>
  485. <dl>
  486. <dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodstoreAssociation">Auth_OpenID_OpenIDStore::storeAssociation()</a></dt>
  487. <dd>This method puts an Association object into storage, retrievable by server URL and handle.</dd>
  488. </dl>
  489. </div>
  490. <a name="methodtableExists" id="tableExists"><!-- --></a>
  491. <div class="oddrow">
  492. <div class="method-header">
  493. <span class="method-title">tableExists</span> (line <span class="line-number">167</span>)
  494. </div>
  495. <!-- ========== Info from phpDoc block ========= -->
  496. <div class="method-signature">
  497. <span class="method-result">void</span>
  498. <span class="method-name">
  499. tableExists
  500. </span>
  501. (<span class="var-type"></span>&nbsp;<span class="var-name">$table_name</span>)
  502. </div>
  503. <ul class="parameters">
  504. <li>
  505. <span class="var-type"></span>
  506. <span class="var-name">$table_name</span> </li>
  507. </ul>
  508. </div>
  509. <a name="methoduseNonce" id="useNonce"><!-- --></a>
  510. <div class="evenrow">
  511. <div class="method-header">
  512. <span class="method-title">useNonce</span> (line <span class="line-number">480</span>)
  513. </div>
  514. <!-- ========== Info from phpDoc block ========= -->
  515. <div class="method-signature">
  516. <span class="method-result">void</span>
  517. <span class="method-name">
  518. useNonce
  519. </span>
  520. (<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>)
  521. </div>
  522. <ul class="parameters">
  523. <li>
  524. <span class="var-type"></span>
  525. <span class="var-name">$server_url</span> </li>
  526. <li>
  527. <span class="var-type"></span>
  528. <span class="var-name">$timestamp</span> </li>
  529. <li>
  530. <span class="var-type"></span>
  531. <span class="var-name">$salt</span> </li>
  532. </ul>
  533. <hr class="separator" />
  534. <div class="notes">Redefinition of:</div>
  535. <dl>
  536. <dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methoduseNonce">Auth_OpenID_OpenIDStore::useNonce()</a></dt>
  537. <dd>Called when using a nonce.</dd>
  538. </dl>
  539. </div>
  540. <h4>Inherited Methods</h4>
  541. <a name='inherited_methods'><!-- --></a>
  542. <!-- =========== Summary =========== -->
  543. <p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a></span></p>
  544. <blockquote>
  545. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanup">Auth_OpenID_OpenIDStore::cleanup()</a></span><br>
  546. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupAssociations">Auth_OpenID_OpenIDStore::cleanupAssociations()</a></span><br>
  547. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupNonces">Auth_OpenID_OpenIDStore::cleanupNonces()</a></span><br>
  548. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodgetAssociation">Auth_OpenID_OpenIDStore::getAssociation()</a></span><br>
  549. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodremoveAssociation">Auth_OpenID_OpenIDStore::removeAssociation()</a></span><br>
  550. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodreset">Auth_OpenID_OpenIDStore::reset()</a></span><br>
  551. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodstoreAssociation">Auth_OpenID_OpenIDStore::storeAssociation()</a></span><br>
  552. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodsupportsCleanup">Auth_OpenID_OpenIDStore::supportsCleanup()</a></span><br>
  553. <span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methoduseNonce">Auth_OpenID_OpenIDStore::useNonce()</a></span><br>
  554. </blockquote>
  555. </div>
  556. </div>
  557. <p class="notes" id="credit">
  558. 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>
  559. </p>
  560. </div></body>
  561. </html>