joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
pickles/docs/PICKLES/Database_Common.html
Josh Sherman 5f78540770 Updated internal documentation.
2010-11-27 21:43:43 -05:00

803 lines
No EOL
25 KiB
HTML
Raw Blame History

<?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_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_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-descendents">Descendents</a>
| <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">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Common Database Abstraction Layer</p>
<p class="description"><p>Parent class that our database driver classes should be extending. Contains basic functionality for instantiation and interfacing.</p></p>
<ul class="tags">
<li><span class="field">abstract:</span> </li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Database---Common.php.html">/classes/Database/Common.php</a> (line <span class="field">24</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Database_Common</pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</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">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_Mongo.html">Database_Mongo</a></td>
<td>
Mongo Database Abstraction Layer
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PICKLES/Database_PDO_Common.html">Database_PDO_Common</a></td>
<td>
PDO Abstraction Layer
</td>
</tr>
</table>
</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> |
<a href="#sec-descendents">Descendents</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">object</span>
<a href="#$connection" title="details" class="var-name">$connection</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$database" title="details" class="var-name">$database</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$driver" title="details" class="var-name">$driver</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$hostname" title="details" class="var-name">$hostname</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$password" title="details" class="var-name">$password</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$port" title="details" class="var-name">$port</a>
</div>
<div class="var-title">
<span class="var-type">object</span>
<a href="#$results" title="details" class="var-name">$results</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$socket" title="details" class="var-name">$socket</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$username" title="details" class="var-name">$username</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-descendents">Descendents</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_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">string</span>
<a href="#getDriver" title="details" class="method-name">getDriver</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#open" title="details" class="method-name">open</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setDatabase" title="details" class="method-name">setDatabase</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setHostname" title="details" class="method-name">setHostname</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setPassword" title="details" class="method-name">setPassword</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setPort" title="details" class="method-name">setPort</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setSocket" title="details" class="method-name">setSocket</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$socket</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setUsername" title="details" class="method-name">setUsername</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
</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-descendents">Descendents</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">
<a name="var$connection" id="$connection"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$connection</span>
= <span class="var-default"> null</span> (line <span class="line-number">88</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Connection resource</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$database" id="$database"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$database</span>
= <span class="var-default"> null</span> (line <span class="line-number">80</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database name for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$driver" id="$driver"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$driver</span>
(line <span class="line-number">32</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Driver</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_Mongo.html#var$driver">Database_Mongo::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_MySQL.html#var$driver">Database_PDO_MySQL::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_SQLite.html#var$driver">Database_PDO_SQLite::$driver</a>
: Driver
</li>
<li>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$driver">Database_PDO_PostgreSQL::$driver</a>
: Driver
</li>
</ul>
</div>
<a name="var$hostname" id="$hostname"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$hostname</span>
= <span class="var-default"> 'localhost'</span> (line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hostname for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$password" id="$password"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$password</span>
= <span class="var-default"> null</span> (line <span class="line-number">72</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Password for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$port</span>
= <span class="var-default"> null</span> (line <span class="line-number">48</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Port number for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_MySQL.html#var$port">Database_PDO_MySQL::$port</a>
: Default port
</li>
<li>
<a href="../PICKLES/Database_PDO_PostgreSQL.html#var$port">Database_PDO_PostgreSQL::$port</a>
: Default port
</li>
</ul>
</div>
<a name="var$results" id="$results"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">object</span>
<span class="var-name">$results</span>
= <span class="var-default"> null</span> (line <span class="line-number">96</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Results object for the executed statement</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$socket" id="$socket"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$socket</span>
= <span class="var-default"> null</span> (line <span class="line-number">56</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">UNIX socket for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$username" id="$username"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$username</span>
= <span class="var-default"> null</span> (line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Username for the server</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</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-descendents">Descendents</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">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">101</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_Common</span>
<span class="method-name">
__construct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_PDO_Common.html#method__construct">Database_PDO_Common::__construct()</a>
: Constructor
</li>
</ul>
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">close</span> (line <span class="line-number">210</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">abstract:</span> </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>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_Mongo.html#methodclose">Database_Mongo::close()</a>
: Closes database connection
</li>
<li>
<a href="../PICKLES/Database_PDO_Common.html#methodclose">Database_PDO_Common::close()</a>
: Closes database connection
</li>
</ul>
</div>
<a name="methodgetDriver" id="getDriver"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getDriver</span> (line <span class="line-number">187</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Driver</p>
<p class="description"><p>Returns the name of the driver in use. Used by the Model class to determine which path to take when interfacing with the Database object.</p></p>
<ul class="tags">
<li><span class="field">return:</span> name of the driver in use</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getDriver
</span>
()
</div>
</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">201</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Opens database connection</p>
<p class="description"><p>Establishes a connection to the MySQL database based on the configuration options that are available in the Config object.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true on success, throws an exception overwise</li>
<li><span class="field">abstract:</span> </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>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PICKLES/Database_Mongo.html#methodopen">Database_Mongo::open()</a>
: Opens database connection
</li>
<li>
<a href="../PICKLES/Database_PDO_Common.html#methodopen">Database_PDO_Common::open()</a>
: Opens database connection
</li>
</ul>
</div>
<a name="methodsetDatabase" id="setDatabase"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setDatabase</span> (line <span class="line-number">174</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Database</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setDatabase
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$database</span><span class="var-description">: database for the database</span> </li>
</ul>
</div>
<a name="methodsetHostname" id="setHostname"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setHostname</span> (line <span class="line-number">124</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Hostname</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setHostname
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$hostname</span><span class="var-description">: hostname for the database</span> </li>
</ul>
</div>
<a name="methodsetPassword" id="setPassword"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setPassword</span> (line <span class="line-number">164</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Password</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setPassword
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span><span class="var-description">: password for the database</span> </li>
</ul>
</div>
<a name="methodsetPort" id="setPort"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setPort</span> (line <span class="line-number">134</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Port</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setPort
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$port</span><span class="var-description">: port for the database</span> </li>
</ul>
</div>
<a name="methodsetSocket" id="setSocket"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setSocket</span> (line <span class="line-number">144</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Socket</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setSocket
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$socket</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$socket</span><span class="var-description">: name of the UNIX socket</span> </li>
</ul>
</div>
<a name="methodsetUsername" id="setUsername"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setUsername</span> (line <span class="line-number">154</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Username</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setUsername
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$username</span><span class="var-description">: username for the database</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Nov 2010 21:43:41 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
Reference in a new issue View git blame Copy permalink