148 lines
No EOL
5.3 KiB
HTML
148 lines
No EOL
5.3 KiB
HTML
<?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</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</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Database Factory</p>
|
|
<p class="description"><p>Generic class to simplify connecting to a database. All database objects should be created by this class to future proof against any internal changes to PICKLES.</p></p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_classes---Database.php.html">/classes/Database.php</a> (line <span class="field">25</span>)
|
|
</p>
|
|
|
|
|
|
<pre>Object
|
|
|
|
|
--Database</pre>
|
|
|
|
</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> |
|
|
<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">
|
|
static <span class="method-result">object instance</span>
|
|
<a href="#getInstance" title="details" class="method-name">getInstance</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">Database</span>
|
|
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
([<span class="var-type"><a href="../PICKLES/String.html">String</a></span> <span class="var-name">$name</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
<a name="methodgetInstance" id="getInstance"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method getInstance</span> (line <span class="line-number">54</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Get Instance</p>
|
|
<p class="description"><p>Looks up the datasource using the passed name and gets an instance of it. Allows for easy sharing of certain classes within the system to avoid the extra overhead of creating new objects each time. Also avoids the hassle of passing around variables (yeah I know, very global-ish)</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> of the class</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">object instance</span>
|
|
<span class="method-name">
|
|
getInstance
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$name</span><span class="var-description">: name of the datasource</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<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">35</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Constructor</p>
|
|
<p class="description"><p>Attempts to get an instance of the passed database type or attempts to use a default specified in the config.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">Database</span>
|
|
<span class="method-name">
|
|
__construct
|
|
</span>
|
|
([<span class="var-type"><a href="../PICKLES/String.html">String</a></span> <span class="var-name">$name</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$name</span><span class="var-description">: optional name of the connection to use</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sun, 14 Oct 2012 14:02:18 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |