Página inicial Explorar Ajuda
Entrar
usic
/
ums
Observar 2
Favorito 0
Fork 0
Arquivos Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
ums
/
lib
/
php-openid
/
doc
/
OpenID
/
Auth_OpenID_DatabaseConnection.html

Auth_OpenID_DatabaseConnection.html 13 KB
Link permanente Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337 
  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_DatabaseConnection</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_DatabaseConnection</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">An empty base class intended to emulate PEAR connection</p>
    25. 

  25. <p class="description"><p>functionality in applications that supply their own database  abstraction mechanisms.  See <a href="../OpenID/Auth_OpenID_SQLStore.html">Auth_OpenID_SQLStore</a> for more  information.  You should subclass this class if you need to create  an SQL store that needs to access its database using an  application's database abstraction layer instead of a PEAR database  connection.  Any subclass of Auth_OpenID_DatabaseConnection MUST  adhere to the interface specified here.</p></p>
    26. 

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

  27. 			Located in <a class="field" href="_Auth---OpenID---DatabaseConnection.php.html">/Auth/OpenID/DatabaseConnection.php</a> (line <span class="field">25</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">void</span>
    51. 

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

  52. 											(<span class="var-type">bool</span>&nbsp;<span class="var-name">$mode</span>)
    53. 

  53. 									</div>
    54. 

  54. 														
    55. 

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

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

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

  58. 										()
    59. 

  59. 									</div>
    60. 

  60. 														
    61. 

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

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

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

  64. 										()
    65. 

  65. 									</div>
    66. 

  66. 														
    67. 

  67. 				<div class="method-definition">
    68. 

  68. 											<span class="method-result">array</span>
    69. 

  69. 										<a href="#getAll" title="details" class="method-name">getAll</a>
    70. 

  70. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    71. 

  71. 									</div>
    72. 

  72. 														
    73. 

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

  74. 											<span class="method-result">mixed</span>
    75. 

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

  76. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    77. 

  77. 									</div>
    78. 

  78. 														
    79. 

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

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

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

  82. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    83. 

  83. 									</div>
    84. 

  84. 														
    85. 

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

  86. 											<span class="method-result">mixed</span>
    87. 

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

  88. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    89. 

  89. 									</div>
    90. 

  90. 														
    91. 

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

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

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

  94. 										()
    95. 

  95. 									</div>
    96. 

  96. 											</div>
    97. 

  97. 		</div>
    98. 

  98. 	</div>		
    99. 

  99. 

  100. 	
    101. 

  101. 	<a name="sec-methods"></a>
    102. 

  102. 	<div class="info-box">
    103. 

  103. 		<div class="info-box-title">Methods</div>
    104. 

  104. 		<div class="nav-bar">
    105. 

  105. 			<a href="#sec-description">Description</a> |
    106. 

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

  107. 						
    108. 

  108. 		</div>
    109. 

  109. 		<div class="info-box-body">
    110. 

  110. 			<A NAME='method_detail'></A>
    111. 

  111. <a name="methodautoCommit" id="autoCommit"><!-- --></a>
    112. 

  112. <div class="evenrow">
    113. 

  113. 	
    114. 

  114. 	<div class="method-header">
    115. 

  115. 		<span class="method-title">autoCommit</span> (line <span class="line-number">32</span>)
    116. 

  116. 	</div> 
    117. 

  117. 	
    118. 

  118. 	<!-- ========== Info from phpDoc block ========= -->
    119. 

  119. <p class="short-description">Sets auto-commit mode on this database connection.</p>
    120. 

  120. 	
    121. 

  121. 	<div class="method-signature">
    122. 

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

  123. 		<span class="method-name">
    124. 

  124. 			autoCommit
    125. 

  125. 		</span>
    126. 

  126. 					(<span class="var-type">bool</span>&nbsp;<span class="var-name">$mode</span>)
    127. 

  127. 			</div>
    128. 

  128. 	
    129. 

  129. 			<ul class="parameters">
    130. 

  130. 					<li>
    131. 

  131. 				<span class="var-type">bool</span>
    132. 

  132. 				<span class="var-name">$mode</span><span class="var-description">: True if auto-commit is to be used; false if  not.</span>			</li>
    133. 

  133. 				</ul>
    134. 

  134. 		
    135. 

  135. 			
    136. 

  136. 	</div>
    137. 

  137. <a name="methodbegin" id="begin"><!-- --></a>
    138. 

  138. <div class="oddrow">
    139. 

  139. 	
    140. 

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

  141. 		<span class="method-title">begin</span> (line <span class="line-number">58</span>)
    142. 

  142. 	</div> 
    143. 

  143. 	
    144. 

  144. 	<!-- ========== Info from phpDoc block ========= -->
    145. 

  145. <p class="short-description">Starts a transaction on this connection, if supported.</p>
    146. 

  146. 	
    147. 

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

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

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

  150. 			begin
    151. 

  151. 		</span>
    152. 

  152. 				()
    153. 

  153. 			</div>
    154. 

  154. 	
    155. 

  155. 		
    156. 

  156. 			
    157. 

  157. 	</div>
    158. 

  158. <a name="methodcommit" id="commit"><!-- --></a>
    159. 

  159. <div class="evenrow">
    160. 

  160. 	
    161. 

  161. 	<div class="method-header">
    162. 

  162. 		<span class="method-title">commit</span> (line <span class="line-number">65</span>)
    163. 

  163. 	</div> 
    164. 

  164. 	
    165. 

  165. 	<!-- ========== Info from phpDoc block ========= -->
    166. 

  166. <p class="short-description">Commits a transaction on this connection, if supported.</p>
    167. 

  167. 	
    168. 

  168. 	<div class="method-signature">
    169. 

  169. 		<span class="method-result">void</span>
    170. 

  170. 		<span class="method-name">
    171. 

  171. 			commit
    172. 

  172. 		</span>
    173. 

  173. 				()
    174. 

  174. 			</div>
    175. 

  175. 	
    176. 

  176. 		
    177. 

  177. 			
    178. 

  178. 	</div>
    179. 

  179. <a name="methodgetAll" id="getAll"><!-- --></a>
    180. 

  180. <div class="oddrow">
    181. 

  181. 	
    182. 

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

  183. 		<span class="method-title">getAll</span> (line <span class="line-number">126</span>)
    184. 

  184. 	</div> 
    185. 

  185. 	
    186. 

  186. 	<!-- ========== Info from phpDoc block ========= -->
    187. 

  187. <p class="short-description">Run an SQL query with the specified parameters, if any.</p>
    188. 

  188. 	<ul class="tags">
    189. 

  189. 				<li><span class="field">return:</span> An array of arrays representing the  result of the query; each array is keyed on column name.</li>
    190. 

  190. 			</ul>
    191. 

  191. 	
    192. 

  192. 	<div class="method-signature">
    193. 

  193. 		<span class="method-result">array</span>
    194. 

  194. 		<span class="method-name">
    195. 

  195. 			getAll
    196. 

  196. 		</span>
    197. 

  197. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    198. 

  198. 			</div>
    199. 

  199. 	
    200. 

  200. 			<ul class="parameters">
    201. 

  201. 					<li>
    202. 

  202. 				<span class="var-type">string</span>
    203. 

  203. 				<span class="var-name">$sql</span><span class="var-description">: An SQL string with placeholders.  The  placeholders are assumed to be specific to the database engine  for this connection.</span>			</li>
    204. 

  204. 					<li>
    205. 

  205. 				<span class="var-type">array</span>
    206. 

  206. 				<span class="var-name">$params</span><span class="var-description">: An array of parameters to insert into the  SQL string using this connection's escaping mechanism.</span>			</li>
    207. 

  207. 				</ul>
    208. 

  208. 		
    209. 

  209. 			
    210. 

  210. 	</div>
    211. 

  211. <a name="methodgetOne" id="getOne"><!-- --></a>
    212. 

  212. <div class="evenrow">
    213. 

  213. 	
    214. 

  214. 	<div class="method-header">
    215. 

  215. 		<span class="method-title">getOne</span> (line <span class="line-number">91</span>)
    216. 

  216. 	</div> 
    217. 

  217. 	
    218. 

  218. 	<!-- ========== Info from phpDoc block ========= -->
    219. 

  219. <p class="short-description">Run an SQL query and return the first column of the first row  of the result set, if any.</p>
    220. 

  220. 	<ul class="tags">
    221. 

  221. 				<li><span class="field">return:</span> The value of the first column of the  first row of the result set.  False if no such result was  found.</li>
    222. 

  222. 			</ul>
    223. 

  223. 	
    224. 

  224. 	<div class="method-signature">
    225. 

  225. 		<span class="method-result">mixed</span>
    226. 

  226. 		<span class="method-name">
    227. 

  227. 			getOne
    228. 

  228. 		</span>
    229. 

  229. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    230. 

  230. 			</div>
    231. 

  231. 	
    232. 

  232. 			<ul class="parameters">
    233. 

  233. 					<li>
    234. 

  234. 				<span class="var-type">string</span>
    235. 

  235. 				<span class="var-name">$sql</span><span class="var-description">: An SQL string with placeholders.  The  placeholders are assumed to be specific to the database engine  for this connection.</span>			</li>
    236. 

  236. 					<li>
    237. 

  237. 				<span class="var-type">array</span>
    238. 

  238. 				<span class="var-name">$params</span><span class="var-description">: An array of parameters to insert into the  SQL string using this connection's escaping mechanism.</span>			</li>
    239. 

  239. 				</ul>
    240. 

  240. 		
    241. 

  241. 			
    242. 

  242. 	</div>
    243. 

  243. <a name="methodgetRow" id="getRow"><!-- --></a>
    244. 

  244. <div class="oddrow">
    245. 

  245. 	
    246. 

  246. 	<div class="method-header">
    247. 

  247. 		<span class="method-title">getRow</span> (line <span class="line-number">109</span>)
    248. 

  248. 	</div> 
    249. 

  249. 	
    250. 

  250. 	<!-- ========== Info from phpDoc block ========= -->
    251. 

  251. <p class="short-description">Run an SQL query and return the first row of the result set, if  any.</p>
    252. 

  252. 	<ul class="tags">
    253. 

  253. 				<li><span class="field">return:</span> The first row of the result set, if any,  keyed on column name.  False if no such result was found.</li>
    254. 

  254. 			</ul>
    255. 

  255. 	
    256. 

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

  257. 		<span class="method-result">array</span>
    258. 

  258. 		<span class="method-name">
    259. 

  259. 			getRow
    260. 

  260. 		</span>
    261. 

  261. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    262. 

  262. 			</div>
    263. 

  263. 	
    264. 

  264. 			<ul class="parameters">
    265. 

  265. 					<li>
    266. 

  266. 				<span class="var-type">string</span>
    267. 

  267. 				<span class="var-name">$sql</span><span class="var-description">: An SQL string with placeholders.  The  placeholders are assumed to be specific to the database engine  for this connection.</span>			</li>
    268. 

  268. 					<li>
    269. 

  269. 				<span class="var-type">array</span>
    270. 

  270. 				<span class="var-name">$params</span><span class="var-description">: An array of parameters to insert into the  SQL string using this connection's escaping mechanism.</span>			</li>
    271. 

  271. 				</ul>
    272. 

  272. 		
    273. 

  273. 			
    274. 

  274. 	</div>
    275. 

  275. <a name="methodquery" id="query"><!-- --></a>
    276. 

  276. <div class="evenrow">
    277. 

  277. 	
    278. 

  278. 	<div class="method-header">
    279. 

  279. 		<span class="method-title">query</span> (line <span class="line-number">51</span>)
    280. 

  280. 	</div> 
    281. 

  281. 	
    282. 

  282. 	<!-- ========== Info from phpDoc block ========= -->
    283. 

  283. <p class="short-description">Run an SQL query with the specified parameters, if any.</p>
    284. 

  284. 	<ul class="tags">
    285. 

  285. 				<li><span class="field">return:</span> The result of calling this connection's  internal query function.  The type of result depends on the  underlying database engine.  This method is usually used when  the result of a query is not important, like a DDL query.</li>
    286. 

  286. 			</ul>
    287. 

  287. 	
    288. 

  288. 	<div class="method-signature">
    289. 

  289. 		<span class="method-result">mixed</span>
    290. 

  290. 		<span class="method-name">
    291. 

  291. 			query
    292. 

  292. 		</span>
    293. 

  293. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
    294. 

  294. 			</div>
    295. 

  295. 	
    296. 

  296. 			<ul class="parameters">
    297. 

  297. 					<li>
    298. 

  298. 				<span class="var-type">string</span>
    299. 

  299. 				<span class="var-name">$sql</span><span class="var-description">: An SQL string with placeholders.  The  placeholders are assumed to be specific to the database engine  for this connection.</span>			</li>
    300. 

  300. 					<li>
    301. 

  301. 				<span class="var-type">array</span>
    302. 

  302. 				<span class="var-name">$params</span><span class="var-description">: An array of parameters to insert into the  SQL string using this connection's escaping mechanism.</span>			</li>
    303. 

  303. 				</ul>
    304. 

  304. 		
    305. 

  305. 			
    306. 

  306. 	</div>
    307. 

  307. <a name="methodrollback" id="rollback"><!-- --></a>
    308. 

  308. <div class="oddrow">
    309. 

  309. 	
    310. 

  310. 	<div class="method-header">
    311. 

  311. 		<span class="method-title">rollback</span> (line <span class="line-number">72</span>)
    312. 

  312. 	</div> 
    313. 

  313. 	
    314. 

  314. 	<!-- ========== Info from phpDoc block ========= -->
    315. 

  315. <p class="short-description">Performs a rollback on this connection, if supported.</p>
    316. 

  316. 	
    317. 

  317. 	<div class="method-signature">
    318. 

  318. 		<span class="method-result">void</span>
    319. 

  319. 		<span class="method-name">
    320. 

  320. 			rollback
    321. 

  321. 		</span>
    322. 

  322. 				()
    323. 

  323. 			</div>
    324. 

  324. 	
    325. 

  325. 		
    326. 

  326. 			
    327. 

  327. 	</div>
    328. 

  328. 						
    329. 

  329. 		</div>
    330. 

  330. 	</div>
    331. 

  331. 

  332. 

  333. 	<p class="notes" id="credit">
    334. 

  334. 		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>
    335. 

  335. 	</p>
    336. 

  336. 	</div></body>
    337. 

  337. </html>
    338.