768 lines
No EOL
23 KiB
HTML
768 lines
No EOL
23 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_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-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>Object
|
|
|
|
|
--Database_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">boolean</span>
|
|
<a href="#$cache" title="details" class="var-name">$cache</a>
|
|
</div>
|
|
<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-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="#getCache" title="details" class="method-name">getCache</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="#setCache" title="details" class="method-name">setCache</a>
|
|
(<span class="var-type">boolean</span> <span class="var-name">$cache</span>)
|
|
</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> <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> <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> <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> <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> <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> <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-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$cache" id="$cache"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$cache</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">88</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Whether or not to use caching</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$connection" id="$connection"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<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">96</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="evenrow">
|
|
|
|
<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="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$driver</span>
|
|
= <span class="var-default"> null</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>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$hostname" id="$hostname"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<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="oddrow">
|
|
|
|
<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="evenrow">
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$results" id="$results"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<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">104</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="evenrow">
|
|
|
|
<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="oddrow">
|
|
|
|
<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>
|
|
|
|
</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">
|
|
<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">109</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>
|
|
|
|
|
|
|
|
</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">240</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>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetCache" id="getCache"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getCache</span> (line <span class="line-number">217</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Get Cache</p>
|
|
<p class="description"><p>Returns the status of caching for this datasource.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not to use the cache</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
getCache
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</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">205</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">231</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>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodsetCache" id="setCache"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setCache</span> (line <span class="line-number">192</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set Cache</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">
|
|
setCache
|
|
</span>
|
|
(<span class="var-type">boolean</span> <span class="var-name">$cache</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$cache</span><span class="var-description">: whether or not to use cache</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetDatabase" id="setDatabase"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setDatabase</span> (line <span class="line-number">182</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> <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="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setHostname</span> (line <span class="line-number">132</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> <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="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setPassword</span> (line <span class="line-number">172</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> <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="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setPort</span> (line <span class="line-number">142</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> <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="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setSocket</span> (line <span class="line-number">152</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> <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="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setUsername</span> (line <span class="line-number">162</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> <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>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<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> |