aviat
/
Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity

Update docs

This commit is contained in:
Timothy Warren 2012-11-07 08:57:29 -05:00
parent 60d5d99ee3
commit bb2b3d7bd0
35 changed files with 1744 additions and 1805 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/classes.svg
View File

@ -52,9 +52,24 @@
<path fill="none" stroke="black" d="M244.421,-448C199.3,-448 128.295,-448 81.9376,-448"/>
<polygon fill="none" stroke="black" points="81.8642,-444.5 71.8642,-448 81.8642,-451.5 81.8642,-444.5"/>
</g>
<!-- \\Query_Builder -->
<g id="node5" class="node"><title>\\Query_Builder</title>
<a xlink:href="classes.query_builder.html" xlink:title="Query_Builder" target="_parent">
<polygon fill="none" stroke="black" points="636,-1168 532,-1168 532,-1132 636,-1132 636,-1168"/>
<text text-anchor="middle" x="584" y="-1146.6" font-family="Courier,monospace" font-size="11.00">Query_Builder</text>
</a>
</g>
<!-- \\DB_Util -->
<g id="node6" class="node"><title>\\DB_Util</title>
<a xlink:href="classes.db_util.html" xlink:title="«abstract»&lt;br/&gt;DB_Util" target="_parent">
<polygon fill="none" stroke="black" points="329,-1006 245,-1006 245,-970 329,-970 329,-1006"/>
<text text-anchor="start" x="253" y="-993.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="263" y="-980.233" font-family="Courier,monospace" font-size="11.00">DB_Util</text>
</a>
</g>
<!-- \\BadDBDriverException -->
<g id="node5" class="node"><title>\\BadDBDriverException</title>
<a xlink:href="classes.query_builder.html" xlink:title="BadDBDriverException" target="_parent">
<g id="node7" class="node"><title>\\BadDBDriverException</title>
<a xlink:href="common.html" xlink:title="BadDBDriverException" target="_parent">
<polygon fill="none" stroke="black" points="659,-304 509,-304 509,-268 659,-268 659,-304"/>
<text text-anchor="middle" x="584" y="-282.6" font-family="Courier,monospace" font-size="11.00">BadDBDriverException</text>
</a>
@ -70,8 +85,8 @@
<polygon fill="none" stroke="black" points="415.351,-136.174 404.768,-135.674 412.73,-142.664 415.351,-136.174"/>
</g>
<!-- \\BadConnectionException -->
<g id="node6" class="node"><title>\\BadConnectionException</title>
<a xlink:href="classes.query_builder.html" xlink:title="BadConnectionException" target="_parent">
<g id="node8" class="node"><title>\\BadConnectionException</title>
<a xlink:href="common.html" xlink:title="BadConnectionException" target="_parent">
<polygon fill="none" stroke="black" points="666,-250 502,-250 502,-214 666,-214 666,-250"/>
<text text-anchor="middle" x="584" y="-228.6" font-family="Courier,monospace" font-size="11.00">BadConnectionException</text>
</a>
@ -86,21 +101,6 @@
<path fill="none" stroke="black" d="M516.365,-213.859C511.289,-211.277 506.428,-208.339 502,-205 456.528,-170.71 477.626,-130.229 430,-99 422.863,-94.32 415.119,-90.405 407.053,-87.1346"/>
<polygon fill="none" stroke="black" points="408.047,-83.7705 397.454,-83.5843 405.619,-90.3358 408.047,-83.7705"/>
</g>
<!-- \\Query_Builder -->
<g id="node7" class="node"><title>\\Query_Builder</title>
<a xlink:href="classes.query_builder.html" xlink:title="Query_Builder" target="_parent">
<polygon fill="none" stroke="black" points="636,-1060 532,-1060 532,-1024 636,-1024 636,-1060"/>
<text text-anchor="middle" x="584" y="-1038.6" font-family="Courier,monospace" font-size="11.00">Query_Builder</text>
</a>
</g>
<!-- \\DB_Util -->
<g id="node8" class="node"><title>\\DB_Util</title>
<a xlink:href="classes.db_util.html" xlink:title="«abstract»&lt;br/&gt;DB_Util" target="_parent">
<polygon fill="none" stroke="black" points="329,-1006 245,-1006 245,-970 329,-970 329,-1006"/>
<text text-anchor="start" x="253" y="-993.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="263" y="-980.233" font-family="Courier,monospace" font-size="11.00">DB_Util</text>
</a>
</g>
<!-- \\PgSQL_SQL -->
<g id="node9" class="node"><title>\\PgSQL_SQL</title>
<a xlink:href="drivers.pgsql.pgsql_sql.html" xlink:title="PgSQL_SQL" target="_parent">
@ -116,14 +116,14 @@
<!-- \\PgSQL_Util -->
<g id="node10" class="node"><title>\\PgSQL_Util</title>
<a xlink:href="drivers.pgsql.pgsql_util.html" xlink:title="PgSQL_Util" target="_parent">
<polygon fill="none" stroke="black" points="626,-1168 542,-1168 542,-1132 626,-1132 626,-1168"/>
<text text-anchor="middle" x="584" y="-1146.6" font-family="Courier,monospace" font-size="11.00">PgSQL_Util</text>
<polygon fill="none" stroke="black" points="626,-1114 542,-1114 542,-1078 626,-1078 626,-1114"/>
<text text-anchor="middle" x="584" y="-1092.6" font-family="Courier,monospace" font-size="11.00">PgSQL_Util</text>
</a>
</g>
<!-- \\PgSQL_Util&#45;&gt;\\DB_Util -->
<g id="edge11" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M541.945,-1138.31C528.886,-1134.11 514.615,-1128.93 502,-1123 433.666,-1090.88 360.507,-1041.29 319.583,-1012"/>
<polygon fill="none" stroke="black" points="321.513,-1009.08 311.353,-1006.07 317.421,-1014.76 321.513,-1009.08"/>
<path fill="none" stroke="black" d="M541.747,-1082.47C528.941,-1078.26 514.862,-1073.54 502,-1069 446.048,-1049.26 382.529,-1025.11 339.128,-1008.34"/>
<polygon fill="none" stroke="black" points="340.227,-1005.02 329.637,-1004.67 337.7,-1011.54 340.227,-1005.02"/>
</g>
<!-- \\PgSQL -->
<g id="node11" class="node"><title>\\PgSQL</title>
@ -140,14 +140,14 @@
<!-- \\ODBC_Util -->
<g id="node12" class="node"><title>\\ODBC_Util</title>
<a xlink:href="drivers.odbc.odbc_util.html" xlink:title="ODBC_Util" target="_parent">
<polygon fill="none" stroke="black" points="622,-1114 546,-1114 546,-1078 622,-1078 622,-1114"/>
<text text-anchor="middle" x="584" y="-1092.6" font-family="Courier,monospace" font-size="11.00">ODBC_Util</text>
<polygon fill="none" stroke="black" points="622,-1060 546,-1060 546,-1024 622,-1024 622,-1060"/>
<text text-anchor="middle" x="584" y="-1038.6" font-family="Courier,monospace" font-size="11.00">ODBC_Util</text>
</a>
</g>
<!-- \\ODBC_Util&#45;&gt;\\DB_Util -->
<g id="edge15" class="edge"><title>\\ODBC_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M545.093,-1083.56C531.426,-1079.09 515.993,-1073.94 502,-1069 446.048,-1049.26 382.529,-1025.11 339.128,-1008.34"/>
<polygon fill="none" stroke="black" points="340.227,-1005.02 329.637,-1004.67 337.7,-1011.54 340.227,-1005.02"/>
<path fill="none" stroke="black" d="M545.477,-1035C492.953,-1025.45 398.67,-1008.3 339.653,-997.573"/>
<polygon fill="none" stroke="black" points="340.244,-994.123 329.779,-995.778 338.991,-1001.01 340.244,-994.123"/>
</g>
<!-- \\ODBC_SQL -->
<g id="node13" class="node"><title>\\ODBC_SQL</title>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

4
docs/classes/BadConnectionException.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -219,7 +219,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/BadDBDriverException.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -219,7 +219,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

73
docs/classes/DB_PDO.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -111,6 +111,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#quote" title="quote :: "><span class="description">quote()
</span><pre>quote()</pre></a></li>
<li class="method public "><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public "><a href="#quote_table" title="quote_table :: Quote database table name, and set prefix"><span class="description">Quote database table name, and set prefix</span><pre>quote_table()</pre></a></li>
<li class="method public "><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
</span><pre>rollBack()</pre></a></li>
<li class="method public "><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
@ -118,15 +119,17 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
<li class="method public "><a href="#truncate" title="truncate :: Empty the passed table"><span class="description">Empty the passed table</span><pre>truncate()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><a href="#_prefix" title="_prefix :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li>
<li class="method protected "><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public "><a href="#%24last_query" title="$last_query :: Last query executed"><span class="description">Last query executed</span><pre>$last_query</pre></a></li>
<li class="property public "><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public "><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="property public "><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li>
<li class="property public "><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li>
<li class="property public "><a href="#%24table_prefix" title="$table_prefix :: "><span class="description">$table_prefix</span><pre>$table_prefix</pre></a></li>
<li class="property public "><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: "><span class="description">$escape_char</span><pre>$escape_char</pre></a></li>
<li class="property protected "><a href="#%24statement" title="$statement :: "><span class="description">$statement</span><pre>$statement</pre></a></li>
</ul>
</div>
<div class="span8">
@ -612,6 +615,21 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="quote_table" id="quote_table"></a><div class="element clickable method public quote_table" data-toggle="collapse" data-target=".quote_table .collapse">
<h2>Quote database table name, and set prefix</h2>
<pre>quote_table(mixed $table) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
<h2>rollBack()
</h2>
@ -664,6 +682,21 @@ the connection/database</h2>
</div>
</div></div>
</div>
<a name="_prefix" id="_prefix"></a><div class="element clickable method protected _prefix" data-toggle="collapse" data-target="._prefix .collapse">
<h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
@ -682,32 +715,38 @@ the connection/database</h2>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24last_query" id="$last_query"> </a><div class="element clickable property public $last_query" data-toggle="collapse" data-target=".$last_query .collapse">
<h2>Last query executed</h2>
<pre>$last_query : string</pre>
<h2>$last_query</h2>
<pre>$last_query </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<h2>Reference to sql sub class</h2>
<pre>$sql : Object</pre>
<h2>$sql</h2>
<pre>$sql </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24table_prefix" id="$table_prefix"> </a><div class="element clickable property public $table_prefix" data-toggle="collapse" data-target=".$table_prefix .collapse">
<h2>$table_prefix</h2>
<pre>$table_prefix </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
<h2>Reference to util sub class</h2>
<pre>$util : Object</pre>
<h2>$util</h2>
<pre>$util </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
<h2>Character to escape identifiers</h2>
<pre>$escape_char : string</pre>
<h2>$escape_char</h2>
<pre>$escape_char </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<h2>Reference to the last executed query</h2>
<pre>$statement : mixed</pre>
<h2>$statement</h2>
<pre>$statement </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
@ -718,7 +757,7 @@ the connection/database</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

59
docs/classes/DB_SQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -58,20 +58,15 @@
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
<li class="method public "><a href="#column_list" title="column_list :: Get information about the columns in the
specified table"><span class="description">Get information about the columns in the
specified table</span><pre>column_list()</pre></a></li>
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
<li class="method public "><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Get database specific sql for limit clause"><span class="description">Get database specific sql for limit clause</span><pre>limit()</pre></a></li>
<li class="method public "><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
<li class="method public "><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
<li class="method public "><a href="#random" title="random :: Get the sql for random ordering"><span class="description">Get the sql for random ordering</span><pre>random()</pre></a></li>
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
<li class="method public "><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
@ -96,16 +91,6 @@ specified table</span><pre>column_list()</pre></a></li>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
<h2>Get the 'average' keyword</h2>
<pre>avg() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
<h2>Get information about the columns in the
specified table</h2>
@ -131,16 +116,6 @@ specified table</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Get the 'distinct' keyword</h2>
<pre>distinct() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
<h2>Return sql to list functions</h2>
<pre>function_list() : FALSE</pre>
@ -178,26 +153,6 @@ specified table</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
<h2>Get the max keyword sql</h2>
<pre>max() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
<h2>Get the min keyword sql</h2>
<pre>min() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre>
@ -232,16 +187,6 @@ specified table</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
<h2>Get the 'sum' keyword</h2>
<pre>sum() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
<h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre>
@ -299,7 +244,7 @@ specified table</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/DB_Util.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -210,7 +210,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

81
docs/classes/Firebird.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -104,21 +104,24 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#query" title="query :: Wrapper public function to better match PDO"><span class="description">Wrapper public function to better match PDO</span><pre>query()</pre></a></li>
<li class="method public "><a href="#quote" title="quote :: Method to emulate PDO-&gt;quote"><span class="description">Method to emulate PDO-&gt;quote</span><pre>quote()</pre></a></li>
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public inherited"><a href="#quote_table" title="quote_table :: Quote database table name, and set prefix"><span class="description">Quote database table name, and set prefix</span><pre>quote_table()</pre></a></li>
<li class="method public "><a href="#rollBack" title="rollBack :: Rollback a transaction"><span class="description">Rollback a transaction</span><pre>rollBack()</pre></a></li>
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
</span><pre>setAttribute()</pre></a></li>
<li class="method public "><a href="#switch_db" title="switch_db :: Doesn't apply to Firebird"><span class="description">Doesn't apply to Firebird</span><pre>switch_db()</pre></a></li>
<li class="method public "><a href="#truncate" title="truncate :: Empty a database table"><span class="description">Empty a database table</span><pre>truncate()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#_prefix" title="_prefix :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li>
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: Last query executed"><span class="description">Last query executed</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24table_prefix" title="$table_prefix :: "><span class="description">$table_prefix</span><pre>$table_prefix</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24conn" title="$conn :: Reference to the connection resource"><span class="description">Reference to the connection resource</span><pre>$conn</pre></a></li>
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: "><span class="description">$escape_char</span><pre>$escape_char</pre></a></li>
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last query executed"><span class="description">Reference to the last query executed</span><pre>$statement</pre></a></li>
<li class="property protected "><a href="#%24statement_link" title="$statement_link :: Reference to the resource returned by
the last query executed"><span class="description">Reference to the resource returned by
@ -730,6 +733,25 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="quote_table" id="quote_table"></a><div class="element clickable method public quote_table" data-toggle="collapse" data-target=".quote_table .collapse">
<h2>Quote database table name, and set prefix</h2>
<pre>quote_table(mixed $table) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::quote_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
<h2>Rollback a transaction</h2>
<pre>rollBack() : bool</pre>
@ -787,6 +809,25 @@ the connection/database</h2>
</div>
</div></div>
</div>
<a name="_prefix" id="_prefix"></a><div class="element clickable method protected _prefix" data-toggle="collapse" data-target="._prefix .collapse">
<h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::_prefix()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
@ -809,8 +850,8 @@ the connection/database</h2>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24last_query" id="$last_query"> </a><div class="element clickable property public $last_query" data-toggle="collapse" data-target=".$last_query .collapse">
<h2>Last query executed</h2>
<pre>$last_query : string</pre>
<h2>$last_query</h2>
<pre>$last_query </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -821,8 +862,8 @@ the connection/database</h2>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<h2>Reference to sql sub class</h2>
<pre>$sql : Object</pre>
<h2>$sql</h2>
<pre>$sql </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -832,9 +873,21 @@ the connection/database</h2>
</tr></table>
</div></div>
</div>
<a name="%24table_prefix" id="$table_prefix"> </a><div class="element clickable property public $table_prefix" data-toggle="collapse" data-target=".$table_prefix .collapse">
<h2>$table_prefix</h2>
<pre>$table_prefix </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$table_prefix</td>
</tr></table>
</div></div>
</div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
<h2>Reference to util sub class</h2>
<pre>$util : Object</pre>
<h2>$util</h2>
<pre>$util </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -851,8 +904,8 @@ the connection/database</h2>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
<h2>Character to escape identifiers</h2>
<pre>$escape_char : string</pre>
<h2>$escape_char</h2>
<pre>$escape_char </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -888,7 +941,7 @@ the last query executed</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/Firebird_Result.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -505,7 +505,7 @@ the query</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

