PageRenderTime 52ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/MegaCache/CachePdo.html

https://github.com/TimBroddin/MegaCache
HTML | 367 lines | 300 code | 58 blank | 9 comment | 0 complexity | 461c7fee88144bf00825e3390374913a MD5 | raw file
Possible License(s): LGPL-3.0 
    

  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 CachePdo</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 CachePdo</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-vars">Vars</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">CachePdo class.</p>
    26. 

  26. <p class="description"><p>Uses the PDO extension which makes it possible to connect to a number of different database systems.  Only tested against MySQL but should work on others</p></p>
    27. 

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

  28. 				<li><span class="field">author:</span> Tim Broddin &lt;<a href="mailto:tim@brodd.in">tim@brodd.in</a>&gt;</li>
    29. 

  29. 				<li><span class="field">extends:</span> BaseCache</li>
    30. 

  30. 			</ul>
    31. 

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

  32. 			Located in <a class="field" href="_adapters---CachePdo.php.html">/adapters/CachePdo.php</a> (line <span class="field">20</span>)
    33. 

  33. 		</p>
    34. 

  34. 		
    35. 

  35. 				
    36. 

  36. 		<pre><a href="../MegaCache/BaseCache.html">BaseCache</a>
    37. 

  37.    |
    38. 

  38.    --CachePdo</pre>
    39. 

  39. 	
    40. 

  40. 			</div>
    41. 

  41. </div>
    42. 

  42. 

  43. 

  44. 

  45. 

  46. 	<a name="sec-method-summary"></a>
    47. 

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

  48. 		<div class="info-box-title">Method Summary</span></div>
    49. 

  49. 		<div class="nav-bar">
    50. 

  50. 			<a href="#sec-description">Description</a> |
    51. 

  51. 																		<a href="#sec-vars">Vars</a>
    52. 

  52. 				 
    53. 

  53. 				|
    54. 

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

  55. 		</div>
    56. 

  56. 		<div class="info-box-body">			
    57. 

  57. 			<div class="method-summary">
    58. 

  58. 																																																				
    59. 

  59. 												<div class="method-definition">
    60. 

  60. 											<span class="method-result">void</span>
    61. 

  61. 										<a href="#__construct" title="details" class="method-name">__construct</a>
    62. 

  62. 											(<span class="var-type">array</span>&nbsp;<span class="var-name">$config</span>)
    63. 

  63. 									</div>
    64. 

  64. 																<div class="method-definition">
    65. 

  65. 											<span class="method-result">void</span>
    66. 

  66. 										<a href="#__destruct" title="details" class="method-name">__destruct</a>
    67. 

  67. 										()
    68. 

  68. 									</div>
    69. 

  69. 																<div class="method-definition">
    70. 

  70. 											<span class="method-result">void</span>
    71. 

  71. 										<a href="#clearTimedOut" title="details" class="method-name">clearTimedOut</a>
    72. 

  72. 										()
    73. 

  73. 									</div>
    74. 

  74. 																<div class="method-definition">
    75. 

  75. 											<span class="method-result">bool</span>
    76. 

  76. 										<a href="#delete" title="details" class="method-name">delete</a>
    77. 

  77. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$varName</span>)
    78. 

  78. 									</div>
    79. 

  79. 																<div class="method-definition">
    80. 

  80. 											<span class="method-result">mixed</span>
    81. 

  81. 										<a href="#get" title="details" class="method-name">get</a>
    82. 

  82. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$varName</span>)
    83. 

  83. 									</div>
    84. 

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

  85. 											<span class="method-result">bool</span>
    86. 

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

  87. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$varName</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">0</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$timeout.</span>)
    88. 

  88. 									</div>
    89. 

  89. 								</div>
    90. 

  90. 		</div>
    91. 

  91. 	</div>		
    92. 

  92. 

  93. 	<a name="sec-vars"></a>
    94. 

  94. 	<div class="info-box">
    95. 

  95. 		<div class="info-box-title">Variables</div>
    96. 

  96. 		<div class="nav-bar">
    97. 

  97. 			<a href="#sec-description">Description</a> |
    98. 

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

  99. 						
    100. 

  100. 			
    101. 

  101. 										| 
    102. 

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

  103. 							
    104. 

  104. 					</div>
    105. 

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

  106. 										<h4>Inherited Variables</h4>
    107. 

  107. 				<A NAME='inherited_vars'><!-- --></A>
    108. 

  108. 									<p>Inherited from <span class="classname"><a href="../MegaCache/BaseCache.html">BaseCache</a></span></p>
    109. 

  109. 					<blockquote>
    110. 

  110. 													<span class="var-title">
    111. 

  111. 								<span class="var-name"><a href="../MegaCache/BaseCache.html#var$sessionStats">BaseCache::$sessionStats</a></span><br>
    112. 

  112. 							</span>
    113. 

  113. 													<span class="var-title">
    114. 

  114. 								<span class="var-name"><a href="../MegaCache/BaseCache.html#var$store">BaseCache::$store</a></span><br>
    115. 

  115. 							</span>
    116. 

  116. 											</blockquote> 
    117. 

  117. 										
    118. 

  118. 		</div>
    119. 

  119. 	</div>
    120. 

  120. 	
    121. 

  121. 	<a name="sec-methods"></a>
    122. 

  122. 	<div class="info-box">
    123. 

  123. 		<div class="info-box-title">Methods</div>
    124. 

  124. 		<div class="nav-bar">
    125. 

  125. 			<a href="#sec-description">Description</a> |
    126. 

  126. 															<a href="#sec-vars">Vars</a>
    127. 

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

  128. 						
    129. 

  129. 		</div>
    130. 

  130. 		<div class="info-box-body">
    131. 

  131. 			<A NAME='method_detail'></A>
    132. 

  132. 

  133. <a name="method__construct" id="__construct"><!-- --></a>
    134. 

  134. <div class="evenrow">
    135. 

  135. 	
    136. 

  136. 	<div class="method-header">
    137. 

  137. 		<span class="method-title">Constructor __construct</span> (line <span class="line-number">34</span>)
    138. 

  138. 	</div> 
    139. 

  139. 	
    140. 

  140. 	<!-- ========== Info from phpDoc block ========= -->
    141. 

  141. <p class="short-description">__construct function.</p>
    142. 

  142. <p class="description"><p>Configuration array can contain 3 values: <ul><li>dsn: the database source, for example: mysql:host=localhost;dbname=test</li><li>username</li><li>password</li></ul></p></p>
    143. 

  143. 	<ul class="tags">
    144. 

  144. 				<li><span class="field">access:</span> public</li>
    145. 

  145. 			</ul>
    146. 

  146. 	
    147. 

  147. 	<div class="method-signature">
    148. 

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

  149. 		<span class="method-name">
    150. 

  150. 			__construct
    151. 

  151. 		</span>
    152. 

  152. 					(<span class="var-type">array</span>&nbsp;<span class="var-name">$config</span>)
    153. 

  153. 			</div>
    154. 

  154. 	
    155. 

  155. 			<ul class="parameters">
    156. 

  156. 					<li>
    157. 

  157. 				<span class="var-type">array</span>
    158. 

  158. 				<span class="var-name">$config</span>			</li>
    159. 

  159. 				</ul>
    160. 

  160. 		
    161. 

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

  162. 		<div class="notes">Redefinition of:</div>
    163. 

  163. 		<dl>
    164. 

  164. 			<dt><a href="../MegaCache/BaseCache.html#method__construct">BaseCache::__construct()</a></dt>
    165. 

  165. 						<dd>__construct function.</dd>
    166. 

  166. 					</dl>
    167. 

  167. 			
    168. 

  168. 	</div>
    169. 

  169. <a name="method__destruct" id="__destruct"><!-- --></a>
    170. 

  170. <div class="oddrow">
    171. 

  171. 	
    172. 

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

  173. 		<span class="method-title">Destructor __destruct</span> (line <span class="line-number">134</span>)
    174. 

  174. 	</div> 
    175. 

  175. 	
    176. 

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

  177. <p class="short-description">__destruct function.</p>
    178. 

  178. 	<ul class="tags">
    179. 

  179. 				<li><span class="field">access:</span> public</li>
    180. 

  180. 			</ul>
    181. 

  181. 	
    182. 

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

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

  184. 		<span class="method-name">
    185. 

  185. 			__destruct
    186. 

  186. 		</span>
    187. 

  187. 				()
    188. 

  188. 			</div>
    189. 

  189. 	
    190. 

  190. 		
    191. 

  191. 			
    192. 

  192. 	</div>
    193. 

  193. <a name="methodclearTimedOut" id="clearTimedOut"><!-- --></a>
    194. 

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

  195. 	
    196. 

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

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

  198. 	</div> 
    199. 

  199. 	
    200. 

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

  201. <p class="short-description">clearTimedOut function.</p>
    202. 

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

  203. 				<li><span class="field">access:</span> public</li>
    204. 

  204. 			</ul>
    205. 

  205. 	
    206. 

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

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

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

  209. 			clearTimedOut
    210. 

  210. 		</span>
    211. 

  211. 				()
    212. 

  212. 			</div>
    213. 

  213. 	
    214. 

  214. 		
    215. 

  215. 			
    216. 

  216. 	</div>
    217. 

  217. <a name="methoddelete" id="delete"><!-- --></a>
    218. 

  218. <div class="oddrow">
    219. 

  219. 	
    220. 

  220. 	<div class="method-header">
    221. 

  221. 		<span class="method-title">delete</span> (line <span class="line-number">110</span>)
    222. 

  222. 	</div> 
    223. 

  223. 	
    224. 

  224. 	<!-- ========== Info from phpDoc block ========= -->
    225. 

  225. <p class="short-description">delete function.</p>
    226. 

  226. <p class="description"><p>deletes a variable</p></p>
    227. 

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

  228. 				<li><span class="field">access:</span> public</li>
    229. 

  229. 			</ul>
    230. 

  230. 	
    231. 

  231. 	<div class="method-signature">
    232. 

  232. 		<span class="method-result">bool</span>
    233. 

  233. 		<span class="method-name">
    234. 

  234. 			delete
    235. 

  235. 		</span>
    236. 

  236. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$varName</span>)
    237. 

  237. 			</div>
    238. 

  238. 	
    239. 

  239. 			<ul class="parameters">
    240. 

  240. 					<li>
    241. 

  241. 				<span class="var-type">string</span>
    242. 

  242. 				<span class="var-name">$varName</span>			</li>
    243. 

  243. 				</ul>
    244. 

  244. 		
    245. 

  245. 			<hr class="separator" />
    246. 

  246. 		<div class="notes">Redefinition of:</div>
    247. 

  247. 		<dl>
    248. 

  248. 			<dt><a href="../MegaCache/BaseCache.html#methoddelete">BaseCache::delete()</a></dt>
    249. 

  249. 						<dd>delete function. will be called from the adapter itself</dd>
    250. 

  250. 					</dl>
    251. 

  251. 			
    252. 

  252. 	</div>
    253. 

  253. <a name="methodget" id="get"><!-- --></a>
    254. 

  254. <div class="evenrow">
    255. 

  255. 	
    256. 

  256. 	<div class="method-header">
    257. 

  257. 		<span class="method-title">get</span> (line <span class="line-number">66</span>)
    258. 

  258. 	</div> 
    259. 

  259. 	
    260. 

  260. 	<!-- ========== Info from phpDoc block ========= -->
    261. 

  261. <p class="short-description">get function.</p>
    262. 

  262. <p class="description"><p>gets a variable</p></p>
    263. 

  263. 	<ul class="tags">
    264. 

  264. 				<li><span class="field">access:</span> public</li>
    265. 

  265. 			</ul>
    266. 

  266. 	
    267. 

  267. 	<div class="method-signature">
    268. 

  268. 		<span class="method-result">mixed</span>
    269. 

  269. 		<span class="method-name">
    270. 

  270. 			get
    271. 

  271. 		</span>
    272. 

  272. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$varName</span>)
    273. 

  273. 			</div>
    274. 

  274. 	
    275. 

  275. 			<ul class="parameters">
    276. 

  276. 					<li>
    277. 

  277. 				<span class="var-type">string</span>
    278. 

  278. 				<span class="var-name">$varName</span>			</li>
    279. 

  279. 				</ul>
    280. 

  280. 		
    281. 

  281. 			<hr class="separator" />
    282. 

  282. 		<div class="notes">Redefinition of:</div>
    283. 

  283. 		<dl>
    284. 

  284. 			<dt><a href="../MegaCache/BaseCache.html#methodget">BaseCache::get()</a></dt>
    285. 

  285. 						<dd>get function. will be called from the adapter itself</dd>
    286. 

  286. 					</dl>
    287. 

  287. 			
    288. 

  288. 	</div>
    289. 

  289. <a name="methodset" id="set"><!-- --></a>
    290. 

  290. <div class="oddrow">
    291. 

  291. 	
    292. 

  292. 	<div class="method-header">
    293. 

  293. 		<span class="method-title">set</span> (line <span class="line-number">92</span>)
    294. 

  294. 	</div> 
    295. 

  295. 	
    296. 

  296. 	<!-- ========== Info from phpDoc block ========= -->
    297. 

  297. <p class="short-description">set function.</p>
    298. 

  298. <p class="description"><p>sets a variable</p></p>
    299. 

  299. 	<ul class="tags">
    300. 

  300. 				<li><span class="field">access:</span> public</li>
    301. 

  301. 			</ul>
    302. 

  302. 	
    303. 

  303. 	<div class="method-signature">
    304. 

  304. 		<span class="method-result">bool</span>
    305. 

  305. 		<span class="method-name">
    306. 

  306. 			set
    307. 

  307. 		</span>
    308. 

  308. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$varName</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">0</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$timeout.</span>)
    309. 

  309. 			</div>
    310. 

  310. 	
    311. 

  311. 			<ul class="parameters">
    312. 

  312. 					<li>
    313. 

  313. 				<span class="var-type">string</span>
    314. 

  314. 				<span class="var-name">$varName</span>			</li>
    315. 

  315. 					<li>
    316. 

  316. 				<span class="var-type">mixed</span>
    317. 

  317. 				<span class="var-name">$value</span>			</li>
    318. 

  318. 					<li>
    319. 

  319. 				<span class="var-type">int</span>
    320. 

  320. 				<span class="var-name">$timeout.</span><span class="var-description">: (default: 0)</span>			</li>
    321. 

  321. 					<li>
    322. 

  322. 				<span class="var-type"></span>
    323. 

  323. 				<span class="var-name">$timeout</span>			</li>
    324. 

  324. 				</ul>
    325. 

  325. 		
    326. 

  326. 			<hr class="separator" />
    327. 

  327. 		<div class="notes">Redefinition of:</div>
    328. 

  328. 		<dl>
    329. 

  329. 			<dt><a href="../MegaCache/BaseCache.html#methodset">BaseCache::set()</a></dt>
    330. 

  330. 						<dd>set function. will be called from the adapter itself</dd>
    331. 

  331. 					</dl>
    332. 

  332. 			
    333. 

  333. 	</div>
    334. 

  334. 							<h4>Inherited Methods</h4>
    335. 

  335. 				<a name='inherited_methods'><!-- --></a>	
    336. 

  336. 									<!-- =========== Summary =========== -->
    337. 

  337. 					<p>Inherited From <span class="classname"><a href="../MegaCache/BaseCache.html">BaseCache</a></span></p>
    338. 

  338. 					<blockquote>
    339. 

  339. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#method__construct">BaseCache::__construct()</a></span><br>
    340. 

  340. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodcall">BaseCache::call()</a></span><br>
    341. 

  341. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methoddecrement">BaseCache::decrement()</a></span><br>
    342. 

  342. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methoddelete">BaseCache::delete()</a></span><br>
    343. 

  343. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodfetch">BaseCache::fetch()</a></span><br>
    344. 

  344. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodflush">BaseCache::flush()</a></span><br>
    345. 

  345. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodfragment">BaseCache::fragment()</a></span><br>
    346. 

  346. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodget">BaseCache::get()</a></span><br>
    347. 

  347. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodgetStats">BaseCache::getStats()</a></span><br>
    348. 

  348. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodglobalStats">BaseCache::globalStats()</a></span><br>
    349. 

  349. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodincrement">BaseCache::increment()</a></span><br>
    350. 

  350. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodoffsetExists">BaseCache::offsetExists()</a></span><br>
    351. 

  351. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodoffsetGet">BaseCache::offsetGet()</a></span><br>
    352. 

  352. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodoffsetSet">BaseCache::offsetSet()</a></span><br>
    353. 

  353. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodoffsetUnset">BaseCache::offsetUnset()</a></span><br>
    354. 

  354. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodsaveFragment">BaseCache::saveFragment()</a></span><br>
    355. 

  355. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodsaveStore">BaseCache::saveStore()</a></span><br>
    356. 

  356. 													<span class="method-name"><a href="../MegaCache/BaseCache.html#methodset">BaseCache::set()</a></span><br>
    357. 

  357. 											</blockquote>
    358. 

  358. 										
    359. 

  359. 		</div>
    360. 

  360. 	</div>
    361. 

  361. 

  362. 

  363. 	<p class="notes" id="credit">
    364. 

  364. 		Documentation generated on Sat, 30 Oct 2010 10:42:46 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
    365. 

  365. 	</p>
    366. 

  366. 	</div></body>
    367. 

  367. </html>
    368.