<?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>
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Moc10_Db_SQLite</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 Moc10_Db_SQLite</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">Moc10_Db_SQLite</p>
<ul class="tags">
<li><span class="field">author:</span> Nick Sagona, III <<a href="mailto:hide@address.com">hide@address.com</a>></li>
<li><span class="field">version:</span> 1.9.7</li>
<li><span class="field">copyright:</span> Copyright (c) 2009-2011 Moc 10 Media, LLC. (http://www.moc10media.com)</li>
<li><span class="field">license:</span> <a href="http://www.moc10phplibrary.com/LICENSE.TXT">New BSD License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Db---SQLite.php.html">/Db/SQLite.php</a> (line <span class="field">33</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</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">resource</span>
<a href="#$connection" title="details" class="var-name">$connection</a>
</div>
<div class="var-title">
<span class="var-type">resource</span>
<a href="#$last_result" title="details" class="var-name">$last_result</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$last_sql" title="details" class="var-name">$last_sql</a>
</div>
<div class="var-title">
<span class="var-type">resource</span>
<a href="#$result" title="details" class="var-name">$result</a>
</div>
<div class="var-title">
<span class="var-type"><a href="../Moc10_Language/Moc10_Language.html">Moc10_Language</a></span>
<a href="#$_lang" title="details" class="var-name">$_lang</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$_tables" title="details" class="var-name">$_tables</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</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">void</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">string</span> <span class="var-name">$dbase</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__destruct" title="details" class="method-name">__destruct</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#escape" title="details" class="method-name">escape</a>
(<span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#fetch" title="details" class="method-name">fetch</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getTables" title="details" class="method-name">getTables</a>
()
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#lastId" title="details" class="method-name">lastId</a>
()
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#numFields" title="details" class="method-name">numFields</a>
()
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#numRows" title="details" class="method-name">numRows</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#query" title="details" class="method-name">query</a>
(<span class="var-type">string</span> <span class="var-name">$sql</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#showError" title="details" class="method-name">showError</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#version" title="details" class="method-name">version</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">
<a name="var$connection" id="$connection"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">resource</span>
<span class="var-name">$connection</span>
(line <span class="line-number">46</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default database connection</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$last_result" id="$last_result"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">resource</span>
<span class="var-name">$last_result</span>
(line <span class="line-number">52</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Last result</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$last_sql" id="$last_sql"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$last_sql</span>
= <span class="var-default"> null</span> (line <span class="line-number">58</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Last SQL query</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$result" id="$result"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">resource</span>
<span class="var-name">$result</span>
(line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database results</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$_lang" id="$_lang"><!-- --></a>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type"><a href="../Moc10_Language/Moc10_Language.html">Moc10_Language</a></span>
<span class="var-name">$_lang</span>
= <span class="var-default"> null</span> (line <span class="line-number">70</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Language object</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_tables" id="$_tables"><!-- --></a>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$_tables</span>
= <span class="var-default">array()</span> (line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database tables</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">81</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description">Instantiate the SQLite database connection object.</p>
<ul class="tags">
<li><span class="field">throws:</span> Exception</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">string</span> <span class="var-name">$dbase</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$dbase</span> </li>
</ul>
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">257</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Close the DB connection.</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">
__destruct
</span>
()
</div>
</div>
<a name="methodescape" id="escape"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">escape</span> (line <span class="line-number">154</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the escapes string value.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
escape
</span>
(<span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</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">137</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the results array from the results resource.</p>
<ul class="tags">
<li><span class="field">throws:</span> Exception</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
fetch
</span>
()
</div>
</div>
<a name="methodgetTables" id="getTables"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getTables</span> (line <span class="line-number">223</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get tables of the database.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getTables
</span>
()
</div>
</div>
<a name="methodlastId" id="lastId"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">lastId</span> (line <span class="line-number">166</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the auto-increment ID of the last query.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
lastId
</span>
()
</div>
</div>
<a name="methodnumFields" id="numFields"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">numFields</span> (line <span class="line-number">207</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the number of fields in the result.</p>
<ul class="tags">
<li><span class="field">throws:</span> Exception</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
numFields
</span>
()
</div>
</div>
<a name="methodnumRows" id="numRows"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">numRows</span> (line <span class="line-number">178</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the number of rows in the result.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
numRows
</span>
()
</div>
</div>
<a name="methodquery" id="query"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">query</span> (line <span class="line-number">116</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Execute the SQL query and create a result resource, or display the SQL error.</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">
query
</span>
(<span class="var-type">string</span> <span class="var-name">$sql</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$sql</span> </li>
</ul>
</div>
<a name="methodshowError" id="showError"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">showError</span> (line <span class="line-number">103</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Throw an exception upon a database error.</p>
<ul class="tags">
<li><span class="field">throws:</span> Exception</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
showError
</span>
()
</div>
</div>
<a name="methodversion" id="version"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">version</span> (line <span class="line-number">244</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the SQLite version.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
version
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 12 Jan 2011 01:17:45 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>