79
docs/classes/Firebird_SQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -58,18 +58,13 @@
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
<li class="method public "><a href="#column_list" title="column_list :: Return sql to list columns of the specified table"><span class="description">Return sql to list columns of the specified table</span><pre>column_list()</pre></a></li>
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
<li class="method public inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
@ -94,20 +89,6 @@
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
<h2>Get the 'average' keyword</h2>
<pre>avg() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::avg()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
<h2>Return sql to list columns of the specified table</h2>
<pre>column_list(string $table) : string</pre>
@ -133,20 +114,6 @@
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Get the 'distinct' keyword</h2>
<pre>distinct() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::distinct()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
<h2>Return sql to list functions</h2>
<pre>function_list() : string</pre>
@ -180,34 +147,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
<h2>Get the max keyword sql</h2>
<pre>max() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::max()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
<h2>Get the min keyword sql</h2>
<pre>min() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::min()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre>
@ -238,20 +177,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
<h2>Get the 'sum' keyword</h2>
<pre>sum() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::sum()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
<h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre>
@ -309,7 +234,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/Firebird_Util.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -213,7 +213,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

81
docs/classes/MySQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -111,6 +111,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
</span><pre>quote()</pre></a></li>
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public inherited"><a href="#quote_table" title="quote_table :: Quote database table name, and set prefix"><span class="description">Quote database table name, and set prefix</span><pre>quote_table()</pre></a></li>
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
</span><pre>rollBack()</pre></a></li>
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
@ -118,15 +119,17 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
<li class="method public "><a href="#truncate" title="truncate :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#_prefix" title="_prefix :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li>
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: Last query executed"><span class="description">Last query executed</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24table_prefix" title="$table_prefix :: "><span class="description">$table_prefix</span><pre>$table_prefix</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: Set the backtick as the MySQL escape character"><span class="description">Set the backtick as the MySQL escape character</span><pre>$escape_char</pre></a></li>
<li class="property protected inherited"><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
<li class="property protected inherited"><a href="#%24statement" title="$statement :: "><span class="description">$statement</span><pre>$statement</pre></a></li>
</ul>
</div>
<div class="span8">
@ -778,6 +781,25 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="quote_table" id="quote_table"></a><div class="element clickable method public quote_table" data-toggle="collapse" data-target=".quote_table .collapse">
<h2>Quote database table name, and set prefix</h2>
<pre>quote_table(mixed $table) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::quote_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
<h2>rollBack()
</h2>
@ -842,6 +864,25 @@ the connection/database</h2>
</div>
</div></div>
</div>
<a name="_prefix" id="_prefix"></a><div class="element clickable method protected _prefix" data-toggle="collapse" data-target="._prefix .collapse">
<h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::_prefix()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
@ -864,8 +905,8 @@ the connection/database</h2>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24last_query" id="$last_query"> </a><div class="element clickable property public $last_query" data-toggle="collapse" data-target=".$last_query .collapse">
<h2>Last query executed</h2>
<pre>$last_query : string</pre>
<h2>$last_query</h2>
<pre>$last_query </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -876,8 +917,8 @@ the connection/database</h2>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<h2>Reference to sql sub class</h2>
<pre>$sql : Object</pre>
<h2>$sql</h2>
<pre>$sql </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -887,9 +928,21 @@ the connection/database</h2>
</tr></table>
</div></div>
</div>
<a name="%24table_prefix" id="$table_prefix"> </a><div class="element clickable property public $table_prefix" data-toggle="collapse" data-target=".$table_prefix .collapse">
<h2>$table_prefix</h2>
<pre>$table_prefix </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$table_prefix</td>
</tr></table>
</div></div>
</div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
<h2>Reference to util sub class</h2>
<pre>$util : Object</pre>
<h2>$util</h2>
<pre>$util </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -906,8 +959,8 @@ the connection/database</h2>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<h2>Reference to the last executed query</h2>
<pre>$statement : mixed</pre>
<h2>$statement</h2>
<pre>$statement </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -924,7 +977,7 @@ the connection/database</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

79
docs/classes/MySQL_SQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -58,18 +58,13 @@
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
<li class="method public "><a href="#column_list" title="column_list :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a table</span><pre>column_list()</pre></a></li>
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
<li class="method public inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
<li class="method public "><a href="#system_table_list" title="system_table_list :: Overridden in MySQL class"><span class="description">Overridden in MySQL class</span><pre>system_table_list()</pre></a></li>
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
@ -94,20 +89,6 @@
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
<h2>Get the 'average' keyword</h2>
<pre>avg() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::avg()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
<h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : string</pre>
@ -133,20 +114,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Get the 'distinct' keyword</h2>
<pre>distinct() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::distinct()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
<h2>Return sql to list functions</h2>
<pre>function_list() : string</pre>
@ -180,34 +147,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
<h2>Get the max keyword sql</h2>
<pre>max() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::max()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
<h2>Get the min keyword sql</h2>
<pre>min() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::min()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre>
@ -238,20 +177,6 @@
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
<h2>Get the 'sum' keyword</h2>
<pre>sum() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::sum()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
<h2>Overridden in MySQL class</h2>
<pre>system_table_list() : string</pre>
@ -314,7 +239,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/MySQL_Util.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -209,7 +209,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

83
docs/classes/ODBC.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -111,6 +111,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
</span><pre>quote()</pre></a></li>
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public inherited"><a href="#quote_table" title="quote_table :: Quote database table name, and set prefix"><span class="description">Quote database table name, and set prefix</span><pre>quote_table()</pre></a></li>
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
</span><pre>rollBack()</pre></a></li>
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
@ -118,15 +119,17 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#switch_db" title="switch_db :: Doesn't apply to ODBC"><span class="description">Doesn't apply to ODBC</span><pre>switch_db()</pre></a></li>
<li class="method public "><a href="#truncate" title="truncate :: Empty the current database"><span class="description">Empty the current database</span><pre>truncate()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#_prefix" title="_prefix :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li>
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: Last query executed"><span class="description">Last query executed</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24table_prefix" title="$table_prefix :: "><span class="description">$table_prefix</span><pre>$table_prefix</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: Don't define the escape char - or define it in sub-drivers in a refactor"><span class="description">Don't define the escape char - or define it in sub-drivers in a refactor</span><pre>$escape_char</pre></a></li>
<li class="property protected inherited"><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
<li class="property protected inherited"><a href="#%24statement" title="$statement :: "><span class="description">$statement</span><pre>$statement</pre></a></li>
</ul>
</div>
<div class="span8">
@ -778,6 +781,25 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="quote_table" id="quote_table"></a><div class="element clickable method public quote_table" data-toggle="collapse" data-target=".quote_table .collapse">
<h2>Quote database table name, and set prefix</h2>
<pre>quote_table(mixed $table) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::quote_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
<h2>rollBack()
</h2>
@ -844,6 +866,25 @@ the connection/database</h2>
</div>
</div></div>
</div>
<a name="_prefix" id="_prefix"></a><div class="element clickable method protected _prefix" data-toggle="collapse" data-target="._prefix .collapse">
<h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::_prefix()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
@ -866,8 +907,8 @@ the connection/database</h2>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24last_query" id="$last_query"> </a><div class="element clickable property public $last_query" data-toggle="collapse" data-target=".$last_query .collapse">
<h2>Last query executed</h2>
<pre>$last_query : string</pre>
<h2>$last_query</h2>
<pre>$last_query </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -878,8 +919,8 @@ the connection/database</h2>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<h2>Reference to sql sub class</h2>
<pre>$sql : Object</pre>
<h2>$sql</h2>
<pre>$sql </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -889,9 +930,21 @@ the connection/database</h2>
</tr></table>
</div></div>
</div>
<a name="%24table_prefix" id="$table_prefix"> </a><div class="element clickable property public $table_prefix" data-toggle="collapse" data-target=".$table_prefix .collapse">
<h2>$table_prefix</h2>
<pre>$table_prefix </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$table_prefix</td>
</tr></table>
</div></div>
</div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
<h2>Reference to util sub class</h2>
<pre>$util : Object</pre>
<h2>$util</h2>
<pre>$util </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -903,13 +956,13 @@ the connection/database</h2>
</div>
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
<h2>Don't define the escape char - or define it in sub-drivers in a refactor</h2>
<pre>$escape_char : string</pre>
<pre>$escape_char </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<h2>Reference to the last executed query</h2>
<pre>$statement : mixed</pre>
<h2>$statement</h2>
<pre>$statement </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -926,7 +979,7 @@ the connection/database</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

79
docs/classes/ODBC_SQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -58,18 +58,13 @@
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
<li class="method public "><a href="#column_list" title="column_list :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a table</span><pre>column_list()</pre></a></li>
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
<li class="method public inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
@ -94,20 +89,6 @@
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
<h2>Get the 'average' keyword</h2>
<pre>avg() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::avg()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
<h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : FALSE</pre>
@ -133,20 +114,6 @@
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Get the 'distinct' keyword</h2>
<pre>distinct() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::distinct()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
<h2>Return sql to list functions</h2>
<pre>function_list() : FALSE</pre>
@ -180,34 +147,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
<h2>Get the max keyword sql</h2>
<pre>max() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::max()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
<h2>Get the min keyword sql</h2>
<pre>min() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::min()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : FALSE</pre>
@ -238,20 +177,6 @@
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
<h2>Get the 'sum' keyword</h2>
<pre>sum() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::sum()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
<h2>Returns sql to list system tables</h2>
<pre>system_table_list() : FALSE</pre>
@ -309,7 +234,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/ODBC_Util.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -204,7 +204,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

87
docs/classes/PgSQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -111,6 +111,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
</span><pre>quote()</pre></a></li>
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public inherited"><a href="#quote_table" title="quote_table :: Quote database table name, and set prefix"><span class="description">Quote database table name, and set prefix</span><pre>quote_table()</pre></a></li>
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
</span><pre>rollBack()</pre></a></li>
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
@ -118,15 +119,17 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
<li class="method public "><a href="#truncate" title="truncate :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#_prefix" title="_prefix :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li>
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: Last query executed"><span class="description">Last query executed</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24table_prefix" title="$table_prefix :: "><span class="description">$table_prefix</span><pre>$table_prefix</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
<li class="property protected inherited"><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: "><span class="description">$escape_char</span><pre>$escape_char</pre></a></li>
<li class="property protected inherited"><a href="#%24statement" title="$statement :: "><span class="description">$statement</span><pre>$statement</pre></a></li>
</ul>
</div>
<div class="span8">
@ -774,6 +777,25 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="quote_table" id="quote_table"></a><div class="element clickable method public quote_table" data-toggle="collapse" data-target=".quote_table .collapse">
<h2>Quote database table name, and set prefix</h2>
<pre>quote_table(mixed $table) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::quote_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
<h2>rollBack()
</h2>
@ -838,6 +860,25 @@ the connection/database</h2>
</div>
</div></div>
</div>
<a name="_prefix" id="_prefix"></a><div class="element clickable method protected _prefix" data-toggle="collapse" data-target="._prefix .collapse">
<h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::_prefix()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
@ -860,8 +901,8 @@ the connection/database</h2>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24last_query" id="$last_query"> </a><div class="element clickable property public $last_query" data-toggle="collapse" data-target=".$last_query .collapse">
<h2>Last query executed</h2>
<pre>$last_query : string</pre>
<h2>$last_query</h2>
<pre>$last_query </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -872,8 +913,8 @@ the connection/database</h2>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<h2>Reference to sql sub class</h2>
<pre>$sql : Object</pre>
<h2>$sql</h2>
<pre>$sql </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -883,9 +924,21 @@ the connection/database</h2>
</tr></table>
</div></div>
</div>
<a name="%24table_prefix" id="$table_prefix"> </a><div class="element clickable property public $table_prefix" data-toggle="collapse" data-target=".$table_prefix .collapse">
<h2>$table_prefix</h2>
<pre>$table_prefix </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$table_prefix</td>
</tr></table>
</div></div>
</div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
<h2>Reference to util sub class</h2>
<pre>$util : Object</pre>
<h2>$util</h2>
<pre>$util </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -896,8 +949,8 @@ the connection/database</h2>
</div></div>
</div>
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
<h2>Character to escape identifiers</h2>
<pre>$escape_char : string</pre>
<h2>$escape_char</h2>
<pre>$escape_char </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -908,8 +961,8 @@ the connection/database</h2>
</div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<h2>Reference to the last executed query</h2>
<pre>$statement : mixed</pre>
<h2>$statement</h2>
<pre>$statement </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -926,7 +979,7 @@ the connection/database</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

79
docs/classes/PgSQL_SQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -58,18 +58,13 @@
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
<li class="method public "><a href="#column_list" title="column_list :: Return sql to list columns of the specified table"><span class="description">Return sql to list columns of the specified table</span><pre>column_list()</pre></a></li>
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
<li class="method public inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
@ -94,20 +89,6 @@
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
<h2>Get the 'average' keyword</h2>
<pre>avg() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::avg()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
<h2>Return sql to list columns of the specified table</h2>
<pre>column_list(string $table) : string</pre>
@ -133,20 +114,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Get the 'distinct' keyword</h2>
<pre>distinct() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::distinct()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
<h2>Return sql to list functions</h2>
<pre>function_list() : FALSE</pre>
@ -180,34 +147,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
<h2>Get the max keyword sql</h2>
<pre>max() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::max()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
<h2>Get the min keyword sql</h2>
<pre>min() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::min()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre>
@ -238,20 +177,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
<h2>Get the 'sum' keyword</h2>
<pre>sum() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::sum()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
<h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre>
@ -309,7 +234,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/PgSQL_Util.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -209,7 +209,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

71
docs/classes/Query_Builder.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -112,10 +112,10 @@ Note: this function works with key / value, or a
passed array with key / value pairs</span><pre>where()</pre></a></li>
<li class="method public "><a href="#where_in" title="where_in :: Where clause with 'IN' statement"><span class="description">Where clause with 'IN' statement</span><pre>where_in()</pre></a></li>
<li class="method public "><a href="#where_not_in" title="where_not_in :: WHERE NOT IN (FOO) clause"><span class="description">WHERE NOT IN (FOO) clause</span><pre>where_not_in()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><a href="#_get_compile" title="_get_compile :: Helper function for returning sql strings"><span class="description">Helper function for returning sql strings</span><pre>_get_compile()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#_compile" title="_compile :: String together the sql statements for sending to the db"><span class="description">String together the sql statements for sending to the db</span><pre>_compile()</pre></a></li>
<li class="method private "><a href="#_connect" title="_connect :: Create the dsn for connection to the database"><span class="description">Create the dsn for connection to the database</span><pre>_connect()</pre></a></li>
<li class="method private "><a href="#_get_compile" title="_get_compile :: Helper function for returning sql strings"><span class="description">Helper function for returning sql strings</span><pre>_get_compile()</pre></a></li>
<li class="method private "><a href="#_having" title="_having :: Simplify building having clauses"><span class="description">Simplify building having clauses</span><pre>_having()</pre></a></li>
<li class="method private "><a href="#_like" title="_like :: Simplify 'like' methods"><span class="description">Simplify 'like' methods</span><pre>_like()</pre></a></li>
<li class="method private "><a href="#_run" title="_run :: Executes the compiled query"><span class="description">Executes the compiled query</span><pre>_run()</pre></a></li>
@ -264,7 +264,7 @@ in place of the get() method</h2>
</div>
<a name="from" id="from"></a><div class="element clickable method public from" data-toggle="collapse" data-target=".from .collapse">
<h2>Specify the database table to select from</h2>
<pre>from(string $dbname) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<pre>from(string $tblname) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -274,7 +274,7 @@ in place of the get() method</h2>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dbname</h4>
<h4>$tblname</h4>
<code>string</code>
</div>
<h3>Returns</h3>
@ -1026,7 +1026,45 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a name="_get_compile" id="_get_compile"></a><div class="element clickable method protected _get_compile" data-toggle="collapse" data-target="._get_compile .collapse">
<a name="_compile" id="_compile"></a><div class="element clickable method private _compile" data-toggle="collapse" data-target="._compile .collapse">
<h2>String together the sql statements for sending to the db</h2>
<pre>_compile(string $type, string $table) : \$string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\$string</code></div>
</div></div>
</div>
<a name="_connect" id="_connect"></a><div class="element clickable method private _connect" data-toggle="collapse" data-target="._connect .collapse">
<h2>Create the dsn for connection to the database</h2>
<pre>_connect(string $dbtype, object $params) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dbtype</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>object</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_get_compile" id="_get_compile"></a><div class="element clickable method private _get_compile" data-toggle="collapse" data-target="._get_compile .collapse">
<h2>Helper function for returning sql strings</h2>
<pre>_get_compile(string $type, string $table, $reset) </pre>
<div class="labels"></div>
@ -1050,25 +1088,6 @@ passed array with key / value pairs</h2>
<code></code><p>bool</p></div>
</div></div>
</div>
<a name="_compile" id="_compile"></a><div class="element clickable method private _compile" data-toggle="collapse" data-target="._compile .collapse">
<h2>String together the sql statements for sending to the db</h2>
<pre>_compile(string $type, string $table) : \$string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\$string</code></div>
</div></div>
</div>
<a name="_having" id="_having"></a><div class="element clickable method private _having" data-toggle="collapse" data-target="._having .collapse">
<h2>Simplify building having clauses</h2>
<pre>_having(mixed $key, mixed $val, string $conj) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
@ -1365,7 +1384,7 @@ passed array with key / value pairs</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/Query_Parser.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -145,7 +145,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

81
docs/classes/SQLite.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -110,6 +110,7 @@ method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pr
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
</span><pre>quote()</pre></a></li>
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public inherited"><a href="#quote_table" title="quote_table :: Quote database table name, and set prefix"><span class="description">Quote database table name, and set prefix</span><pre>quote_table()</pre></a></li>
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
</span><pre>rollBack()</pre></a></li>
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
@ -118,14 +119,16 @@ method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pr
<li class="method public "><a href="#truncate" title="truncate :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
<li class="method public "><a href="#unload_database" title="unload_database :: Unload a database from the current connection"><span class="description">Unload a database from the current connection</span><pre>unload_database()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#_prefix" title="_prefix :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li>
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: Last query executed"><span class="description">Last query executed</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24table_prefix" title="$table_prefix :: "><span class="description">$table_prefix</span><pre>$table_prefix</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: "><span class="description">$escape_char</span><pre>$escape_char</pre></a></li>
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last executed sql query"><span class="description">Reference to the last executed sql query</span><pre>$statement</pre></a></li>
</ul>
</div>
@ -782,6 +785,25 @@ method if the database does not support 'TRUNCATE';</h2>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="quote_table" id="quote_table"></a><div class="element clickable method public quote_table" data-toggle="collapse" data-target=".quote_table .collapse">
<h2>Quote database table name, and set prefix</h2>
<pre>quote_table(mixed $table) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::quote_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
<h2>rollBack()
</h2>
@ -859,6 +881,25 @@ method if the database does not support 'TRUNCATE';</h2>
</div>
</div></div>
</div>
<a name="_prefix" id="_prefix"></a><div class="element clickable method protected _prefix" data-toggle="collapse" data-target="._prefix .collapse">
<h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::_prefix()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
@ -881,8 +922,8 @@ method if the database does not support 'TRUNCATE';</h2>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24last_query" id="$last_query"> </a><div class="element clickable property public $last_query" data-toggle="collapse" data-target=".$last_query .collapse">
<h2>Last query executed</h2>
<pre>$last_query : string</pre>
<h2>$last_query</h2>
<pre>$last_query </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -893,8 +934,8 @@ method if the database does not support 'TRUNCATE';</h2>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<h2>Reference to sql sub class</h2>
<pre>$sql : Object</pre>
<h2>$sql</h2>
<pre>$sql </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -904,9 +945,21 @@ method if the database does not support 'TRUNCATE';</h2>
</tr></table>
</div></div>
</div>
<a name="%24table_prefix" id="$table_prefix"> </a><div class="element clickable property public $table_prefix" data-toggle="collapse" data-target=".$table_prefix .collapse">
<h2>$table_prefix</h2>
<pre>$table_prefix </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$table_prefix</td>
</tr></table>
</div></div>
</div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
<h2>Reference to util sub class</h2>
<pre>$util : Object</pre>
<h2>$util</h2>
<pre>$util </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -917,8 +970,8 @@ method if the database does not support 'TRUNCATE';</h2>
</div></div>
</div>
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
<h2>Character to escape identifiers</h2>
<pre>$escape_char : string</pre>
<h2>$escape_char</h2>
<pre>$escape_char </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
@ -941,7 +994,7 @@ method if the database does not support 'TRUNCATE';</h2>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

79
docs/classes/SQLite_SQL.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -58,18 +58,13 @@
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
<li class="method public "><a href="#column_list" title="column_list :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a table</span><pre>column_list()</pre></a></li>
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
<li class="method public inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
<li class="method public "><a href="#system_table_list" title="system_table_list :: Overridden in SQLite class"><span class="description">Overridden in SQLite class</span><pre>system_table_list()</pre></a></li>
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
@ -94,20 +89,6 @@
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
<h2>Get the 'average' keyword</h2>
<pre>avg() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::avg()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
<h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : string</pre>
@ -133,20 +114,6 @@
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Get the 'distinct' keyword</h2>
<pre>distinct() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::distinct()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
<h2>Return sql to list functions</h2>
<pre>function_list() : FALSE</pre>
@ -180,34 +147,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
<h2>Get the max keyword sql</h2>
<pre>max() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::max()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
<h2>Get the min keyword sql</h2>
<pre>min() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::min()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : FALSE</pre>
@ -238,20 +177,6 @@
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
<h2>Get the 'sum' keyword</h2>
<pre>sum() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_SQL::sum()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
<h2>Overridden in SQLite class</h2>
<pre>system_table_list() : string</pre>
@ -309,7 +234,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/classes/SQLite_Util.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -209,7 +209,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/deprecated.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -68,7 +68,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

87
docs/errors.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -57,6 +57,7 @@
<button class="btn critical">Critical</button><button class="btn error">Error</button><button class="btn notice">Notice</button>
</div></li>
<li class="nav-header">Navigation</li>
<li><a href="#classes/db_pdo.php"><i class="icon-file"></i>classes/db_pdo.php</a></li>
<li><a href="#classes/query_builder.php"><i class="icon-file"></i>classes/query_builder.php</a></li>
</ul></div>
<div class="span8">
@ -68,7 +69,50 @@
</ul>
<div class="package-contents"></div>
<div class="package-contents"></div>
<div class="package-contents"></div>
<div class="package-contents">
<a name="classes/db_pdo.php" id="classes/db_pdo.php"></a><h3>
<i class="icon-file"></i>classes/db_pdo.php<small style="float: right;padding-right: 10px;">6</small>
</h3>
<div><table class="table markers table-bordered">
<thead><tr>
<th>Type</th>
<th>Line</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr class="error">
<td>error</td>
<td>27</td>
<td>No DocBlock was found for property $statement</td>
</tr>
<tr class="error">
<td>error</td>
<td>30</td>
<td>No DocBlock was found for property $escape_char</td>
</tr>
<tr class="error">
<td>error</td>
<td>33</td>
<td>No DocBlock was found for property $sql</td>
</tr>
<tr class="error">
<td>error</td>
<td>36</td>
<td>No DocBlock was found for property $util</td>
</tr>
<tr class="error">
<td>error</td>
<td>39</td>
<td>No DocBlock was found for property $last_query</td>
</tr>
<tr class="error">
<td>error</td>
<td>42</td>
<td>No DocBlock was found for property $table_prefix</td>
</tr>
</tbody>
</table></div>
</div>
<div class="package-contents">
<a name="classes/query_builder.php" id="classes/query_builder.php"></a><h3>
<i class="icon-file"></i>classes/query_builder.php<small style="float: right;padding-right: 10px;">18</small>
@ -82,92 +126,92 @@
<tbody>
<tr class="error">
<td>error</td>
<td>50</td>
<td>30</td>
<td>No DocBlock was found for property $select_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>53</td>
<td>33</td>
<td>No DocBlock was found for property $from_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>56</td>
<td>36</td>
<td>No DocBlock was found for property $set_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>59</td>
<td>39</td>
<td>No DocBlock was found for property $order_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>62</td>
<td>42</td>
<td>No DocBlock was found for property $group_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>69</td>
<td>49</td>
<td>No DocBlock was found for property $set_array_keys</td>
</tr>
<tr class="error">
<td>error</td>
<td>72</td>
<td>52</td>
<td>No DocBlock was found for property $order_array</td>
</tr>
<tr class="error">
<td>error</td>
<td>75</td>
<td>55</td>
<td>No DocBlock was found for property $group_array</td>
</tr>
<tr class="error">
<td>error</td>
<td>82</td>
<td>62</td>
<td>No DocBlock was found for property $values</td>
</tr>
<tr class="error">
<td>error</td>
<td>85</td>
<td>65</td>
<td>No DocBlock was found for property $where_values</td>
</tr>
<tr class="error">
<td>error</td>
<td>88</td>
<td>68</td>
<td>No DocBlock was found for property $limit</td>
</tr>
<tr class="error">
<td>error</td>
<td>91</td>
<td>71</td>
<td>No DocBlock was found for property $offset</td>
</tr>
<tr class="error">
<td>error</td>
<td>94</td>
<td>74</td>
<td>No DocBlock was found for property $sql</td>
</tr>
<tr class="error">
<td>error</td>
<td>97</td>
<td>77</td>
<td>No DocBlock was found for property $table_prefix</td>
</tr>
<tr class="error">
<td>error</td>
<td>108</td>
<td>88</td>
<td>No DocBlock was found for property $query_map</td>
</tr>
<tr class="error">
<td>error</td>
<td>111</td>
<td>91</td>
<td>No DocBlock was found for property $having_map</td>
</tr>
<tr class="error">
<td>error</td>
<td>114</td>
<td>94</td>
<td>No DocBlock was found for property $conn_name</td>
</tr>
<tr class="error">
<td>error</td>
<td>117</td>
<td>97</td>
<td>No DocBlock was found for property $queries</td>
</tr>
</tbody>
@ -191,12 +235,13 @@
<div class="package-contents"></div>
<div class="package-contents"></div>
<div class="package-contents"></div>
<div class="package-contents"></div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/graph_class.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -65,7 +65,7 @@
</script><div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/markers.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -146,7 +146,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/namespaces/default.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -318,7 +318,7 @@ instantiates the specific db driver</p>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/packages/.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -68,7 +68,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/packages/Default.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -95,7 +95,7 @@
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/packages/Query.Drivers.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -212,7 +212,7 @@ data-fetching methods</p>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

8
docs/packages/Query.Query.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -66,11 +66,11 @@
<li><a href="#Query_Parser" title="Utility Class to parse sql clauses for properly escaping identifiers">Query_Parser</a></li>
<li><a href="#DB_SQL" title="Abstract parent for database manipulation subclasses">DB_SQL</a></li>
<li><a href="#DB_PDO" title="Base Database class">DB_PDO</a></li>
<li><a href="#BadDBDriverException" title="Generic exception for bad drivers">BadDBDriverException</a></li>
<li><a href="#BadConnectionException" title="Generic exception for bad connection strings">BadConnectionException</a></li>
<li><a href="#Query_Builder" title="Convienience class for creating sql queries - also the class that
instantiates the specific db driver">Query_Builder</a></li>
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></li>
<li><a href="#BadDBDriverException" title="Generic exception for bad drivers">BadDBDriverException</a></li>
<li><a href="#BadConnectionException" title="Generic exception for bad connection strings">BadConnectionException</a></li>
</ul>
</div>
<div class="span8 package-contents">
@ -140,7 +140,7 @@ instantiates the specific db driver</p>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

4
docs/packages/Query.html
View File

@ -32,7 +32,7 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">18</span></a></li>
<span class="label label-info">24</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">4</span>
@ -339,7 +339,7 @@ instantiates the specific db driver</p>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-10-30T16:14:25Z.<br></footer></div>
generated on 2012-11-07T08:57:16-05:00.<br></footer></div>
</div>
</body>
</html>

2317
docs/structure.xml
View File

File diff suppressed because it is too large Load Diff