355 lines
No EOL
15 KiB
HTML
355 lines
No EOL
15 KiB
HTML
|
|
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/New_York' for 'EDT/-4.0/DST' instead in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
|
|
|
|
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/New_York' for 'EDT/-4.0/DST' instead in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs For Class Database_PDO_Common</title>
|
|
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
<h2 class="class-name">Class Database_PDO_Common</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
|
|
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/New_York' for 'EDT/-4.0/DST' instead in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">PDO Abstraction Layer</p>
|
|
<p class="description"><p>Parent class for any of our database classes that use PDO.</p></p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_classes---Database---PDO---Common.php.html">/classes/Database/PDO/Common.php</a> (line <span class="field">23</span>)
|
|
</p>
|
|
|
|
|
|
<pre>Database_Common
|
|
|
|
|
--Database_PDO_Common</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-var-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variable Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="var-summary">
|
|
<div class="var-title">
|
|
<span class="var-type">string</span>
|
|
<a href="#$attributes" title="details" class="var-name">$attributes</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">string</span>
|
|
<a href="#$dsn" title="details" class="var-name">$dsn</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-method-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Method Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
|
|
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="method-summary">
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">Database_PDO_Common</span>
|
|
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#close" title="details" class="method-name">close</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">integer</span>
|
|
<a href="#execute" title="details" class="method-name">execute</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$sql</span>, [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">mixed</span>
|
|
<a href="#fetch" title="details" class="method-name">fetch</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], <span class="var-type">string</span> <span class="var-name">$return_type</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#open" title="details" class="method-name">open</a>
|
|
()
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-vars"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variables</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
|
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
|
|
Strict Standards: Only variables should be passed by reference in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
|
|
|
|
Strict Standards: Only variables should be passed by reference in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
|
|
|
|
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/New_York' for 'EDT/-4.0/DST' instead in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
|
|
<a name="var$attributes" id="$attributes"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$attributes</span>
|
|
= <span class="var-default">array(<br /> PDO::ATTR_PERSISTENT => true,<br /> PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,<br /> PDO::NULL_EMPTY_STRING => true<br /> )</span> (line <span class="line-number">39</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">PDO Attributes</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$dsn" id="$dsn"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$dsn</span>
|
|
(line <span class="line-number">31</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">DSN format</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
|
|
Strict Standards: Only variables should be passed by reference in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
|
|
|
|
Strict Standards: Only variables should be passed by reference in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
|
|
|
|
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/New_York' for 'EDT/-4.0/DST' instead in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
|
|
<A NAME='method_detail'></A>
|
|
|
|
<a name="method__construct" id="__construct"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor __construct</span> (line <span class="line-number">48</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Constructor</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">Database_PDO_Common</span>
|
|
<span class="method-name">
|
|
__construct
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodclose" id="close"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">close</span> (line <span class="line-number">116</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Closes database connection</p>
|
|
<p class="description"><p>Sets the connection to null regardless of state.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> always true</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
close
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodexecute" id="execute"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">execute</span> (line <span class="line-number">133</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Executes an SQL Statement</p>
|
|
<p class="description"><p>Executes a standard or prepared query based on passed parameters. All queries are logged to a file as well as timed and logged in the execution time is over 1 second.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> ID of the last inserted row or sequence number</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">integer</span>
|
|
<span class="method-name">
|
|
execute
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$sql</span>, [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$sql</span><span class="var-description">: statement to execute</span> </li>
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodfetch" id="fetch"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">fetch</span> (line <span class="line-number">229</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Fetch records from the database</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> based on return type</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">mixed</span>
|
|
<span class="method-name">
|
|
fetch
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$input_parameters</span> = <span class="var-default">null</span>], <span class="var-type">string</span> <span class="var-name">$return_type</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$sql</span><span class="var-description">: statement to be executed</span> </li>
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$input_parameters</span><span class="var-description">: optional key/values to be bound</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$return_type</span><span class="var-description">: optional type of return set</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodopen" id="open"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">open</span> (line <span class="line-number">73</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Opens database connection</p>
|
|
<p class="description"><p>Establishes a connection to the database based on the set configuration options.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
open
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/New_York' for 'EDT/-4.0/DST' instead in /usr/local/Cellar/php53/5.3.13/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Wed, 03 Oct 2012 17:46:05 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |