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

Fix some issues with the grouping commands, and greatly expand test coverage

Browse Source
This commit is contained in:
Timothy Warren 2013-12-06 23:00:32 -05:00
parent 6dfb94b375
commit c53024ae6a
57 changed files with 7039 additions and 12999 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@ -3,4 +3,8 @@ index.html
tests/db_files/* tests/db_files/*
._* ._*
tests/settings.json tests/settings.json
.php_cs .php_cs
coverage/*
vendor/*
composer.lock
docs/phpdoc*

7
.travis.yml
View File

@ -4,10 +4,15 @@ php:
- 5.2 - 5.2
- 5.3 - 5.3
- 5.4 - 5.4
- 5.5
before_script: before_script:
- sh -c "psql -c 'DROP DATABASE IF EXISTS test;' -U postgres" - sh -c "psql -c 'DROP DATABASE IF EXISTS test;' -U postgres"
- sh -c "psql -c 'create database test;' -U postgres" - sh -c "psql -c 'create database test;' -U postgres"
- sh -c "mysql -e 'create database IF NOT EXISTS test;'" - sh -c "mysql -e 'create database IF NOT EXISTS test;'"
- phpenv config-add ./tests/php_test.ini
script: php ./tests/index.php script: php ./tests/index.php
install:
- composer install --dev

39
classes/query_builder.php
View File

@ -82,7 +82,7 @@ class Query_Builder implements iQuery_Builder {
// 'conjunction' => ' AND ', // 'conjunction' => ' AND ',
// 'string' => 'k=?' // 'string' => 'k=?'
// ) // )
protected $query_map; protected $query_map = array();
// Map for having clause // Map for having clause
protected $having_map; protected $having_map;
@ -523,11 +523,28 @@ class Query_Builder implements iQuery_Builder {
// Simple key value, or an operator // Simple key value, or an operator
$item .= (count($f_array) === 1) ? '=?' : " {$f_array[1]} ?"; $item .= (count($f_array) === 1) ? '=?' : " {$f_array[1]} ?";
// Get the type of the first item in the query map
$first_item = end($this->query_map);
// Determine the correct conjunction
if (empty($this->query_map))
{
$conj = ' WHERE ';
}
elseif ($first_item['type'] === 'group_start')
{
$conj = '';
}
else
{
$conj = " {$conj} ";
}
// Put in the query map for select statements // Put in the query map for select statements
$this->query_map[] = array( $this->query_map[] = array(
'type' => 'where', 'type' => 'where',
'conjunction' => ( ! empty($this->query_map)) ? " {$conj} " : ' WHERE ', 'conjunction' => $conj,
'string' => $item 'string' => $item
); );
} }
@ -542,8 +559,8 @@ class Query_Builder implements iQuery_Builder {
* *
* @param mixed $key * @param mixed $key
* @param mixed $val * @param mixed $val
* @param string * @param string $in - The (not) in fragment
* @param string * @param string $conj - The where in conjunction
* @return $this * @return $this
*/ */
protected function _where_in($key, $val=array(), $in='IN', $conj='AND') protected function _where_in($key, $val=array(), $in='IN', $conj='AND')
@ -749,7 +766,8 @@ class Query_Builder implements iQuery_Builder {
{ {
if ( ! is_scalar($field)) if ( ! is_scalar($field))
{ {
$this->group_array = $this->db->quote_ident($field); $new_group_array = array_map(array($this->db, 'quote_ident'), $field);
$this->group_array = array_merge($this->group_array, $new_group_array);
} }
else else
{ {
@ -828,8 +846,8 @@ class Query_Builder implements iQuery_Builder {
{ {
$this->query_map[] = array( $this->query_map[] = array(
'type' => 'group_start', 'type' => 'group_start',
'conjunction' => '', 'conjunction' => (empty($this->query_map)) ? ' WHERE ' : ' ',
'string' => ' (' 'string' => '('
); );
return $this; return $this;
@ -885,7 +903,7 @@ class Query_Builder implements iQuery_Builder {
$this->query_map[] = array( $this->query_map[] = array(
'type' => 'group_end', 'type' => 'group_end',
'conjunction' => '', 'conjunction' => '',
'string' => ' ) ' 'string' => ')'
); );
return $this; return $this;
@ -1150,7 +1168,7 @@ class Query_Builder implements iQuery_Builder {
* *
* @param string $type * @param string $type
* @param string $table * @param string $table
* @param bool * @param bool $reset
* @resturn string * @resturn string
*/ */
protected function _get_compile($type, $table, $reset) protected function _get_compile($type, $table, $reset)
@ -1192,6 +1210,7 @@ class Query_Builder implements iQuery_Builder {
// Set empty arrays // Set empty arrays
$this->values = array(); $this->values = array();
$this->query_map = array();
// Set select string as an empty string, for proper handling // Set select string as an empty string, for proper handling
// of the 'distinct' keyword // of the 'distinct' keyword
@ -1331,7 +1350,7 @@ class Query_Builder implements iQuery_Builder {
// Set the where clause // Set the where clause
if ( ! empty($this->query_map)) if ( ! empty($this->query_map))
{ {
foreach($this->query_map as $q) foreach($this->query_map as $k => $q)
{ {
$sql .= $q['conjunction'] . $q['string']; $sql .= $q['conjunction'] . $q['string'];
} }

3
composer.json
View File

@ -19,6 +19,9 @@
"homepage": "https://timshomepage.net", "homepage": "https://timshomepage.net",
"role": "Developer" "role": "Developer"
}], }],
"require-dev": {
"phpunit/php-code-coverage": ">=1.2.10,<1.3.0",
},
"require": { "require": {
"php": ">=5.2.0" "php": ">=5.2.0"
}, },

341
docs/classes.svg
View File

@ -4,35 +4,32 @@
<!-- Generated by graphviz version 2.26.3 (20100126.1600) <!-- Generated by graphviz version 2.26.3 (20100126.1600)
--> -->
<!-- Title: G Pages: 1 --> <!-- Title: G Pages: 1 -->
<svg width="690pt" height="1246pt" <svg width="680pt" height="1267pt"
viewBox="0.00 0.00 690.00 1246.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> viewBox="0.00 0.00 680.00 1267.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph1" class="graph" transform="scale(1 1) rotate(0) translate(4 1242)"> <g id="graph1" class="graph" transform="scale(1 1) rotate(0) translate(4 1263)">
<title>G</title> <title>G</title>
<polygon fill="white" stroke="white" points="-4,5 -4,-1242 687,-1242 687,5 -4,5"/> <polygon fill="white" stroke="white" points="-4,5 -4,-1263 677,-1263 677,5 -4,5"/>
<g id="graph2" class="cluster"><title>cluster_default</title> <g id="graph2" class="cluster"><title>cluster_Global</title>
<polyline fill="none" stroke="none" points="235,-152 662,-152 "/> <polyline fill="none" stroke="gray" points="242,-152 652,-152 "/>
<path fill="none" stroke="none" d="M662,-152C668,-152 674,-158 674,-164"/> <path fill="none" stroke="gray" d="M652,-152C658,-152 664,-158 664,-164"/>
<polyline fill="none" stroke="none" points="674,-164 674,-1218 "/> <polyline fill="none" stroke="gray" points="664,-164 664,-1239 "/>
<path fill="none" stroke="none" d="M674,-1218C674,-1224 668,-1230 662,-1230"/> <path fill="none" stroke="gray" d="M664,-1239C664,-1245 658,-1251 652,-1251"/>
<polyline fill="none" stroke="none" points="662,-1230 235,-1230 "/> <polyline fill="none" stroke="gray" points="652,-1251 242,-1251 "/>
<path fill="none" stroke="none" d="M235,-1230C229,-1230 223,-1224 223,-1218"/> <path fill="none" stroke="gray" d="M242,-1251C236,-1251 230,-1245 230,-1239"/>
<polyline fill="none" stroke="none" points="223,-1218 223,-164 "/> <polyline fill="none" stroke="gray" points="230,-1239 230,-164 "/>
<path fill="none" stroke="none" d="M223,-164C223,-158 229,-152 235,-152"/> <path fill="none" stroke="gray" d="M230,-164C230,-158 236,-152 242,-152"/>
<text text-anchor="middle" x="447" y="-1237.1" font-family="Times Roman,serif" font-size="11.00" fill="gray">\</text>
</g> </g>
<!-- \\Query_Parser --> <!-- \\Query_Parser -->
<g id="node2" class="node"><title>\\Query_Parser</title> <g id="node2" class="node"><title>\\Query_Parser</title>
<a xlink:href="classes.query_parser.html" xlink:title="Query_Parser" target="_parent"> <polygon fill="none" stroke="black" points="624,-1222 534,-1222 534,-1186 624,-1186 624,-1222"/>
<polygon fill="none" stroke="black" points="632,-1222 536,-1222 536,-1186 632,-1186 632,-1222"/> <text text-anchor="middle" x="579" y="-1200.6" font-family="Times Roman,serif" font-size="11.00">Query_Parser</text>
<text text-anchor="middle" x="584" y="-1200.6" font-family="Courier,monospace" font-size="11.00">Query_Parser</text>
</a>
</g> </g>
<!-- \\DB_PDO --> <!-- \\DB_PDO -->
<g id="node3" class="node"><title>\\DB_PDO</title> <g id="node3" class="node"><title>\\DB_PDO</title>
<a xlink:href="classes.db_pdo.html" xlink:title="«abstract»&lt;br/&gt;DB_PDO" target="_parent"> <polygon fill="none" stroke="black" points="325,-466 249,-466 249,-430 325,-430 325,-466"/>
<polygon fill="none" stroke="black" points="329,-466 245,-466 245,-430 329,-430 329,-466"/> <text text-anchor="start" x="257.5" y="-453.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="253" y="-453.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text> <text text-anchor="start" x="264" y="-440.233" font-family="Times Roman,serif" font-size="11.00">DB_PDO</text>
<text text-anchor="start" x="266.5" y="-440.233" font-family="Courier,monospace" font-size="11.00">DB_PDO</text>
</a>
</g> </g>
<!-- \\PDO --> <!-- \\PDO -->
<g id="node27" class="node"><title>\\PDO</title> <g id="node27" class="node"><title>\\PDO</title>
@ -41,273 +38,229 @@
</g> </g>
<!-- \\DB_PDO&#45;&gt;\\PDO --> <!-- \\DB_PDO&#45;&gt;\\PDO -->
<g id="edge3" class="edge"><title>\\DB_PDO&#45;&gt;\\PDO</title> <g id="edge3" class="edge"><title>\\DB_PDO&#45;&gt;\\PDO</title>
<path fill="none" stroke="black" d="M244.421,-448C199.3,-448 128.295,-448 81.9376,-448"/> <path fill="none" stroke="black" d="M248.879,-448C204.032,-448 129.635,-448 81.7269,-448"/>
<polygon fill="none" stroke="black" points="81.8642,-444.5 71.8642,-448 81.8642,-451.5 81.8642,-444.5"/> <polygon fill="none" stroke="black" points="81.6312,-444.5 71.6312,-448 81.6311,-451.5 81.6312,-444.5"/>
</g> </g>
<!-- \\Query_Builder --> <!-- \\Query_Builder -->
<g id="node4" class="node"><title>\\Query_Builder</title> <g id="node4" 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="626,-1168 532,-1168 532,-1132 626,-1132 626,-1168"/>
<polygon fill="none" stroke="black" points="636,-1168 532,-1168 532,-1132 636,-1132 636,-1168"/> <text text-anchor="middle" x="579" y="-1146.6" font-family="Times Roman,serif" font-size="11.00">Query_Builder</text>
<text text-anchor="middle" x="584" y="-1146.6" font-family="Courier,monospace" font-size="11.00">Query_Builder</text>
</a>
</g> </g>
<!-- \\iQuery_Builder --> <!-- \\iQuery_Builder -->
<g id="node6" class="node"><title>\\iQuery_Builder</title> <g id="node25" class="node"><title>\\iQuery_Builder</title>
<a xlink:href="classes.iquery_builder.html" xlink:title="iQuery_Builder" target="_parent"> <polygon fill="none" stroke="black" points="336,-1168 238,-1168 238,-1132 336,-1132 336,-1168"/>
<polygon fill="none" stroke="black" points="342,-1168 232,-1168 232,-1132 342,-1132 342,-1168"/> <text text-anchor="middle" x="287" y="-1146.6" font-family="Times Roman,serif" font-size="11.00">iQuery_Builder</text>
<text text-anchor="middle" x="287" y="-1146.6" font-family="Courier,monospace" font-size="11.00">iQuery_Builder</text>
</a>
</g> </g>
<!-- \\Query_Builder&#45;&gt;\\iQuery_Builder --> <!-- \\Query_Builder&#45;&gt;\\iQuery_Builder -->
<g id="edge31" class="edge"><title>\\Query_Builder&#45;&gt;\\iQuery_Builder</title> <g id="edge5" class="edge"><title>\\Query_Builder&#45;&gt;\\iQuery_Builder</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M531.927,-1150C482.07,-1150 406.665,-1150 352.701,-1150"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M531.435,-1150C480.879,-1150 400.848,-1150 346.235,-1150"/>
<polygon fill="none" stroke="black" points="352.547,-1146.5 342.547,-1150 352.547,-1153.5 352.547,-1146.5"/> <polygon fill="none" stroke="black" points="346.007,-1146.5 336.007,-1150 346.007,-1153.5 346.007,-1146.5"/>
</g>
<!-- \\iDB_SQL -->
<g id="node5" class="node"><title>\\iDB_SQL</title>
<a xlink:href="classes.idb_sql.html" xlink:title="iDB_SQL" target="_parent">
<polygon fill="none" stroke="black" points="319,-736 255,-736 255,-700 319,-700 319,-736"/>
<text text-anchor="middle" x="287" y="-714.6" font-family="Courier,monospace" font-size="11.00">iDB_SQL</text>
</a>
</g> </g>
<!-- \\DB_Util --> <!-- \\DB_Util -->
<g id="node7" class="node"><title>\\DB_Util</title> <g id="node5" 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="325,-1006 249,-1006 249,-970 325,-970 325,-1006"/>
<polygon fill="none" stroke="black" points="329,-1006 245,-1006 245,-970 329,-970 329,-1006"/> <text text-anchor="start" x="257.5" y="-993.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="253" y="-993.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text> <text text-anchor="start" x="266.5" y="-980.233" font-family="Times Roman,serif" font-size="11.00">DB_Util</text>
<text text-anchor="start" x="263" y="-980.233" font-family="Courier,monospace" font-size="11.00">DB_Util</text>
</a>
</g> </g>
<!-- \\BadDBDriverException --> <!-- \\BadDBDriverException -->
<g id="node8" class="node"><title>\\BadDBDriverException</title> <g id="node6" class="node"><title>\\BadDBDriverException</title>
<a xlink:href="common.html" xlink:title="BadDBDriverException" target="_parent"> <polygon fill="none" stroke="black" points="650,-304 508,-304 508,-268 650,-268 650,-304"/>
<polygon fill="none" stroke="black" points="659,-304 509,-304 509,-268 659,-268 659,-304"/> <text text-anchor="middle" x="579" y="-282.6" font-family="Times Roman,serif" font-size="11.00">BadDBDriverException</text>
<text text-anchor="middle" x="584" y="-282.6" font-family="Courier,monospace" font-size="11.00">BadDBDriverException</text>
</a>
</g> </g>
<!-- \\InvalidArgumentException --> <!-- \\InvalidArgumentException -->
<g id="node29" class="node"><title>\\InvalidArgumentException</title> <g id="node30" class="node"><title>\\InvalidArgumentException</title>
<ellipse fill="none" stroke="black" cx="287" cy="-126" rx="138.86" ry="18"/> <ellipse fill="none" stroke="black" cx="287" cy="-126" rx="138.86" ry="18"/>
<text text-anchor="middle" x="287" y="-121.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\InvalidArgumentException</text> <text text-anchor="middle" x="287" y="-121.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\InvalidArgumentException</text>
</g> </g>
<!-- \\BadDBDriverException&#45;&gt;\\InvalidArgumentException --> <!-- \\BadDBDriverException&#45;&gt;\\InvalidArgumentException -->
<g id="edge5" class="edge"><title>\\BadDBDriverException&#45;&gt;\\InvalidArgumentException</title> <g id="edge7" class="edge"><title>\\BadDBDriverException&#45;&gt;\\InvalidArgumentException</title>
<path fill="none" stroke="black" d="M516.286,-267.962C511.227,-265.357 506.392,-262.386 502,-259 455.429,-223.099 479.379,-179.93 430,-148 425,-144.767 419.701,-141.944 414.199,-139.483"/> <path fill="none" stroke="black" d="M515.792,-267.846C510.904,-265.262 506.232,-262.327 502,-259 455.775,-222.654 479.379,-179.93 430,-148 425,-144.767 419.701,-141.944 414.199,-139.483"/>
<polygon fill="none" stroke="black" points="415.351,-136.174 404.768,-135.674 412.73,-142.664 415.351,-136.174"/> <polygon fill="none" stroke="black" points="415.351,-136.174 404.768,-135.674 412.73,-142.664 415.351,-136.174"/>
</g> </g>
<!-- \\BadConnectionException --> <!-- \\BadConnectionException -->
<g id="node9" class="node"><title>\\BadConnectionException</title> <g id="node7" class="node"><title>\\BadConnectionException</title>
<a xlink:href="common.html" xlink:title="BadConnectionException" target="_parent"> <polygon fill="none" stroke="black" points="656,-250 502,-250 502,-214 656,-214 656,-250"/>
<polygon fill="none" stroke="black" points="666,-250 502,-250 502,-214 666,-214 666,-250"/> <text text-anchor="middle" x="579" y="-228.6" font-family="Times Roman,serif" font-size="11.00">BadConnectionException</text>
<text text-anchor="middle" x="584" y="-228.6" font-family="Courier,monospace" font-size="11.00">BadConnectionException</text>
</a>
</g> </g>
<!-- \\UnexpectedValueException --> <!-- \\UnexpectedValueException -->
<g id="node31" class="node"><title>\\UnexpectedValueException</title> <g id="node32" class="node"><title>\\UnexpectedValueException</title>
<ellipse fill="none" stroke="black" cx="287" cy="-72" rx="142.885" ry="18"/> <ellipse fill="none" stroke="black" cx="287" cy="-72" rx="142.885" ry="18"/>
<text text-anchor="middle" x="287" y="-67.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\UnexpectedValueException</text> <text text-anchor="middle" x="287" y="-67.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\UnexpectedValueException</text>
</g> </g>
<!-- \\BadConnectionException&#45;&gt;\\UnexpectedValueException --> <!-- \\BadConnectionException&#45;&gt;\\UnexpectedValueException -->
<g id="edge7" class="edge"><title>\\BadConnectionException&#45;&gt;\\UnexpectedValueException</title> <g id="edge9" class="edge"><title>\\BadConnectionException&#45;&gt;\\UnexpectedValueException</title>
<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"/> <path fill="none" stroke="black" d="M516.256,-213.95C511.211,-211.337 506.379,-208.369 502,-205 456.859,-170.276 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"/> <polygon fill="none" stroke="black" points="408.047,-83.7705 397.454,-83.5843 405.619,-90.3358 408.047,-83.7705"/>
</g> </g>
<!-- \\PgSQL_SQL --> <!-- \\PgSQL_SQL -->
<g id="node10" class="node"><title>\\PgSQL_SQL</title> <g id="node8" class="node"><title>\\PgSQL_SQL</title>
<a xlink:href="drivers.pgsql.pgsql_sql.html" xlink:title="PgSQL_SQL" target="_parent"> <polygon fill="none" stroke="black" points="619,-844 539,-844 539,-808 619,-808 619,-844"/>
<polygon fill="none" stroke="black" points="622,-844 546,-844 546,-808 622,-808 622,-844"/> <text text-anchor="middle" x="579" y="-822.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_SQL</text>
<text text-anchor="middle" x="584" y="-822.6" font-family="Courier,monospace" font-size="11.00">PgSQL_SQL</text> </g>
</a> <!-- \\iDB_SQL -->
<g id="node24" class="node"><title>\\iDB_SQL</title>
<polygon fill="none" stroke="black" points="318,-736 256,-736 256,-700 318,-700 318,-736"/>
<text text-anchor="middle" x="287" y="-714.6" font-family="Times Roman,serif" font-size="11.00">iDB_SQL</text>
</g> </g>
<!-- \\PgSQL_SQL&#45;&gt;\\iDB_SQL --> <!-- \\PgSQL_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge33" class="edge"><title>\\PgSQL_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge11" class="edge"><title>\\PgSQL_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M545.093,-813.561C531.426,-809.093 515.993,-803.937 502,-799 441.327,-777.593 371.756,-751.005 328.588,-734.264"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M538.973,-812.161C527.056,-807.988 513.982,-803.357 502,-799 441.314,-776.932 371.402,-750.382 328.201,-733.844"/>
<polygon fill="none" stroke="black" points="329.85,-730.999 319.262,-730.641 327.316,-737.524 329.85,-730.999"/> <polygon fill="none" stroke="black" points="329.199,-730.479 318.609,-730.169 326.694,-737.015 329.199,-730.479"/>
</g> </g>
<!-- \\PgSQL_Util --> <!-- \\PgSQL_Util -->
<g id="node11" class="node"><title>\\PgSQL_Util</title> <g id="node9" 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="617,-1114 541,-1114 541,-1078 617,-1078 617,-1114"/>
<polygon fill="none" stroke="black" points="626,-1114 542,-1114 542,-1078 626,-1078 626,-1114"/> <text text-anchor="middle" x="579" y="-1092.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_Util</text>
<text text-anchor="middle" x="584" y="-1092.6" font-family="Courier,monospace" font-size="11.00">PgSQL_Util</text>
</a>
</g> </g>
<!-- \\PgSQL_Util&#45;&gt;\\DB_Util --> <!-- \\PgSQL_Util&#45;&gt;\\DB_Util -->
<g id="edge9" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title> <g id="edge13" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title>
<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"/> <path fill="none" stroke="black" d="M540.948,-1082.85C528.512,-1078.5 514.647,-1073.6 502,-1069 444.323,-1048.03 378.311,-1023 334.819,-1006.38"/>
<polygon fill="none" stroke="black" points="340.227,-1005.02 329.637,-1004.67 337.7,-1011.54 340.227,-1005.02"/> <polygon fill="none" stroke="black" points="335.941,-1003.06 325.351,-1002.75 333.439,-1009.6 335.941,-1003.06"/>
</g> </g>
<!-- \\PgSQL --> <!-- \\PgSQL -->
<g id="node12" class="node"><title>\\PgSQL</title> <g id="node10" class="node"><title>\\PgSQL</title>
<a xlink:href="drivers.pgsql.pgsql_driver.html" xlink:title="PgSQL" target="_parent"> <polygon fill="none" stroke="black" points="606,-574 552,-574 552,-538 606,-538 606,-574"/>
<polygon fill="none" stroke="black" points="611,-574 557,-574 557,-538 611,-538 611,-574"/> <text text-anchor="middle" x="579" y="-552.6" font-family="Times Roman,serif" font-size="11.00">PgSQL</text>
<text text-anchor="middle" x="584" y="-552.6" font-family="Courier,monospace" font-size="11.00">PgSQL</text>
</a>
</g> </g>
<!-- \\PgSQL&#45;&gt;\\DB_PDO --> <!-- \\PgSQL&#45;&gt;\\DB_PDO -->
<g id="edge11" class="edge"><title>\\PgSQL&#45;&gt;\\DB_PDO</title> <g id="edge15" class="edge"><title>\\PgSQL&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M556.942,-547.408C540.912,-542.239 520.233,-535.433 502,-529 446.048,-509.258 382.529,-485.111 339.128,-468.343"/> <path fill="none" stroke="black" d="M551.863,-546.656C537.09,-541.525 518.508,-535.003 502,-529 444.323,-508.026 378.311,-483.004 334.819,-466.376"/>
<polygon fill="none" stroke="black" points="340.227,-465.016 329.637,-464.671 337.7,-471.544 340.227,-465.016"/> <polygon fill="none" stroke="black" points="335.941,-463.058 325.351,-462.753 333.439,-469.596 335.941,-463.058"/>
</g> </g>
<!-- \\ODBC_Util --> <!-- \\ODBC_Util -->
<g id="node13" class="node"><title>\\ODBC_Util</title> <g id="node11" 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="615,-1060 543,-1060 543,-1024 615,-1024 615,-1060"/>
<polygon fill="none" stroke="black" points="622,-1060 546,-1060 546,-1024 622,-1024 622,-1060"/> <text text-anchor="middle" x="579" y="-1038.6" font-family="Times Roman,serif" font-size="11.00">ODBC_Util</text>
<text text-anchor="middle" x="584" y="-1038.6" font-family="Courier,monospace" font-size="11.00">ODBC_Util</text>
</a>
</g> </g>
<!-- \\ODBC_Util&#45;&gt;\\DB_Util --> <!-- \\ODBC_Util&#45;&gt;\\DB_Util -->
<g id="edge13" class="edge"><title>\\ODBC_Util&#45;&gt;\\DB_Util</title> <g id="edge17" class="edge"><title>\\ODBC_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M545.477,-1035C492.953,-1025.45 398.67,-1008.3 339.653,-997.573"/> <path fill="none" stroke="black" d="M542.314,-1035.22C489.861,-1025.52 393.362,-1007.67 335.2,-996.914"/>
<polygon fill="none" stroke="black" points="340.244,-994.123 329.779,-995.778 338.991,-1001.01 340.244,-994.123"/> <polygon fill="none" stroke="black" points="335.626,-993.433 325.156,-995.056 334.353,-1000.32 335.626,-993.433"/>
</g> </g>
<!-- \\ODBC_SQL --> <!-- \\ODBC_SQL -->
<g id="node14" class="node"><title>\\ODBC_SQL</title> <g id="node12" class="node"><title>\\ODBC_SQL</title>
<a xlink:href="drivers.odbc.odbc_sql.html" xlink:title="ODBC_SQL" target="_parent"> <polygon fill="none" stroke="black" points="617,-790 541,-790 541,-754 617,-754 617,-790"/>
<polygon fill="none" stroke="black" points="619,-790 549,-790 549,-754 619,-754 619,-790"/> <text text-anchor="middle" x="579" y="-768.6" font-family="Times Roman,serif" font-size="11.00">ODBC_SQL</text>
<text text-anchor="middle" x="584" y="-768.6" font-family="Courier,monospace" font-size="11.00">ODBC_SQL</text>
</a>
</g> </g>
<!-- \\ODBC_SQL&#45;&gt;\\iDB_SQL --> <!-- \\ODBC_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge35" class="edge"><title>\\ODBC_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge19" class="edge"><title>\\ODBC_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M548.764,-765.593C493.827,-755.605 387.971,-736.358 329.099,-725.654"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M540.826,-764.94C486.106,-754.821 385.729,-736.258 328.978,-725.763"/>
<polygon fill="none" stroke="black" points="329.489,-722.168 319.024,-723.823 328.237,-729.055 329.489,-722.168"/> <polygon fill="none" stroke="black" points="329.379,-722.278 318.91,-723.901 328.106,-729.161 329.379,-722.278"/>
</g> </g>
<!-- \\ODBC --> <!-- \\ODBC -->
<g id="node15" class="node"><title>\\ODBC</title> <g id="node13" class="node"><title>\\ODBC</title>
<a xlink:href="drivers.odbc.odbc_driver.html" xlink:title="ODBC" target="_parent"> <polygon fill="none" stroke="black" points="606,-520 552,-520 552,-484 606,-484 606,-520"/>
<polygon fill="none" stroke="black" points="611,-520 557,-520 557,-484 611,-484 611,-520"/> <text text-anchor="middle" x="579" y="-498.6" font-family="Times Roman,serif" font-size="11.00">ODBC</text>
<text text-anchor="middle" x="584" y="-498.6" font-family="Courier,monospace" font-size="11.00">ODBC</text>
</a>
</g> </g>
<!-- \\ODBC&#45;&gt;\\DB_PDO --> <!-- \\ODBC&#45;&gt;\\DB_PDO -->
<g id="edge15" class="edge"><title>\\ODBC&#45;&gt;\\DB_PDO</title> <g id="edge21" class="edge"><title>\\ODBC&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M556.856,-497.065C507.751,-488.137 403.375,-469.159 339.79,-457.598"/> <path fill="none" stroke="black" d="M551.792,-496.968C502.303,-487.816 396.973,-468.338 335.113,-456.898"/>
<polygon fill="none" stroke="black" points="340.031,-454.085 329.566,-455.739 338.779,-460.972 340.031,-454.085"/> <polygon fill="none" stroke="black" points="335.672,-453.442 325.203,-455.065 334.399,-460.325 335.672,-453.442"/>
</g> </g>
<!-- \\MySQL_Util --> <!-- \\MySQL_Util -->
<g id="node16" class="node"><title>\\MySQL_Util</title> <g id="node14" class="node"><title>\\MySQL_Util</title>
<a xlink:href="drivers.mysql.mysql_util.html" xlink:title="MySQL_Util" target="_parent"> <polygon fill="none" stroke="black" points="618,-1006 540,-1006 540,-970 618,-970 618,-1006"/>
<polygon fill="none" stroke="black" points="626,-1006 542,-1006 542,-970 626,-970 626,-1006"/> <text text-anchor="middle" x="579" y="-984.6" font-family="Times Roman,serif" font-size="11.00">MySQL_Util</text>
<text text-anchor="middle" x="584" y="-984.6" font-family="Courier,monospace" font-size="11.00">MySQL_Util</text>
</a>
</g> </g>
<!-- \\MySQL_Util&#45;&gt;\\DB_Util --> <!-- \\MySQL_Util&#45;&gt;\\DB_Util -->
<g id="edge17" class="edge"><title>\\MySQL_Util&#45;&gt;\\DB_Util</title> <g id="edge23" class="edge"><title>\\MySQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M541.447,-988C488.447,-988 397.876,-988 340.305,-988"/> <path fill="none" stroke="black" d="M539.316,-988C486.322,-988 392.513,-988 335.42,-988"/>
<polygon fill="none" stroke="black" points="339.956,-984.5 329.956,-988 339.956,-991.5 339.956,-984.5"/> <polygon fill="none" stroke="black" points="335.205,-984.5 325.205,-988 335.205,-991.5 335.205,-984.5"/>
</g> </g>
<!-- \\MySQL --> <!-- \\MySQL -->
<g id="node17" class="node"><title>\\MySQL</title> <g id="node15" class="node"><title>\\MySQL</title>
<a xlink:href="drivers.mysql.mysql_driver.html" xlink:title="MySQL" target="_parent"> <polygon fill="none" stroke="black" points="606,-466 552,-466 552,-430 606,-430 606,-466"/>
<polygon fill="none" stroke="black" points="611,-466 557,-466 557,-430 611,-430 611,-466"/> <text text-anchor="middle" x="579" y="-444.6" font-family="Times Roman,serif" font-size="11.00">MySQL</text>
<text text-anchor="middle" x="584" y="-444.6" font-family="Courier,monospace" font-size="11.00">MySQL</text>
</a>
</g> </g>
<!-- \\MySQL&#45;&gt;\\DB_PDO --> <!-- \\MySQL&#45;&gt;\\DB_PDO -->
<g id="edge19" class="edge"><title>\\MySQL&#45;&gt;\\DB_PDO</title> <g id="edge25" class="edge"><title>\\MySQL&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M556.856,-448C507.751,-448 403.375,-448 339.79,-448"/> <path fill="none" stroke="black" d="M551.266,-448C501.608,-448 396.953,-448 335.287,-448"/>
<polygon fill="none" stroke="black" points="339.566,-444.5 329.566,-448 339.566,-451.5 339.566,-444.5"/> <polygon fill="none" stroke="black" points="335.035,-444.5 325.035,-448 335.035,-451.5 335.035,-444.5"/>
</g> </g>
<!-- \\MySQL_SQL --> <!-- \\MySQL_SQL -->
<g id="node18" class="node"><title>\\MySQL_SQL</title> <g id="node16" class="node"><title>\\MySQL_SQL</title>
<a xlink:href="drivers.mysql.mysql_sql.html" xlink:title="MySQL_SQL" target="_parent"> <polygon fill="none" stroke="black" points="620,-736 538,-736 538,-700 620,-700 620,-736"/>
<polygon fill="none" stroke="black" points="623,-736 545,-736 545,-700 623,-700 623,-736"/> <text text-anchor="middle" x="579" y="-714.6" font-family="Times Roman,serif" font-size="11.00">MySQL_SQL</text>
<text text-anchor="middle" x="584" y="-714.6" font-family="Courier,monospace" font-size="11.00">MySQL_SQL</text>
</a>
</g> </g>
<!-- \\MySQL_SQL&#45;&gt;\\iDB_SQL --> <!-- \\MySQL_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge37" class="edge"><title>\\MySQL_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge27" class="edge"><title>\\MySQL_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M544.867,-718C489.111,-718 387.199,-718 329.599,-718"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M537.783,-718C482.4,-718 384.499,-718 328.813,-718"/>
<polygon fill="none" stroke="black" points="329.381,-714.5 319.381,-718 329.381,-721.5 329.381,-714.5"/> <polygon fill="none" stroke="black" points="328.595,-714.5 318.595,-718 328.595,-721.5 328.595,-714.5"/>
</g> </g>
<!-- \\SQLite_Util --> <!-- \\SQLite_Util -->
<g id="node19" class="node"><title>\\SQLite_Util</title> <g id="node17" class="node"><title>\\SQLite_Util</title>
<a xlink:href="drivers.sqlite.sqlite_util.html" xlink:title="SQLite_Util" target="_parent"> <polygon fill="none" stroke="black" points="617,-952 541,-952 541,-916 617,-916 617,-952"/>
<polygon fill="none" stroke="black" points="629,-952 539,-952 539,-916 629,-916 629,-952"/> <text text-anchor="middle" x="579" y="-930.6" font-family="Times Roman,serif" font-size="11.00">SQLite_Util</text>
<text text-anchor="middle" x="584" y="-930.6" font-family="Courier,monospace" font-size="11.00">SQLite_Util</text>
</a>
</g> </g>
<!-- \\SQLite_Util&#45;&gt;\\DB_Util --> <!-- \\SQLite_Util&#45;&gt;\\DB_Util -->
<g id="edge21" class="edge"><title>\\SQLite_Util&#45;&gt;\\DB_Util</title> <g id="edge29" class="edge"><title>\\SQLite_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M538.245,-942.319C484.784,-952.039 396.477,-968.095 340.06,-978.353"/> <path fill="none" stroke="black" d="M540.225,-941.171C487.246,-950.968 392.288,-968.529 334.918,-979.139"/>
<polygon fill="none" stroke="black" points="339.125,-974.965 329.912,-980.198 340.377,-981.852 339.125,-974.965"/> <polygon fill="none" stroke="black" points="334.205,-975.711 325.008,-980.971 335.478,-982.594 334.205,-975.711"/>
</g> </g>
<!-- \\SQLite --> <!-- \\SQLite -->
<g id="node20" class="node"><title>\\SQLite</title> <g id="node18" class="node"><title>\\SQLite</title>
<a xlink:href="drivers.sqlite.sqlite_driver.html" xlink:title="SQLite" target="_parent"> <polygon fill="none" stroke="black" points="606,-412 552,-412 552,-376 606,-376 606,-412"/>
<polygon fill="none" stroke="black" points="612,-412 556,-412 556,-376 612,-376 612,-412"/> <text text-anchor="middle" x="579" y="-390.6" font-family="Times Roman,serif" font-size="11.00">SQLite</text>
<text text-anchor="middle" x="584" y="-390.6" font-family="Courier,monospace" font-size="11.00">SQLite</text>
</a>
</g> </g>
<!-- \\SQLite&#45;&gt;\\DB_PDO --> <!-- \\SQLite&#45;&gt;\\DB_PDO -->
<g id="edge23" class="edge"><title>\\SQLite&#45;&gt;\\DB_PDO</title> <g id="edge31" class="edge"><title>\\SQLite&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M555.42,-400.405C524.567,-407.21 473.936,-418.061 430,-426 400.191,-431.386 366.734,-436.58 339.68,-440.567"/> <path fill="none" stroke="black" d="M551.907,-400.321C522.121,-407.153 472.804,-418.118 430,-426 398.567,-431.788 363.052,-437.258 335.279,-441.295"/>
<polygon fill="none" stroke="black" points="339.035,-437.124 329.646,-442.034 340.047,-444.05 339.035,-437.124"/> <polygon fill="none" stroke="black" points="334.437,-437.88 325.039,-442.77 335.435,-444.809 334.437,-437.88"/>
</g> </g>
<!-- \\SQLite_SQL --> <!-- \\SQLite_SQL -->
<g id="node21" class="node"><title>\\SQLite_SQL</title> <g id="node19" class="node"><title>\\SQLite_SQL</title>
<a xlink:href="drivers.sqlite.sqlite_sql.html" xlink:title="SQLite_SQL" target="_parent"> <polygon fill="none" stroke="black" points="619,-682 539,-682 539,-646 619,-646 619,-682"/>
<polygon fill="none" stroke="black" points="626,-682 542,-682 542,-646 626,-646 626,-682"/> <text text-anchor="middle" x="579" y="-660.6" font-family="Times Roman,serif" font-size="11.00">SQLite_SQL</text>
<text text-anchor="middle" x="584" y="-660.6" font-family="Courier,monospace" font-size="11.00">SQLite_SQL</text>
</a>
</g> </g>
<!-- \\SQLite_SQL&#45;&gt;\\iDB_SQL --> <!-- \\SQLite_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge39" class="edge"><title>\\SQLite_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge33" class="edge"><title>\\SQLite_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M541.763,-671.68C485.225,-681.959 385.535,-700.085 329.079,-710.349"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M538.705,-671.452C483.474,-681.666 384.742,-699.925 328.755,-710.278"/>
<polygon fill="none" stroke="black" points="328.273,-706.938 319.06,-712.171 329.525,-713.825 328.273,-706.938"/> <polygon fill="none" stroke="black" points="328.015,-706.856 318.819,-712.116 329.288,-713.739 328.015,-706.856"/>
</g> </g>
<!-- \\Firebird_SQL --> <!-- \\Firebird_SQL -->
<g id="node22" class="node"><title>\\Firebird_SQL</title> <g id="node20" class="node"><title>\\Firebird_SQL</title>
<a xlink:href="drivers.firebird.firebird_sql.html" xlink:title="Firebird_SQL" target="_parent"> <polygon fill="none" stroke="black" points="621,-628 537,-628 537,-592 621,-592 621,-628"/>
<polygon fill="none" stroke="black" points="632,-628 536,-628 536,-592 632,-592 632,-628"/> <text text-anchor="middle" x="579" y="-606.6" font-family="Times Roman,serif" font-size="11.00">Firebird_SQL</text>
<text text-anchor="middle" x="584" y="-606.6" font-family="Courier,monospace" font-size="11.00">Firebird_SQL</text>
</a>
</g> </g>
<!-- \\Firebird_SQL&#45;&gt;\\iDB_SQL --> <!-- \\Firebird_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge41" class="edge"><title>\\Firebird_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge35" class="edge"><title>\\Firebird_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M535.322,-625.653C524.333,-629.291 512.742,-633.21 502,-637 441.327,-658.407 371.756,-684.995 328.588,-701.736"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M536.173,-624.821C525.029,-628.731 513.05,-632.982 502,-637 441.314,-659.068 371.402,-685.618 328.201,-702.156"/>
<polygon fill="none" stroke="black" points="327.316,-698.476 319.262,-705.359 329.85,-705.001 327.316,-698.476"/> <polygon fill="none" stroke="black" points="326.694,-698.985 318.609,-705.831 329.199,-705.521 326.694,-698.985"/>
</g> </g>
<!-- \\Firebird_Result --> <!-- \\Firebird_Result -->
<g id="node23" class="node"><title>\\Firebird_Result</title> <g id="node21" class="node"><title>\\Firebird_Result</title>
<a xlink:href="drivers.firebird.firebird_result.html" xlink:title="Firebird_Result" target="_parent"> <polygon fill="none" stroke="black" points="627,-196 531,-196 531,-160 627,-160 627,-196"/>
<polygon fill="none" stroke="black" points="642,-196 526,-196 526,-160 642,-160 642,-196"/> <text text-anchor="middle" x="579" y="-174.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Result</text>
<text text-anchor="middle" x="584" y="-174.6" font-family="Courier,monospace" font-size="11.00">Firebird_Result</text>
</a>
</g> </g>
<!-- \\PDOStatement --> <!-- \\PDOStatement -->
<g id="node41" class="node"><title>\\PDOStatement</title> <g id="node47" class="node"><title>\\PDOStatement</title>
<ellipse fill="none" stroke="black" cx="287" cy="-18" rx="85.1942" ry="18"/> <ellipse fill="none" stroke="black" cx="287" cy="-18" rx="85.1942" ry="18"/>
<text text-anchor="middle" x="287" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text> <text text-anchor="middle" x="287" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text>
</g> </g>
<!-- \\Firebird_Result&#45;&gt;\\PDOStatement --> <!-- \\Firebird_Result&#45;&gt;\\PDOStatement -->
<g id="edge25" class="edge"><title>\\Firebird_Result&#45;&gt;\\PDOStatement</title> <g id="edge37" class="edge"><title>\\Firebird_Result&#45;&gt;\\PDOStatement</title>
<path fill="none" stroke="black" d="M568.617,-159.537C543.074,-130.208 488.863,-73.3967 430,-45 413.026,-36.8113 393.802,-31.1023 375.082,-27.1231"/> <path fill="none" stroke="black" d="M564.649,-159.998C540.297,-130.794 487.857,-73.4973 430,-45 413.189,-36.72 394.116,-30.9715 375.503,-26.9826"/>
<polygon fill="none" stroke="black" points="375.542,-23.6464 365.053,-25.141 374.184,-30.5136 375.542,-23.6464"/> <polygon fill="none" stroke="black" points="376.018,-23.5165 365.527,-24.9979 374.652,-30.382 376.018,-23.5165"/>
</g> </g>
<!-- \\Firebird --> <!-- \\Firebird -->
<g id="node24" class="node"><title>\\Firebird</title> <g id="node22" class="node"><title>\\Firebird</title>
<a xlink:href="drivers.firebird.firebird_driver.html" xlink:title="Firebird" target="_parent"> <polygon fill="none" stroke="black" points="608,-358 550,-358 550,-322 608,-322 608,-358"/>
<polygon fill="none" stroke="black" points="619,-358 549,-358 549,-322 619,-322 619,-358"/> <text text-anchor="middle" x="579" y="-336.6" font-family="Times Roman,serif" font-size="11.00">Firebird</text>
<text text-anchor="middle" x="584" y="-336.6" font-family="Courier,monospace" font-size="11.00">Firebird</text>
</a>
</g> </g>
<!-- \\Firebird&#45;&gt;\\DB_PDO --> <!-- \\Firebird&#45;&gt;\\DB_PDO -->
<g id="edge27" class="edge"><title>\\Firebird&#45;&gt;\\DB_PDO</title> <g id="edge39" class="edge"><title>\\Firebird&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M548.914,-348.465C533.935,-352.851 516.582,-358.991 502,-367 465.738,-386.918 467.783,-409.147 430,-426 401.827,-438.566 367.775,-444.139 339.968,-446.536"/> <path fill="none" stroke="black" d="M549.812,-347.602C534.963,-352.113 516.944,-358.604 502,-367 465.931,-387.264 467.783,-409.147 430,-426 400.273,-439.26 364,-444.733 335.425,-446.904"/>
<polygon fill="none" stroke="black" points="339.354,-443.072 329.642,-447.307 339.875,-450.053 339.354,-443.072"/> <polygon fill="none" stroke="black" points="335.024,-443.423 325.272,-447.563 335.478,-450.408 335.024,-443.423"/>
</g> </g>
<!-- \\Firebird_Util --> <!-- \\Firebird_Util -->
<g id="node25" class="node"><title>\\Firebird_Util</title> <g id="node23" class="node"><title>\\Firebird_Util</title>
<a xlink:href="drivers.firebird.firebird_util.html" xlink:title="Firebird_Util" target="_parent"> <polygon fill="none" stroke="black" points="620,-898 538,-898 538,-862 620,-862 620,-898"/>
<polygon fill="none" stroke="black" points="636,-898 532,-898 532,-862 636,-862 636,-898"/> <text text-anchor="middle" x="579" y="-876.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Util</text>
<text text-anchor="middle" x="584" y="-876.6" font-family="Courier,monospace" font-size="11.00">Firebird_Util</text>
</a>
</g> </g>
<!-- \\Firebird_Util&#45;&gt;\\DB_Util --> <!-- \\Firebird_Util&#45;&gt;\\DB_Util -->
<g id="edge29" class="edge"><title>\\Firebird_Util&#45;&gt;\\DB_Util</title> <g id="edge41" class="edge"><title>\\Firebird_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M531.833,-896.81C521.902,-900.114 511.611,-903.609 502,-907 446.048,-926.742 382.529,-950.889 339.128,-967.657"/> <path fill="none" stroke="black" d="M537.778,-894.258C526.185,-898.321 513.582,-902.788 502,-907 444.323,-927.974 378.311,-952.996 334.819,-969.624"/>
<polygon fill="none" stroke="black" points="337.7,-964.456 329.637,-971.329 340.227,-970.984 337.7,-964.456"/> <polygon fill="none" stroke="black" points="333.439,-966.404 325.351,-973.247 335.941,-972.942 333.439,-966.404"/>
</g> </g>
</g> </g>
</svg> </svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 17 KiB

170
docs/classes/BadConnectionException.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,171 +52,40 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"></ul>
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: "><span class="description">__construct()
</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__toString" title="__toString :: "><span class="description">__toString()
</span><pre>__toString()</pre></a></li>
<li class="method public "><a href="#getCode" title="getCode :: "><span class="description">getCode()
</span><pre>getCode()</pre></a></li>
<li class="method public "><a href="#getFile" title="getFile :: "><span class="description">getFile()
</span><pre>getFile()</pre></a></li>
<li class="method public "><a href="#getLine" title="getLine :: "><span class="description">getLine()
</span><pre>getLine()</pre></a></li>
<li class="method public "><a href="#getMessage" title="getMessage :: "><span class="description">getMessage()
</span><pre>getMessage()</pre></a></li>
<li class="method public "><a href="#getPrevious" title="getPrevious :: "><span class="description">getPrevious()
</span><pre>getPrevious()</pre></a></li>
<li class="method public "><a href="#getTrace" title="getTrace :: "><span class="description">getTrace()
</span><pre>getTrace()</pre></a></li>
<li class="method public "><a href="#getTraceAsString" title="getTraceAsString :: "><span class="description">getTraceAsString()
</span><pre>getTraceAsString()</pre></a></li>
</ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CBadConnectionException" id="\BadConnectionException"></a><div href="../classes/BadConnectionException.html" class="element class"> <a id="\BadConnectionException"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/BadConnectionException.html">BadConnectionException</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Generic exception for bad connection strings</p> <p class="short_description">Generic exception for bad connection strings</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td> <td><a href="../packages/Query.Query.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
<td>Query</td> <td>Query</td>
</tr> </tr>
</table> </table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>__construct()
</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::__construct()</td>
</tr></table>
</div></div>
</div>
<a name="__toString" id="__toString"></a><div class="element clickable method public __toString" data-toggle="collapse" data-target=".__toString .collapse">
<h2>__toString()
</h2>
<pre>__toString() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::__toString()</td>
</tr></table>
</div></div>
</div>
<a name="getCode" id="getCode"></a><div class="element clickable method public getCode" data-toggle="collapse" data-target=".getCode .collapse">
<h2>getCode()
</h2>
<pre>getCode() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getCode()</td>
</tr></table>
</div></div>
</div>
<a name="getFile" id="getFile"></a><div class="element clickable method public getFile" data-toggle="collapse" data-target=".getFile .collapse">
<h2>getFile()
</h2>
<pre>getFile() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getFile()</td>
</tr></table>
</div></div>
</div>
<a name="getLine" id="getLine"></a><div class="element clickable method public getLine" data-toggle="collapse" data-target=".getLine .collapse">
<h2>getLine()
</h2>
<pre>getLine() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getLine()</td>
</tr></table>
</div></div>
</div>
<a name="getMessage" id="getMessage"></a><div class="element clickable method public getMessage" data-toggle="collapse" data-target=".getMessage .collapse">
<h2>getMessage()
</h2>
<pre>getMessage() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getMessage()</td>
</tr></table>
</div></div>
</div>
<a name="getPrevious" id="getPrevious"></a><div class="element clickable method public getPrevious" data-toggle="collapse" data-target=".getPrevious .collapse">
<h2>getPrevious()
</h2>
<pre>getPrevious() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getPrevious()</td>
</tr></table>
</div></div>
</div>
<a name="getTrace" id="getTrace"></a><div class="element clickable method public getTrace" data-toggle="collapse" data-target=".getTrace .collapse">
<h2>getTrace()
</h2>
<pre>getTrace() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getTrace()</td>
</tr></table>
</div></div>
</div>
<a name="getTraceAsString" id="getTraceAsString"></a><div class="element clickable method public getTraceAsString" data-toggle="collapse" data-target=".getTraceAsString .collapse">
<h2>getTraceAsString()
</h2>
<pre>getTraceAsString() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getTraceAsString()</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

170
docs/classes/BadDBDriverException.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,171 +52,40 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"></ul>
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: "><span class="description">__construct()
</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__toString" title="__toString :: "><span class="description">__toString()
</span><pre>__toString()</pre></a></li>
<li class="method public "><a href="#getCode" title="getCode :: "><span class="description">getCode()
</span><pre>getCode()</pre></a></li>
<li class="method public "><a href="#getFile" title="getFile :: "><span class="description">getFile()
</span><pre>getFile()</pre></a></li>
<li class="method public "><a href="#getLine" title="getLine :: "><span class="description">getLine()
</span><pre>getLine()</pre></a></li>
<li class="method public "><a href="#getMessage" title="getMessage :: "><span class="description">getMessage()
</span><pre>getMessage()</pre></a></li>
<li class="method public "><a href="#getPrevious" title="getPrevious :: "><span class="description">getPrevious()
</span><pre>getPrevious()</pre></a></li>
<li class="method public "><a href="#getTrace" title="getTrace :: "><span class="description">getTrace()
</span><pre>getTrace()</pre></a></li>
<li class="method public "><a href="#getTraceAsString" title="getTraceAsString :: "><span class="description">getTraceAsString()
</span><pre>getTraceAsString()</pre></a></li>
</ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CBadDBDriverException" id="\BadDBDriverException"></a><div href="../classes/BadDBDriverException.html" class="element class"> <a id="\BadDBDriverException"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/BadDBDriverException.html">BadDBDriverException</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Generic exception for bad drivers</p> <p class="short_description">Generic exception for bad drivers</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td> <td><a href="../packages/Query.Query.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
<td>Query</td> <td>Query</td>
</tr> </tr>
</table> </table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>__construct()
</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::__construct()</td>
</tr></table>
</div></div>
</div>
<a name="__toString" id="__toString"></a><div class="element clickable method public __toString" data-toggle="collapse" data-target=".__toString .collapse">
<h2>__toString()
</h2>
<pre>__toString() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::__toString()</td>
</tr></table>
</div></div>
</div>
<a name="getCode" id="getCode"></a><div class="element clickable method public getCode" data-toggle="collapse" data-target=".getCode .collapse">
<h2>getCode()
</h2>
<pre>getCode() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getCode()</td>
</tr></table>
</div></div>
</div>
<a name="getFile" id="getFile"></a><div class="element clickable method public getFile" data-toggle="collapse" data-target=".getFile .collapse">
<h2>getFile()
</h2>
<pre>getFile() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getFile()</td>
</tr></table>
</div></div>
</div>
<a name="getLine" id="getLine"></a><div class="element clickable method public getLine" data-toggle="collapse" data-target=".getLine .collapse">
<h2>getLine()
</h2>
<pre>getLine() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getLine()</td>
</tr></table>
</div></div>
</div>
<a name="getMessage" id="getMessage"></a><div class="element clickable method public getMessage" data-toggle="collapse" data-target=".getMessage .collapse">
<h2>getMessage()
</h2>
<pre>getMessage() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getMessage()</td>
</tr></table>
</div></div>
</div>
<a name="getPrevious" id="getPrevious"></a><div class="element clickable method public getPrevious" data-toggle="collapse" data-target=".getPrevious .collapse">
<h2>getPrevious()
</h2>
<pre>getPrevious() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getPrevious()</td>
</tr></table>
</div></div>
</div>
<a name="getTrace" id="getTrace"></a><div class="element clickable method public getTrace" data-toggle="collapse" data-target=".getTrace .collapse">
<h2>getTrace()
</h2>
<pre>getTrace() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getTrace()</td>
</tr></table>
</div></div>
</div>
<a name="getTraceAsString" id="getTraceAsString"></a><div class="element clickable method public getTraceAsString" data-toggle="collapse" data-target=".getTraceAsString .collapse">
<h2>getTraceAsString()
</h2>
<pre>getTraceAsString() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>Exception::getTraceAsString()</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

546
docs/classes/DB_PDO.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,90 +54,78 @@
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li> <i class="icon-custom icon-method"></i> Methods
<li class="method public "><a href="#__construct" title="__construct :: PDO constructor wrapper"><span class="description">PDO constructor wrapper</span><pre>__construct()</pre></a></li> <ul>
<li class="method public "><a href="#__sleep" title="__sleep :: "><span class="description">__sleep() <li class="method public "><a href="#method___construct" title="__construct() :: PDO constructor wrapper"><span class="description">PDO constructor wrapper</span><pre>__construct()</pre></a></li>
</span><pre>__sleep()</pre></a></li> <li class="method public "><a href="#method_affected_rows" title="affected_rows() :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public "><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup() <li class="method public "><a href="#method_driver_query" title="driver_query() :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
</span><pre>__wakeup()</pre></a></li> <li class="method public "><a href="#method_empty_table" title="empty_table() :: Deletes all the rows from a table. Does the same as the truncate
<li class="method public "><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public "><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
</span><pre>beginTransaction()</pre></a></li>
<li class="method public "><a href="#commit" title="commit :: "><span class="description">commit()
</span><pre>commit()</pre></a></li>
<li class="method public "><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public "><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li> method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
<li class="method public "><a href="#errorCode" title="errorCode :: "><span class="description">errorCode() <li class="method public "><a href="#method_get_columns" title="get_columns() :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
</span><pre>errorCode()</pre></a></li> <li class="method public "><a href="#method_get_dbs" title="get_dbs() :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public "><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo() <li class="method public "><a href="#method_get_functions" title="get_functions() :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
</span><pre>errorInfo()</pre></a></li> <li class="method public "><a href="#method_get_last_error" title="get_last_error() :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public "><a href="#exec" title="exec :: "><span class="description">exec() <li class="method public "><a href="#method_get_procedures" title="get_procedures() :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
</span><pre>exec()</pre></a></li> <li class="method public "><a href="#method_get_query_data" title="get_query_data() :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public "><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute() <li class="method public "><a href="#method_get_schemas" title="get_schemas() :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
</span><pre>getAttribute()</pre></a></li> <li class="method public "><a href="#method_get_sequences" title="get_sequences() :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public "><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers() <li class="method public "><a href="#method_get_system_tables" title="get_system_tables() :: Retreives an array of non-user-created tables for
</span><pre>getAvailableDrivers()</pre></a></li>
<li class="method public "><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public "><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public "><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public "><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public "><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public "><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public "><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
<li class="method public "><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public "><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li> the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li> <li class="method public "><a href="#method_get_tables" title="get_tables() :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public "><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li> <li class="method public "><a href="#method_get_triggers" title="get_triggers() :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public "><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li> <li class="method public "><a href="#method_get_types" title="get_types() :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public "><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li> <li class="method public "><a href="#method_get_views" title="get_views() :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public "><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction() <li class="method public "><a href="#method_insert_batch" title="insert_batch() :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
</span><pre>inTransaction()</pre></a></li> <li class="method public "><a href="#method_num_rows" title="num_rows() :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public "><a href="#insert_batch" title="insert_batch :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li> <li class="method public "><a href="#method_prepare_execute" title="prepare_execute() :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
<li class="method public "><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId() <li class="method public "><a href="#method_prepare_query" title="prepare_query() :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
</span><pre>lastInsertId()</pre></a></li> <li class="method public "><a href="#method_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="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li> <li class="method public "><a href="#method_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="#prepare" title="prepare :: "><span class="description">prepare() <li class="method public "><a href="#method_truncate" title="truncate() :: Empty the passed table"><span class="description">Empty the passed table</span><pre>truncate()</pre></a></li>
</span><pre>prepare()</pre></a></li> </ul>
<li class="method public "><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li> </li>
<li class="method public "><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li> <li class="nav-header protected">» Protected
<li class="method public "><a href="#query" title="query :: "><span class="description">query() <ul>
</span><pre>query()</pre></a></li> <li class="method protected "><a href="#method__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 public "><a href="#quote" title="quote :: "><span class="description">quote() <li class="method protected "><a href="#method__quote" title="_quote() :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
</span><pre>quote()</pre></a></li> </ul>
<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>
<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()
</span><pre>setAttribute()</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"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li> <i class="icon-custom icon-property"></i> Properties
<li class="property public "><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li> <ul>
<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="#property_last_query" title="$last_query() :: "><span class="description"></span><pre>$last_query</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="#property_sql" title="$sql() :: "><span class="description"></span><pre>$sql</pre></a></li>
<li class="property public "><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li> <li class="property public "><a href="#property_table_prefix" title="$table_prefix() :: "><span class="description"></span><pre>$table_prefix</pre></a></li>
<li class="nav-header protected">» Protected</li> <li class="property public "><a href="#property_util" title="$util() :: "><span class="description"></span><pre>$util</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> </ul>
<li class="property protected "><a href="#%24statement" title="$statement :: "><span class="description">$statement</span><pre>$statement</pre></a></li> </li>
<li class="nav-header protected">» Protected
<ul>
<li class="property protected "><a href="#property_escape_char" title="$escape_char() :: "><span class="description"></span><pre>$escape_char</pre></a></li>
<li class="property protected "><a href="#property_statement" title="$statement() :: "><span class="description"></span><pre>$statement</pre></a></li>
</ul>
</li>
</ul> </ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CDB_PDO" id="\DB_PDO"></a><div href="../classes/DB_PDO.html" class="element class"> <a id="\DB_PDO"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/DB_PDO.html">DB_PDO</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Base Database class</p> <p class="short_description">Base Database class</p>
<div class="details"> <div class="details">
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p> <div class="long_description">Extends PDO to simplify cross-database issues</div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td> <td><a href="../packages/Query.Query.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -149,12 +134,12 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>PDO constructor wrapper</h2> <h2>PDO constructor wrapper</h2>
<pre>__construct(string $dsn, string $username, string $password, array $driver_options) </pre> <pre>__construct(string $dsn, string $username, string $password, array $driver_options) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$dsn</h4> <h4>$dsn</h4>
@ -174,79 +159,27 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse"> <a id="method_affected_rows"></a><div class="element clickable method public method_affected_rows" data-toggle="collapse" data-target=".method_affected_rows .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::__sleep()</td>
</tr></table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::__wakeup()</td>
</tr></table>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2> <h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre> <pre>affected_rows(\PDOStatement $statement) : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$statement</h4> <h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code> <code><a href="PDOStatement.html">\PDOStatement</a></code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse"> <a id="method_driver_query"></a><div class="element clickable method public method_driver_query" data-toggle="collapse" data-target=".method_driver_query .collapse">
<h2>beginTransaction()
</h2>
<pre>beginTransaction() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::beginTransaction()</td>
</tr></table>
</div></div>
</div>
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
<h2>commit()
</h2>
<pre>commit() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::commit()</td>
</tr></table>
</div></div>
</div>
<a name="driver_query" id="driver_query"></a><div class="element clickable method public driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
<h2>Method to simplify retreiving db results for meta-data queries</h2> <h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre> <pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -260,13 +193,13 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse"> <a id="method_empty_table"></a><div class="element clickable method public method_empty_table" data-toggle="collapse" data-target=".method_empty_table .collapse">
<h2>Deletes all the rows from a table. Does the same as the truncate <h2>Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</h2> method if the database does not support 'TRUNCATE';</h2>
<pre>empty_table(string $table) : mixed</pre> <pre>empty_table(string $table) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -276,77 +209,12 @@ method if the database does not support 'TRUNCATE';</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse"> <a id="method_get_columns"></a><div class="element clickable method public method_get_columns" data-toggle="collapse" data-target=".method_get_columns .collapse">
<h2>errorCode()
</h2>
<pre>errorCode() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::errorCode()</td>
</tr></table>
</div></div>
</div>
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
<h2>errorInfo()
</h2>
<pre>errorInfo() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::errorInfo()</td>
</tr></table>
</div></div>
</div>
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
<h2>exec()
</h2>
<pre>exec() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::exec()</td>
</tr></table>
</div></div>
</div>
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
<h2>getAttribute()
</h2>
<pre>getAttribute() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::getAttribute()</td>
</tr></table>
</div></div>
</div>
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
<h2>getAvailableDrivers()
</h2>
<pre>getAvailableDrivers() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::getAvailableDrivers()</td>
</tr></table>
</div></div>
</div>
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
<h2>Retrieve column information for the current database table</h2> <h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</pre> <pre>get_columns(string $table) : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -356,151 +224,138 @@ method if the database does not support 'TRUNCATE';</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse"> <a id="method_get_dbs"></a><div class="element clickable method public method_get_dbs" data-toggle="collapse" data-target=".method_get_dbs .collapse">
<h2>Return list of dbs for the current connection, if possible</h2> <h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</pre> <pre>get_dbs() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse"> <a id="method_get_functions"></a><div class="element clickable method public method_get_functions" data-toggle="collapse" data-target=".method_get_functions .collapse">
<h2>Return list of function for the current database</h2> <h2>Return list of function for the current database</h2>
<pre>get_functions() : array</pre> <pre>get_functions() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse"> <a id="method_get_last_error"></a><div class="element clickable method public method_get_last_error" data-toggle="collapse" data-target=".method_get_last_error .collapse">
<h2>Return the last error for the current database connection</h2> <h2>Return the last error for the current database connection</h2>
<pre>get_last_error() : string</pre> <pre>get_last_error() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse"> <a id="method_get_procedures"></a><div class="element clickable method public method_get_procedures" data-toggle="collapse" data-target=".method_get_procedures .collapse">
<h2>Return list of stored procedures for the current database</h2> <h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</pre> <pre>get_procedures() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse"> <a id="method_get_query_data"></a><div class="element clickable method public method_get_query_data" data-toggle="collapse" data-target=".method_get_query_data .collapse">
<h2>Retreives the data from a select query</h2> <h2>Retreives the data from a select query</h2>
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre> <pre>get_query_data(\PDOStatement $statement) : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$statement</h4> <h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code> <code><a href="PDOStatement.html">\PDOStatement</a></code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse"> <a id="method_get_schemas"></a><div class="element clickable method public method_get_schemas" data-toggle="collapse" data-target=".method_get_schemas .collapse">
<h2>Return schemas for databases that list them</h2> <h2>Return schemas for databases that list them</h2>
<pre>get_schemas() : array</pre> <pre>get_schemas() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse"> <a id="method_get_sequences"></a><div class="element clickable method public method_get_sequences" data-toggle="collapse" data-target=".method_get_sequences .collapse">
<h2>Return list of sequences for the current database, if they exist</h2> <h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</pre> <pre>get_sequences() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse"> <a id="method_get_system_tables"></a><div class="element clickable method public method_get_system_tables" data-toggle="collapse" data-target=".method_get_system_tables .collapse">
<h2>Retreives an array of non-user-created tables for <h2>Retreives an array of non-user-created tables for
the connection/database</h2> the connection/database</h2>
<pre>get_system_tables() : array</pre> <pre>get_system_tables() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse"> <a id="method_get_tables"></a><div class="element clickable method public method_get_tables" data-toggle="collapse" data-target=".method_get_tables .collapse">
<h2>Return list of tables for the current database</h2> <h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</pre> <pre>get_tables() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse"> <a id="method_get_triggers"></a><div class="element clickable method public method_get_triggers" data-toggle="collapse" data-target=".method_get_triggers .collapse">
<h2>Return list of triggers for the current database</h2> <h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</pre> <pre>get_triggers() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse"> <a id="method_get_types"></a><div class="element clickable method public method_get_types" data-toggle="collapse" data-target=".method_get_types .collapse">
<h2>Retrieve list of data types for the database</h2> <h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</pre> <pre>get_types() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse"> <a id="method_get_views"></a><div class="element clickable method public method_get_views" data-toggle="collapse" data-target=".method_get_views .collapse">
<h2>Return list of views for the current database</h2> <h2>Return list of views for the current database</h2>
<pre>get_views() : array</pre> <pre>get_views() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse"> <a id="method_insert_batch"></a><div class="element clickable method public method_insert_batch" data-toggle="collapse" data-target=".method_insert_batch .collapse">
<h2>inTransaction()
</h2>
<pre>inTransaction() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::inTransaction()</td>
</tr></table>
</div></div>
</div>
<a name="insert_batch" id="insert_batch"></a><div class="element clickable method public insert_batch" data-toggle="collapse" data-target=".insert_batch .collapse">
<h2>Create sql for batch insert</h2> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -514,52 +369,26 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse"> <a id="method_num_rows"></a><div class="element clickable method public method_num_rows" data-toggle="collapse" data-target=".method_num_rows .collapse">
<h2>lastInsertId()
</h2>
<pre>lastInsertId() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::lastInsertId()</td>
</tr></table>
</div></div>
</div>
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
<h2>Return the number of rows returned for a SELECT query</h2> <h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</pre> <pre>num_rows() : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>see</th> <th>see</th>
<td>\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</td> <td><a href="%5Chttp://us3.php.net/manual/en/pdostatement.rowcount.php#87110"></a></td>
</tr></table> </tr></table>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse"> <a id="method_prepare_execute"></a><div class="element clickable method public method_prepare_execute" data-toggle="collapse" data-target=".method_prepare_execute .collapse">
<h2>prepare()
</h2>
<pre>prepare() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::prepare()</td>
</tr></table>
</div></div>
</div>
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
<h2>Create and execute a prepared statement with the provided parameters</h2> <h2>Create and execute a prepared statement with the provided parameters</h2>
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre> <pre>prepare_execute(string $sql, array $params) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -570,15 +399,15 @@ the connection/database</h2>
<code>array</code> <code>array</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div> <div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div> </div></div>
</div> </div>
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse"> <a id="method_prepare_query"></a><div class="element clickable method public method_prepare_query" data-toggle="collapse" data-target=".method_prepare_query .collapse">
<h2>Simplifies prepared statements for database queries</h2> <h2>Simplifies prepared statements for database queries</h2>
<pre>prepare_query(string $sql, array $data) : mixed</pre> <pre>prepare_query(string $sql, array $data) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -593,38 +422,12 @@ the connection/database</h2>
<code>mixed</code>PDOStatement / FALSE</div> <code>mixed</code>PDOStatement / FALSE</div>
</div></div> </div></div>
</div> </div>
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse"> <a id="method_quote_ident"></a><div class="element clickable method public method_quote_ident" data-toggle="collapse" data-target=".method_quote_ident .collapse">
<h2>query()
</h2>
<pre>query() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::query()</td>
</tr></table>
</div></div>
</div>
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
<h2>quote()
</h2>
<pre>quote() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::quote()</td>
</tr></table>
</div></div>
</div>
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
<h2>Surrounds the string with the databases identifier escape characters</h2> <h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : string</pre> <pre>quote_ident(mixed $ident) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$ident</h4> <h4>$ident</h4>
@ -634,12 +437,12 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_quote_table"></a><div class="element clickable method public method_quote_table" data-toggle="collapse" data-target=".method_quote_table .collapse">
<h2>Quote database table name, and set prefix</h2> <h2>Quote database table name, and set prefix</h2>
<pre>quote_table(string $table) : string</pre> <pre>quote_table(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -649,38 +452,12 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse">
<h2>rollBack()
</h2>
<pre>rollBack() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::rollBack()</td>
</tr></table>
</div></div>
</div>
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
<h2>setAttribute()
</h2>
<pre>setAttribute() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::setAttribute()</td>
</tr></table>
</div></div>
</div>
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
<h2>Empty the passed table</h2> <h2>Empty the passed table</h2>
<pre>truncate(string $table) : void</pre> <pre>truncate(string $table) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -688,12 +465,12 @@ the connection/database</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="_prefix" id="_prefix"></a><div class="element clickable method protected _prefix" data-toggle="collapse" data-target="._prefix .collapse"> <a id="method__prefix"></a><div class="element clickable method protected method__prefix" data-toggle="collapse" data-target=".method__prefix .collapse">
<h2>Sets the table prefix on the passed string</h2> <h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre> <pre>_prefix(string $str) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$str</h4> <h4>$str</h4>
@ -703,12 +480,12 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse"> <a id="method__quote"></a><div class="element clickable method protected method__quote" data-toggle="collapse" data-target=".method__quote .collapse">
<h2>Helper method for quote_ident</h2> <h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre> <pre>_quote(mixed $str) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$str</h4> <h4>$str</h4>
@ -720,41 +497,41 @@ the connection/database</h2>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</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"> <a id="property_last_query"> </a><div class="element clickable property public property_last_query" data-toggle="collapse" data-target=".property_last_query .collapse">
<h2>$last_query</h2> <h2>$last_query</h2>
<pre>$last_query </pre> <pre>$last_query </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse"> <a id="property_sql"> </a><div class="element clickable property public property_sql" data-toggle="collapse" data-target=".property_sql .collapse">
<h2>$sql</h2> <h2>$sql</h2>
<pre>$sql </pre> <pre>$sql </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></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"> <a id="property_table_prefix"> </a><div class="element clickable property public property_table_prefix" data-toggle="collapse" data-target=".property_table_prefix .collapse">
<h2>$table_prefix</h2> <h2>$table_prefix</h2>
<pre>$table_prefix </pre> <pre>$table_prefix </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse"> <a id="property_util"> </a><div class="element clickable property public property_util" data-toggle="collapse" data-target=".property_util .collapse">
<h2>$util</h2> <h2>$util</h2>
<pre>$util </pre> <pre>$util </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></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"> <a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse">
<h2>$escape_char</h2> <h2>$escape_char</h2>
<pre>$escape_char </pre> <pre>$escape_char </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse"> <a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse">
<h2>$statement</h2> <h2>$statement</h2>
<pre>$statement </pre> <pre>$statement </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
</div> </div>
</div> </div>
@ -762,8 +539,9 @@ the connection/database</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

250
docs/classes/DB_SQL.html
View File

@ -1,250 +0,0 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » \DB_SQL</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">23</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>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<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="#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="#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="#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="#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>
<li class="method public "><a href="#type_list" title="type_list :: Return sql to list database field types"><span class="description">Return sql to list database field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CDB_SQL" id="\DB_SQL"></a><div href="../classes/DB_SQL.html" class="element class">
<p class="short_description">Abstract parent for database manipulation subclasses</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<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>
<pre>column_list($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></code><p>string</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
<h2>Returns sql to list other databases</h2>
<pre>db_list() : 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>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
<h2>Get database specific sql for limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$limit</h4>
<code>int</code>
</div>
<div class="subelement argument">
<h4>$offset</h4>
<code>int</code>
</div>
<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>
<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="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
<h2>Get the sql for random ordering</h2>
<pre>random() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
<h2>Return sql to list sequences</h2>
<pre>sequence_list() : 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>
<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="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
<h2>Returns sql to list tables</h2>
<pre>table_list() : 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="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
<h2>Returns sql to list triggers</h2>
<pre>trigger_list() : 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="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
<h2>Return sql to list database field types</h2>
<pre>type_list() : mixed</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>mixed</code></div>
</div></div>
</div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
<h2>Returns sql to list views</h2>
<pre>view_list() : 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>
</div>
</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-11-09T15:10:09-05:00.<br></footer></div>
</div>
</body>
</html>

94
docs/classes/DB_Util.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,28 +54,42 @@
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li> <i class="icon-custom icon-method"></i> Methods
<li class="method public "><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li> <ul>
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the connection object for later use"><span class="description">Save a reference to the connection object for later use</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___call" title="__call() :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#backup_data" title="backup_data :: Return an SQL file with the database data as insert statements"><span class="description">Return an SQL file with the database data as insert statements</span><pre>backup_data()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the connection object for later use"><span class="description">Save a reference to the connection object for later use</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Return an SQL file with the database table structure"><span class="description">Return an SQL file with the database table structure</span><pre>backup_structure()</pre></a></li> <li class="method public "><a href="#method_backup_data" title="backup_data() :: Return an SQL file with the database data as insert statements"><span class="description">Return an SQL file with the database data as insert statements</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Get database-specific sql to create a new table"><span class="description">Get database-specific sql to create a new table</span><pre>create_table()</pre></a></li> <li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Return an SQL file with the database table structure"><span class="description">Return an SQL file with the database table structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: Get database-specific sql to drop a table"><span class="description">Get database-specific sql to drop a table</span><pre>delete_table()</pre></a></li> <li class="method public "><a href="#method_create_table" title="create_table() :: Get database-specific sql to create a new table"><span class="description">Get database-specific sql to create a new table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#method_delete_table" title="delete_table() :: Get database-specific sql to drop a table"><span class="description">Get database-specific sql to drop a table</span><pre>delete_table()</pre></a></li>
</ul>
</li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li> <i class="icon-custom icon-property"></i> Properties
<li class="nav-header private">» Private</li> <ul></ul>
<li class="property private "><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li> </li>
<li class="nav-header private">» Private
<ul><li class="property private "><a href="#property_conn" title="$conn() :: Reference to the current connection object"><span class="description"></span><pre>$conn</pre></a></li></ul>
</li>
</ul> </ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CDB_Util" id="\DB_Util"></a><div href="../classes/DB_Util.html" class="element class"> <a id="\DB_Util"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/DB_Util.html">DB_Util</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Abstract class defining database / table creation methods</p> <p class="short_description">Abstract class defining database / table creation methods</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td> <td><a href="../packages/Query.Query.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -87,12 +98,12 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse"> <a id="method___call"></a><div class="element clickable method public method___call" data-toggle="collapse" data-target=".method___call .collapse">
<h2>Enable calling driver methods</h2> <h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) </pre> <pre>__call(string $method, array $args) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$method</h4> <h4>$method</h4>
@ -104,12 +115,12 @@
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Save a reference to the connection object for later use</h2> <h2>Save a reference to the connection object for later use</h2>
<pre>__construct(object $conn) </pre> <pre>__construct(object $conn) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$conn</h4> <h4>$conn</h4>
@ -117,12 +128,12 @@
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse">
<h2>Return an SQL file with the database data as insert statements</h2> <h2>Return an SQL file with the database data as insert statements</h2>
<pre>backup_data() : string</pre> <pre>backup_data() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>abstract</th> <th>abstract</th>
<td></td> <td></td>
@ -131,12 +142,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse">
<h2>Return an SQL file with the database table structure</h2> <h2>Return an SQL file with the database table structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>abstract</th> <th>abstract</th>
<td></td> <td></td>
@ -145,12 +156,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse"> <a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse">
<h2>Get database-specific sql to create a new table</h2> <h2>Get database-specific sql to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>abstract</th> <th>abstract</th>
<td></td> <td></td>
@ -176,12 +187,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse"> <a id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse">
<h2>Get database-specific sql to drop a table</h2> <h2>Get database-specific sql to drop a table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>abstract</th> <th>abstract</th>
<td></td> <td></td>
@ -197,11 +208,11 @@
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse"> <a id="property_conn"> </a><div class="element clickable property private property_conn" data-toggle="collapse" data-target=".property_conn .collapse">
<h2>Reference to the current connection object</h2> <h2>Reference to the current connection object</h2>
<pre>$conn </pre> <pre>$conn </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
</div> </div>
</div> </div>
@ -209,8 +220,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

793
docs/classes/Firebird.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,87 +54,55 @@
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li> <i class="icon-custom icon-method"></i> Methods
<li class="method public "><a href="#__construct" title="__construct :: Open the link to the database"><span class="description">Open the link to the database</span><pre>__construct()</pre></a></li> <ul>
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep() <li class="method public "><a href="#method___construct" title="__construct() :: Open the link to the database"><span class="description">Open the link to the database</span><pre>__construct()</pre></a></li>
</span><pre>__sleep()</pre></a></li> <li class="method public "><a href="#method_beginTransaction" title="beginTransaction() :: Start a database transaction"><span class="description">Start a database transaction</span><pre>beginTransaction()</pre></a></li>
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup() <li class="method public "><a href="#method_commit" title="commit() :: Commit a database transaction"><span class="description">Commit a database transaction</span><pre>commit()</pre></a></li>
</span><pre>__wakeup()</pre></a></li> <li class="method public "><a href="#method_errorCode" title="errorCode() :: Method to emulate PDO-&gt;errorCode"><span class="description">Method to emulate PDO-&gt;errorCode</span><pre>errorCode()</pre></a></li>
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li> <li class="method public "><a href="#method_errorInfo" title="errorInfo() :: Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo"><span class="description">Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</span><pre>errorInfo()</pre></a></li>
<li class="method public "><a href="#beginTransaction" title="beginTransaction :: Start a database transaction"><span class="description">Start a database transaction</span><pre>beginTransaction()</pre></a></li> <li class="method public "><a href="#method_insert_batch" title="insert_batch() :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
<li class="method public "><a href="#commit" title="commit :: Commit a database transaction"><span class="description">Commit a database transaction</span><pre>commit()</pre></a></li> <li class="method public "><a href="#method_prepare" title="prepare() :: Emulate PDO prepare"><span class="description">Emulate PDO prepare</span><pre>prepare()</pre></a></li>
<li class="method public inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li> <li class="method public "><a href="#method_prepare_execute" title="prepare_execute() :: Prepare and execute a query"><span class="description">Prepare and execute a query</span><pre>prepare_execute()</pre></a></li>
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate <li class="method public "><a href="#method_prepare_query" title="prepare_query() :: Bind a prepared query with arguments for executing"><span class="description">Bind a prepared query with arguments for executing</span><pre>prepare_query()</pre></a></li>
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate <li class="method public "><a href="#method_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>
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li> <li class="method public "><a href="#method_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 "><a href="#errorCode" title="errorCode :: Method to emulate PDO-&gt;errorCode"><span class="description">Method to emulate PDO-&gt;errorCode</span><pre>errorCode()</pre></a></li> <li class="method public "><a href="#method_rollBack" title="rollBack() :: Rollback a transaction"><span class="description">Rollback a transaction</span><pre>rollBack()</pre></a></li>
<li class="method public "><a href="#errorInfo" title="errorInfo :: Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo"><span class="description">Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</span><pre>errorInfo()</pre></a></li> <li class="method public "><a href="#method_truncate" title="truncate() :: Empty a database table"><span class="description">Empty a database table</span><pre>truncate()</pre></a></li>
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec() </ul>
</span><pre>exec()</pre></a></li> </li>
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
</span><pre>getAttribute()</pre></a></li>
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
</span><pre>getAvailableDrivers()</pre></a></li>
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
</span><pre>inTransaction()</pre></a></li>
<li class="method public "><a href="#insert_batch" title="insert_batch :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
</span><pre>lastInsertId()</pre></a></li>
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public "><a href="#prepare" title="prepare :: Emulate PDO prepare"><span class="description">Emulate PDO prepare</span><pre>prepare()</pre></a></li>
<li class="method public "><a href="#prepare_execute" title="prepare_execute :: Prepare and execute a query"><span class="description">Prepare and execute a query</span><pre>prepare_execute()</pre></a></li>
<li class="method public "><a href="#prepare_query" title="prepare_query :: Bind a prepared query with arguments for executing"><span class="description">Bind a prepared query with arguments for executing</span><pre>prepare_query()</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="#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"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li> <i class="icon-custom icon-property"></i> Properties
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li> <ul></ul>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li> </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="nav-header protected">» Protected
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li> <ul>
<li class="nav-header protected">» Protected</li> <li class="property protected "><a href="#property_conn" title="$conn() :: Reference to the connection resource"><span class="description"></span><pre>$conn</pre></a></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 "><a href="#property_statement" title="$statement() :: Reference to the last query executed"><span class="description"></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 "><a href="#property_statement_link" title="$statement_link() :: Reference to the resource returned by
<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> the last query executed"><span class="description"></span><pre>$statement_link</pre></a></li>
<li class="property protected "><a href="#%24statement_link" title="$statement_link :: Reference to the resource returned by <li class="property protected "><a href="#property_trans" title="$trans() :: Reference to the current transaction"><span class="description"></span><pre>$trans</pre></a></li>
the last query executed"><span class="description">Reference to the resource returned by </ul>
the last query executed</span><pre>$statement_link</pre></a></li> </li>
<li class="property protected "><a href="#%24trans" title="$trans :: Reference to the current transaction"><span class="description">Reference to the current transaction</span><pre>$trans</pre></a></li>
</ul> </ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CFirebird" id="\Firebird"></a><div href="../classes/Firebird.html" class="element class"> <a id="\Firebird"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Firebird.html">Firebird</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Firebird Database class</p> <p class="short_description">Firebird Database class</p>
<div class="details"> <div class="details">
<p class="long_description"><p>PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</p></p> <div class="long_description">PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -146,12 +111,12 @@ the last query executed</span><pre>$statement_link</pre></a></li>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Open the link to the database</h2> <h2>Open the link to the database</h2>
<pre>__construct(string $dbpath, string $user, string $pass) </pre> <pre>__construct(string $dbpath, string $user, string $pass) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$dbpath</h4> <h4>$dbpath</h4>
@ -167,421 +132,52 @@ the last query executed</span><pre>$statement_link</pre></a></li>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse"> <a id="method_beginTransaction"></a><div class="element clickable method public method_beginTransaction" data-toggle="collapse" data-target=".method_beginTransaction .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </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>PDO::__sleep()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__sleep()</td>
</tr>
</table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </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>PDO::__wakeup()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__wakeup()</td>
</tr>
</table>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</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::affected_rows()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
<h2>Start a database transaction</h2> <h2>Start a database transaction</h2>
<pre>beginTransaction() : bool</pre> <pre>beginTransaction() : bool</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </div></div>
</div> </div>
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse"> <a id="method_commit"></a><div class="element clickable method public method_commit" data-toggle="collapse" data-target=".method_commit .collapse">
<h2>Commit a database transaction</h2> <h2>Commit a database transaction</h2>
<pre>commit() : bool</pre> <pre>commit() : bool</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </div></div>
</div> </div>
<a name="driver_query" id="driver_query"></a><div class="element clickable method public driver_query" data-toggle="collapse" data-target=".driver_query .collapse"> <a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse">
<h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</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::driver_query()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$filtered_index</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
<h2>Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</h2>
<pre>empty_table(string $table) : mixed</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::empty_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
<h2>Method to emulate PDO-&gt;errorCode</h2> <h2>Method to emulate PDO-&gt;errorCode</h2>
<pre>errorCode() : array</pre> <pre>errorCode() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse"> <a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse">
<h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2> <h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2>
<pre>errorInfo() : array</pre> <pre>errorInfo() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse"> <a id="method_insert_batch"></a><div class="element clickable method public method_insert_batch" data-toggle="collapse" data-target=".method_insert_batch .collapse">
<h2>exec()
</h2>
<pre>exec() </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>PDO::exec()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::exec()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
<h2>getAttribute()
</h2>
<pre>getAttribute() </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>PDO::getAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
<h2>getAvailableDrivers()
</h2>
<pre>getAvailableDrivers() </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>PDO::getAvailableDrivers()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAvailableDrivers()</td>
</tr>
</table>
</div></div>
</div>
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
<h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</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::get_columns()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
<h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</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::get_dbs()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
<h2>Return list of function for the current database</h2>
<pre>get_functions() : array</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::get_functions()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
<h2>Return the last error for the current database connection</h2>
<pre>get_last_error() : 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::get_last_error()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
<h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</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::get_procedures()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
<h2>Retreives the data from a select query</h2>
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</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::get_query_data()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
<h2>Return schemas for databases that list them</h2>
<pre>get_schemas() : array</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::get_schemas()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
<h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</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::get_sequences()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
<h2>Retreives an array of non-user-created tables for
the connection/database</h2>
<pre>get_system_tables() : array</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::get_system_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
<h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</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::get_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
<h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</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::get_triggers()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
<h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</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::get_types()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
<h2>Return list of views for the current database</h2>
<pre>get_views() : array</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::get_views()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
<h2>inTransaction()
</h2>
<pre>inTransaction() </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>PDO::inTransaction()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::inTransaction()</td>
</tr>
</table>
</div></div>
</div>
<a name="insert_batch" id="insert_batch"></a><div class="element clickable method public insert_batch" data-toggle="collapse" data-target=".insert_batch .collapse">
<h2>Create sql for batch insert</h2> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -595,51 +191,12 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse"> <a id="method_prepare"></a><div class="element clickable method public method_prepare" data-toggle="collapse" data-target=".method_prepare .collapse">
<h2>lastInsertId()
</h2>
<pre>lastInsertId() </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>PDO::lastInsertId()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::lastInsertId()</td>
</tr>
</table>
</div></div>
</div>
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
<h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</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>see</th>
<td>\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::num_rows()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
<h2>Emulate PDO prepare</h2> <h2>Emulate PDO prepare</h2>
<pre>prepare(string $query, array $options) : <a href="../classes/Firebird.html">\Firebird</a></pre> <pre>prepare(string $query, array $options) : \Firebird</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -654,15 +211,15 @@ the connection/database</h2>
<code>array</code> <code>array</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Firebird.html">\Firebird</a></code></div> <div class="subelement response"><code>\Firebird</code></div>
</div></div> </div></div>
</div> </div>
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse"> <a id="method_prepare_execute"></a><div class="element clickable method public method_prepare_execute" data-toggle="collapse" data-target=".method_prepare_execute .collapse">
<h2>Prepare and execute a query</h2> <h2>Prepare and execute a query</h2>
<pre>prepare_execute(string $sql, array $args) : resource</pre> <pre>prepare_execute(string $sql, array $args) : resource</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -676,12 +233,12 @@ the connection/database</h2>
<div class="subelement response"><code>resource</code></div> <div class="subelement response"><code>resource</code></div>
</div></div> </div></div>
</div> </div>
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse"> <a id="method_prepare_query"></a><div class="element clickable method public method_prepare_query" data-toggle="collapse" data-target=".method_prepare_query .collapse">
<h2>Bind a prepared query with arguments for executing</h2> <h2>Bind a prepared query with arguments for executing</h2>
<pre>prepare_query(string $sql, array $params) : NULL</pre> <pre>prepare_query(string $sql, array $params) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -695,12 +252,12 @@ the connection/database</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse"> <a id="method_query"></a><div class="element clickable method public method_query" data-toggle="collapse" data-target=".method_query .collapse">
<h2>Wrapper public function to better match PDO</h2> <h2>Wrapper public function to better match PDO</h2>
<pre>query(string $sql) : <a href="../classes/Firebird.html">\Firebird</a></pre> <pre>query(string $sql) : \Firebird</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -711,15 +268,15 @@ the connection/database</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Firebird.html">\Firebird</a></code></div> <div class="subelement response"><code>\Firebird</code></div>
</div></div> </div></div>
</div> </div>
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse"> <a id="method_quote"></a><div class="element clickable method public method_quote" data-toggle="collapse" data-target=".method_quote .collapse">
<h2>Method to emulate PDO-&gt;quote</h2> <h2>Method to emulate PDO-&gt;quote</h2>
<pre>quote(string $str, int $param_type) : string</pre> <pre>quote(string $str, int $param_type) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$str</h4> <h4>$str</h4>
@ -733,79 +290,22 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse"> <a id="method_rollBack"></a><div class="element clickable method public method_rollBack" data-toggle="collapse" data-target=".method_rollBack .collapse">
<h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : 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_ident()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$ident</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<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(string $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>string</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> <h2>Rollback a transaction</h2>
<pre>rollBack() : bool</pre> <pre>rollBack() : bool</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </div></div>
</div> </div>
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse">
<h2>setAttribute()
</h2>
<pre>setAttribute() </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>PDO::setAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::setAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
<h2>Empty a database table</h2> <h2>Empty a database table</h2>
<pre>truncate(string $table) : void</pre> <pre>truncate(string $table) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -813,130 +313,32 @@ the connection/database</h2>
</div> </div>
</div></div> </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>
<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()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</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"> <a id="property_conn"> </a><div class="element clickable property protected property_conn" data-toggle="collapse" data-target=".property_conn .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$last_query</td>
</tr></table>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$sql</td>
</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>$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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$util</td>
</tr></table>
</div></div>
</div>
<a name="%24conn" id="$conn"> </a><div class="element clickable property protected $conn" data-toggle="collapse" data-target=".$conn .collapse">
<h2>Reference to the connection resource</h2> <h2>Reference to the connection resource</h2>
<pre>$conn : resource</pre> <pre>$conn : resource</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></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"> <a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$escape_char</td>
</tr></table>
</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 query executed</h2> <h2>Reference to the last query executed</h2>
<pre>$statement : object</pre> <pre>$statement : object</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="%24statement_link" id="$statement_link"> </a><div class="element clickable property protected $statement_link" data-toggle="collapse" data-target=".$statement_link .collapse"> <a id="property_statement_link"> </a><div class="element clickable property protected property_statement_link" data-toggle="collapse" data-target=".property_statement_link .collapse">
<h2>Reference to the resource returned by <h2>Reference to the resource returned by
the last query executed</h2> the last query executed</h2>
<pre>$statement_link : resource</pre> <pre>$statement_link : resource</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="%24trans" id="$trans"> </a><div class="element clickable property protected $trans" data-toggle="collapse" data-target=".$trans .collapse"> <a id="property_trans"> </a><div class="element clickable property protected property_trans" data-toggle="collapse" data-target=".property_trans .collapse">
<h2>Reference to the current transaction</h2> <h2>Reference to the current transaction</h2>
<pre>$trans : resource</pre> <pre>$trans : resource</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
</div> </div>
</div> </div>
@ -944,8 +346,9 @@ the last query executed</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

335
docs/classes/Firebird_Result.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,59 +54,55 @@
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li> <i class="icon-custom icon-method"></i> Methods
<li class="method public "><a href="#__construct" title="__construct :: Create the object by passing the resource for <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Create the object by passing the resource for
the query"><span class="description">Create the object by passing the resource for the query"><span class="description">Create the object by passing the resource for
the query</span><pre>__construct()</pre></a></li> the query</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__sleep" title="__sleep :: "><span class="description">__sleep() <li class="method public "><a href="#method_bindColumn" title="bindColumn() :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindColumn()</pre></a></li>
</span><pre>__sleep()</pre></a></li> <li class="method public "><a href="#method_bindParam" title="bindParam() :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindParam()</pre></a></li>
<li class="method public "><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup() <li class="method public "><a href="#method_bindValue" title="bindValue() :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindValue()</pre></a></li>
</span><pre>__wakeup()</pre></a></li> <li class="method public "><a href="#method_errorCode" title="errorCode() :: Method to emulate PDOStatement-&gt;errorCode"><span class="description">Method to emulate PDOStatement-&gt;errorCode</span><pre>errorCode()</pre></a></li>
<li class="method public "><a href="#bindColumn" title="bindColumn :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindColumn()</pre></a></li> <li class="method public "><a href="#method_errorInfo" title="errorInfo() :: Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo"><span class="description">Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</span><pre>errorInfo()</pre></a></li>
<li class="method public "><a href="#bindParam" title="bindParam :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindParam()</pre></a></li> <li class="method public "><a href="#method_execute" title="execute() :: Run a prepared statement query"><span class="description">Run a prepared statement query</span><pre>execute()</pre></a></li>
<li class="method public "><a href="#bindValue" title="bindValue :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindValue()</pre></a></li> <li class="method public "><a href="#method_fetch" title="fetch() :: Emulate PDO fetch public function"><span class="description">Emulate PDO fetch public function</span><pre>fetch()</pre></a></li>
<li class="method public "><a href="#closeCursor" title="closeCursor :: "><span class="description">closeCursor() <li class="method public "><a href="#method_fetchAll" title="fetchAll() :: Emulate PDO fetchAll public function"><span class="description">Emulate PDO fetchAll public function</span><pre>fetchAll()</pre></a></li>
</span><pre>closeCursor()</pre></a></li> <li class="method public "><a href="#method_fetchColumn" title="fetchColumn() :: Emulate PDOStatement::fetchColumn"><span class="description">Emulate PDOStatement::fetchColumn</span><pre>fetchColumn()</pre></a></li>
<li class="method public "><a href="#columnCount" title="columnCount :: "><span class="description">columnCount() <li class="method public "><a href="#method_fetchObject" title="fetchObject() :: Emulate PDOStatement::fetchObject, but only for the default use"><span class="description">Emulate PDOStatement::fetchObject, but only for the default use</span><pre>fetchObject()</pre></a></li>
</span><pre>columnCount()</pre></a></li> <li class="method public "><a href="#method_rowCount" title="rowCount() :: Return the number of rows affected by the previous query"><span class="description">Return the number of rows affected by the previous query</span><pre>rowCount()</pre></a></li>
<li class="method public "><a href="#debugDumpParams" title="debugDumpParams :: "><span class="description">debugDumpParams() </ul>
</span><pre>debugDumpParams()</pre></a></li> </li>
<li class="method public "><a href="#errorCode" title="errorCode :: Method to emulate PDOStatement-&gt;errorCode"><span class="description">Method to emulate PDOStatement-&gt;errorCode</span><pre>errorCode()</pre></a></li>
<li class="method public "><a href="#errorInfo" title="errorInfo :: Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo"><span class="description">Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</span><pre>errorInfo()</pre></a></li>
<li class="method public "><a href="#execute" title="execute :: Run a prepared statement query"><span class="description">Run a prepared statement query</span><pre>execute()</pre></a></li>
<li class="method public "><a href="#fetch" title="fetch :: Emulate PDO fetch public function"><span class="description">Emulate PDO fetch public function</span><pre>fetch()</pre></a></li>
<li class="method public "><a href="#fetchAll" title="fetchAll :: Emulate PDO fetchAll public function"><span class="description">Emulate PDO fetchAll public function</span><pre>fetchAll()</pre></a></li>
<li class="method public "><a href="#fetchColumn" title="fetchColumn :: Emulate PDOStatement::fetchColumn"><span class="description">Emulate PDOStatement::fetchColumn</span><pre>fetchColumn()</pre></a></li>
<li class="method public "><a href="#fetchObject" title="fetchObject :: Emulate PDOStatement::fetchObject, but only for the default use"><span class="description">Emulate PDOStatement::fetchObject, but only for the default use</span><pre>fetchObject()</pre></a></li>
<li class="method public "><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
</span><pre>getAttribute()</pre></a></li>
<li class="method public "><a href="#getColumnMeta" title="getColumnMeta :: "><span class="description">getColumnMeta()
</span><pre>getColumnMeta()</pre></a></li>
<li class="method public "><a href="#nextRowset" title="nextRowset :: "><span class="description">nextRowset()
</span><pre>nextRowset()</pre></a></li>
<li class="method public "><a href="#rowCount" title="rowCount :: Return the number of rows affected by the previous query"><span class="description">Return the number of rows affected by the previous query</span><pre>rowCount()</pre></a></li>
<li class="method public "><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
</span><pre>setAttribute()</pre></a></li>
<li class="method public "><a href="#setFetchMode" title="setFetchMode :: "><span class="description">setFetchMode()
</span><pre>setFetchMode()</pre></a></li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li> <i class="icon-custom icon-property"></i> Properties
<li class="nav-header private">» Private</li> <ul></ul>
<li class="property private "><a href="#%24result" title="$result :: Data pulled from query"><span class="description">Data pulled from query</span><pre>$result</pre></a></li> </li>
<li class="property private "><a href="#%24row" title="$row :: Current row in result array"><span class="description">Current row in result array</span><pre>$row</pre></a></li> <li class="nav-header private">» Private
<li class="property private "><a href="#%24statement" title="$statement :: Reference to fbird resource"><span class="description">Reference to fbird resource</span><pre>$statement</pre></a></li> <ul>
<li class="property private "><a href="#property_result" title="$result() :: Data pulled from query"><span class="description"></span><pre>$result</pre></a></li>
<li class="property private "><a href="#property_row" title="$row() :: Current row in result array"><span class="description"></span><pre>$row</pre></a></li>
<li class="property private "><a href="#property_statement" title="$statement() :: Reference to fbird resource"><span class="description"></span><pre>$statement</pre></a></li>
</ul>
</li>
</ul> </ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CFirebird_Result" id="\Firebird_Result"></a><div href="../classes/Firebird_Result.html" class="element class"> <a id="\Firebird_Result"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Firebird_Result.html">Firebird_Result</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements <p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods</p> data-fetching methods</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -118,13 +111,13 @@ data-fetching methods</p>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Create the object by passing the resource for <h2>Create the object by passing the resource for
the query</h2> the query</h2>
<pre>__construct(resource $link) </pre> <pre>__construct(resource $link) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$link</h4> <h4>$link</h4>
@ -132,47 +125,18 @@ the query</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse"> <a id="method_bindColumn"></a><div class="element clickable method public method_bindColumn" data-toggle="collapse" data-target=".method_bindColumn .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::__sleep()</td>
</tr></table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::__wakeup()</td>
</tr></table>
</div></div>
</div>
<a name="bindColumn" id="bindColumn"></a><div class="element clickable method public bindColumn" data-toggle="collapse" data-target=".bindColumn .collapse">
<h2>Invalidate method for data consistency</h2> <h2>Invalidate method for data consistency</h2>
<pre>bindColumn(mixed $column, mixed $param, int $type, mixed $maxlen, array $driverdata) : NULL</pre> <pre>bindColumn(mixed $column, $param, int $type, mixed $maxlen, array $driverdata) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$column</h4> <h4>$column</h4>
<code>mixed</code> <code>mixed</code>
</div> </div>
<div class="subelement argument"> <div class="subelement argument"><h4>$param</h4></div>
<h4>$param</h4>
<code>mixed</code><p>&$param</p>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$type</h4> <h4>$type</h4>
<code>int</code> <code>int</code>
@ -189,21 +153,18 @@ the query</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="bindParam" id="bindParam"></a><div class="element clickable method public bindParam" data-toggle="collapse" data-target=".bindParam .collapse"> <a id="method_bindParam"></a><div class="element clickable method public method_bindParam" data-toggle="collapse" data-target=".method_bindParam .collapse">
<h2>Invalidate method for data consistency</h2> <h2>Invalidate method for data consistency</h2>
<pre>bindParam(mixed $parameter, mixed $variable, int $data_type, mixed $maxlen, array $driverdata) : NULL</pre> <pre>bindParam(mixed $parameter, $variable, int $data_type, mixed $maxlen, array $driverdata) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$parameter</h4> <h4>$parameter</h4>
<code>mixed</code> <code>mixed</code>
</div> </div>
<div class="subelement argument"> <div class="subelement argument"><h4>$variable</h4></div>
<h4>$variable</h4>
<code>mixed</code><p>&$variable</p>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$data_type</h4> <h4>$data_type</h4>
<code>int</code> <code>int</code>
@ -220,21 +181,18 @@ the query</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="bindValue" id="bindValue"></a><div class="element clickable method public bindValue" data-toggle="collapse" data-target=".bindValue .collapse"> <a id="method_bindValue"></a><div class="element clickable method public method_bindValue" data-toggle="collapse" data-target=".method_bindValue .collapse">
<h2>Invalidate method for data consistency</h2> <h2>Invalidate method for data consistency</h2>
<pre>bindValue(mixed $parameter, mixed $variable, int $data_type) : NULL</pre> <pre>bindValue(mixed $parameter, $variable, int $data_type) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$parameter</h4> <h4>$parameter</h4>
<code>mixed</code> <code>mixed</code>
</div> </div>
<div class="subelement argument"> <div class="subelement argument"><h4>$variable</h4></div>
<h4>$variable</h4>
<code>mixed</code><p>&$variable</p>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$data_type</h4> <h4>$data_type</h4>
<code>int</code> <code>int</code>
@ -243,71 +201,32 @@ the query</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="closeCursor" id="closeCursor"></a><div class="element clickable method public closeCursor" data-toggle="collapse" data-target=".closeCursor .collapse"> <a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse">
<h2>closeCursor()
</h2>
<pre>closeCursor() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::closeCursor()</td>
</tr></table>
</div></div>
</div>
<a name="columnCount" id="columnCount"></a><div class="element clickable method public columnCount" data-toggle="collapse" data-target=".columnCount .collapse">
<h2>columnCount()
</h2>
<pre>columnCount() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::columnCount()</td>
</tr></table>
</div></div>
</div>
<a name="debugDumpParams" id="debugDumpParams"></a><div class="element clickable method public debugDumpParams" data-toggle="collapse" data-target=".debugDumpParams .collapse">
<h2>debugDumpParams()
</h2>
<pre>debugDumpParams() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::debugDumpParams()</td>
</tr></table>
</div></div>
</div>
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
<h2>Method to emulate PDOStatement-&gt;errorCode</h2> <h2>Method to emulate PDOStatement-&gt;errorCode</h2>
<pre>errorCode() : string</pre> <pre>errorCode() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse"> <a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse">
<h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2> <h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2>
<pre>errorInfo() : array</pre> <pre>errorInfo() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="execute" id="execute"></a><div class="element clickable method public execute" data-toggle="collapse" data-target=".execute .collapse"> <a id="method_execute"></a><div class="element clickable method public method_execute" data-toggle="collapse" data-target=".method_execute .collapse">
<h2>Run a prepared statement query</h2> <h2>Run a prepared statement query</h2>
<pre>execute(array $args) : bool</pre> <pre>execute(array $args) : bool</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$args</h4> <h4>$args</h4>
@ -317,12 +236,12 @@ the query</h2>
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </div></div>
</div> </div>
<a name="fetch" id="fetch"></a><div class="element clickable method public fetch" data-toggle="collapse" data-target=".fetch .collapse"> <a id="method_fetch"></a><div class="element clickable method public method_fetch" data-toggle="collapse" data-target=".method_fetch .collapse">
<h2>Emulate PDO fetch public function</h2> <h2>Emulate PDO fetch public function</h2>
<pre>fetch(int $fetch_style, mixed $statement, mixed $offset) : mixed</pre> <pre>fetch(int $fetch_style, mixed $statement, mixed $offset) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$fetch_style</h4> <h4>$fetch_style</h4>
@ -340,12 +259,12 @@ the query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="fetchAll" id="fetchAll"></a><div class="element clickable method public fetchAll" data-toggle="collapse" data-target=".fetchAll .collapse"> <a id="method_fetchAll"></a><div class="element clickable method public method_fetchAll" data-toggle="collapse" data-target=".method_fetchAll .collapse">
<h2>Emulate PDO fetchAll public function</h2> <h2>Emulate PDO fetchAll public function</h2>
<pre>fetchAll(int $fetch_style, mixed $statement, mixed $ctor_args) : mixed</pre> <pre>fetchAll(int $fetch_style, mixed $statement, mixed $ctor_args) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$fetch_style</h4> <h4>$fetch_style</h4>
@ -363,12 +282,12 @@ the query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="fetchColumn" id="fetchColumn"></a><div class="element clickable method public fetchColumn" data-toggle="collapse" data-target=".fetchColumn .collapse"> <a id="method_fetchColumn"></a><div class="element clickable method public method_fetchColumn" data-toggle="collapse" data-target=".method_fetchColumn .collapse">
<h2>Emulate PDOStatement::fetchColumn</h2> <h2>Emulate PDOStatement::fetchColumn</h2>
<pre>fetchColumn(int $column_num) : mixed</pre> <pre>fetchColumn(int $column_num) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$column_num</h4> <h4>$column_num</h4>
@ -378,12 +297,12 @@ the query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="fetchObject" id="fetchObject"></a><div class="element clickable method public fetchObject" data-toggle="collapse" data-target=".fetchObject .collapse"> <a id="method_fetchObject"></a><div class="element clickable method public method_fetchObject" data-toggle="collapse" data-target=".method_fetchObject .collapse">
<h2>Emulate PDOStatement::fetchObject, but only for the default use</h2> <h2>Emulate PDOStatement::fetchObject, but only for the default use</h2>
<pre>fetchObject(string $class_name, array $ctor_args) : <a href="http://php.net/manual/en/class.stdclass.php">\stdClass</a></pre> <pre>fetchObject(string $class_name, array $ctor_args) : <a href="stdClass.html">\stdClass</a></pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$class_name</h4> <h4>$class_name</h4>
@ -394,109 +313,44 @@ the query</h2>
<code>array</code> <code>array</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.stdclass.php">\stdClass</a></code></div> <div class="subelement response"><code><a href="stdClass.html">\stdClass</a></code></div>
</div></div> </div></div>
</div> </div>
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse"> <a id="method_rowCount"></a><div class="element clickable method public method_rowCount" data-toggle="collapse" data-target=".method_rowCount .collapse">
<h2>getAttribute()
</h2>
<pre>getAttribute() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::getAttribute()</td>
</tr></table>
</div></div>
</div>
<a name="getColumnMeta" id="getColumnMeta"></a><div class="element clickable method public getColumnMeta" data-toggle="collapse" data-target=".getColumnMeta .collapse">
<h2>getColumnMeta()
</h2>
<pre>getColumnMeta() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::getColumnMeta()</td>
</tr></table>
</div></div>
</div>
<a name="nextRowset" id="nextRowset"></a><div class="element clickable method public nextRowset" data-toggle="collapse" data-target=".nextRowset .collapse">
<h2>nextRowset()
</h2>
<pre>nextRowset() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::nextRowset()</td>
</tr></table>
</div></div>
</div>
<a name="rowCount" id="rowCount"></a><div class="element clickable method public rowCount" data-toggle="collapse" data-target=".rowCount .collapse">
<h2>Return the number of rows affected by the previous query</h2> <h2>Return the number of rows affected by the previous query</h2>
<pre>rowCount() : int</pre> <pre>rowCount() : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
<h2>setAttribute()
</h2>
<pre>setAttribute() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::setAttribute()</td>
</tr></table>
</div></div>
</div>
<a name="setFetchMode" id="setFetchMode"></a><div class="element clickable method public setFetchMode" data-toggle="collapse" data-target=".setFetchMode .collapse">
<h2>setFetchMode()
</h2>
<pre>setFetchMode() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDOStatement::setFetchMode()</td>
</tr></table>
</div></div>
</div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24result" id="$result"> </a><div class="element clickable property private $result" data-toggle="collapse" data-target=".$result .collapse"> <a id="property_result"> </a><div class="element clickable property private property_result" data-toggle="collapse" data-target=".property_result .collapse">
<h2>Data pulled from query</h2> <h2>Data pulled from query</h2>
<pre>$result </pre> <pre>$result </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>param</th> <th>param</th>
<td>&lt;p&gt;mixed&lt;/p&gt;</td> <td></td>
</tr></table> </tr></table>
</div></div> </div></div>
</div> </div>
<a name="%24row" id="$row"> </a><div class="element clickable property private $row" data-toggle="collapse" data-target=".$row .collapse"> <a id="property_row"> </a><div class="element clickable property private property_row" data-toggle="collapse" data-target=".property_row .collapse">
<h2>Current row in result array</h2> <h2>Current row in result array</h2>
<pre>$row : int</pre> <pre>$row : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property private $statement" data-toggle="collapse" data-target=".$statement .collapse"> <a id="property_statement"> </a><div class="element clickable property private property_statement" data-toggle="collapse" data-target=".property_statement .collapse">
<h2>Reference to fbird resource</h2> <h2>Reference to fbird resource</h2>
<pre>$statement : resource</pre> <pre>$statement : resource</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
</div> </div>
</div> </div>
@ -504,8 +358,9 @@ the query</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

131
docs/classes/Firebird_SQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,32 +52,41 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<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="#method_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 "><a href="#method_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="#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="#method_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 "><a href="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</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="#method_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="#method_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 "><a href="#method_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="#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="#method_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="#method_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> <li class="method public "><a href="#method_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>
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li> <li class="method public "><a href="#method_type_list" title="type_list() :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li> <li class="method public "><a href="#method_view_list" title="view_list() :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CFirebird_SQL" id="\Firebird_SQL"></a><div href="../classes/Firebird_SQL.html" class="element class"> <a id="\Firebird_SQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Firebird_SQL.html">Firebird_SQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Firebird Specific SQL</p> <p class="short_description">Firebird Specific SQL</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -89,12 +95,12 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse"> <a id="method_column_list"></a><div class="element clickable method public method_column_list" data-toggle="collapse" data-target=".method_column_list .collapse">
<h2>Return sql to list columns of the specified table</h2> <h2>Return sql to list columns of the specified table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -104,32 +110,32 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse"> <a id="method_db_list"></a><div class="element clickable method public method_db_list" data-toggle="collapse" data-target=".method_db_list .collapse">
<h2>Returns sql to list other databases</h2> <h2>Returns sql to list other databases</h2>
<pre>db_list() : NULL</pre> <pre>db_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_function_list"></a><div class="element clickable method public method_function_list" data-toggle="collapse" data-target=".method_function_list .collapse">
<h2>Return sql to list functions</h2> <h2>Return sql to list functions</h2>
<pre>function_list() : string</pre> <pre>function_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse">
<h2>Limit clause</h2> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -147,82 +153,82 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse">
<h2>Return sql to list stored procedures</h2> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse"> <a id="method_sequence_list"></a><div class="element clickable method public method_sequence_list" data-toggle="collapse" data-target=".method_sequence_list .collapse">
<h2>Return sql to list sequences</h2> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre> <pre>sequence_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_system_table_list"></a><div class="element clickable method public method_system_table_list" data-toggle="collapse" data-target=".method_system_table_list .collapse">
<h2>Returns sql to list system tables</h2> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse"> <a id="method_table_list"></a><div class="element clickable method public method_table_list" data-toggle="collapse" data-target=".method_table_list .collapse">
<h2>Returns sql to list tables</h2> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse"> <a id="method_trigger_list"></a><div class="element clickable method public method_trigger_list" data-toggle="collapse" data-target=".method_trigger_list .collapse">
<h2>Returns sql to list triggers</h2> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse"> <a id="method_type_list"></a><div class="element clickable method public method_type_list" data-toggle="collapse" data-target=".method_type_list .collapse">
<h2>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : string</pre> <pre>type_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse"> <a id="method_view_list"></a><div class="element clickable method public method_view_list" data-toggle="collapse" data-target=".method_view_list .collapse">
<h2>Returns sql to list views</h2> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
@ -233,8 +239,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

122
docs/classes/Firebird_Util.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,30 +52,34 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#backup_data" title="backup_data :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li> <li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li> <li class="method public "><a href="#method_create_table" title="create_table() :: Convienience public function to generate sql for creating a db table"><span class="description">Convienience public function to generate sql for creating a db table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Convienience public function to generate sql for creating a db table"><span class="description">Convienience public function to generate sql for creating a db table</span><pre>create_table()</pre></a></li> <li class="method public "><a href="#method_delete_table" title="delete_table() :: Drop the selected table"><span class="description">Drop the selected table</span><pre>delete_table()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: Drop the selected table"><span class="description">Drop the selected table</span><pre>delete_table()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CFirebird_Util" id="\Firebird_Util"></a><div href="../classes/Firebird_Util.html" class="element class"> <a id="\Firebird_Util"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Firebird_Util.html">Firebird_Util</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Firebird-specific backup, import and creation methods</p> <p class="short_description">Firebird-specific backup, import and creation methods</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -87,46 +88,22 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) </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_Util::__call()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct(object $conn) : void</pre> <pre>__construct($conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$conn</h4></div>
<h4>$conn</h4>
<code>object</code><p>&$conn</p>
</div>
</div></div> </div></div>
</div> </div>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $exclude, bool $system_tables) : string</pre> <pre>backup_data(array $exclude, bool $system_tables) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$exclude</h4> <h4>$exclude</h4>
@ -140,22 +117,22 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse"> <a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse">
<h2>Convienience public function to generate sql for creating a db table</h2> <h2>Convienience public function to generate sql for creating a db table</h2>
<pre>create_table(string $name, array $fields, array $constraints, array $indexes) : string</pre> <pre>create_table(string $name, array $fields, array $constraints, array $indexes) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -177,12 +154,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse"> <a id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse">
<h2>Drop the selected table</h2> <h2>Drop the selected table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -192,28 +169,15 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
<h2>Reference to the current connection object</h2>
<pre>$conn </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_Util::$$conn</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

915
docs/classes/MySQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,90 +54,38 @@
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li> <i class="icon-custom icon-method"></i> Methods
<li class="method public "><a href="#__construct" title="__construct :: Connect to MySQL Database"><span class="description">Connect to MySQL Database</span><pre>__construct()</pre></a></li> <ul>
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep() <li class="method public "><a href="#method___construct" title="__construct() :: Connect to MySQL Database"><span class="description">Connect to MySQL Database</span><pre>__construct()</pre></a></li>
</span><pre>__sleep()</pre></a></li> <li class="method public "><a href="#method_truncate" title="truncate() :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup() </ul>
</span><pre>__wakeup()</pre></a></li> </li>
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
</span><pre>beginTransaction()</pre></a></li>
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
</span><pre>commit()</pre></a></li>
<li class="method public inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
</span><pre>errorCode()</pre></a></li>
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
</span><pre>errorInfo()</pre></a></li>
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
</span><pre>exec()</pre></a></li>
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
</span><pre>getAttribute()</pre></a></li>
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
</span><pre>getAvailableDrivers()</pre></a></li>
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
</span><pre>inTransaction()</pre></a></li>
<li class="method public inherited"><a href="#insert_batch" title="insert_batch :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
</span><pre>lastInsertId()</pre></a></li>
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
</span><pre>prepare()</pre></a></li>
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
</span><pre>query()</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()
</span><pre>setAttribute()</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"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li> <i class="icon-custom icon-property"></i> Properties
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li> <ul></ul>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li> </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="nav-header protected">» Protected
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li> <ul><li class="property protected "><a href="#property_escape_char" title="$escape_char() :: Set the backtick as the MySQL escape character"><span class="description"></span><pre>$escape_char</pre></a></li></ul>
<li class="nav-header protected">» Protected</li> </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 :: "><span class="description">$statement</span><pre>$statement</pre></a></li>
</ul> </ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CMySQL" id="\MySQL"></a><div href="../classes/MySQL.html" class="element class"> <a id="\MySQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/MySQL.html">MySQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">MySQL specific class</p> <p class="short_description">MySQL specific class</p>
<div class="details"> <div class="details">
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p> <div class="long_description">Extends PDO to simplify cross-database issues</div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -149,12 +94,12 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Connect to MySQL Database</h2> <h2>Connect to MySQL Database</h2>
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre> <pre>__construct(string $dsn, string $username, string $password, array $options) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$dsn</h4> <h4>$dsn</h4>
@ -174,699 +119,12 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </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>PDO::__sleep()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__sleep()</td>
</tr>
</table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </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>PDO::__wakeup()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__wakeup()</td>
</tr>
</table>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</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::affected_rows()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
<h2>beginTransaction()
</h2>
<pre>beginTransaction() </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>PDO::beginTransaction()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::beginTransaction()</td>
</tr>
</table>
</div></div>
</div>
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
<h2>commit()
</h2>
<pre>commit() </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>PDO::commit()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::commit()</td>
</tr>
</table>
</div></div>
</div>
<a name="driver_query" id="driver_query"></a><div class="element clickable method public driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
<h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</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::driver_query()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$filtered_index</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
<h2>Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</h2>
<pre>empty_table(string $table) : mixed</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::empty_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
<h2>errorCode()
</h2>
<pre>errorCode() </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>PDO::errorCode()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::errorCode()</td>
</tr>
</table>
</div></div>
</div>
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
<h2>errorInfo()
</h2>
<pre>errorInfo() </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>PDO::errorInfo()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::errorInfo()</td>
</tr>
</table>
</div></div>
</div>
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
<h2>exec()
</h2>
<pre>exec() </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>PDO::exec()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::exec()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
<h2>getAttribute()
</h2>
<pre>getAttribute() </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>PDO::getAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
<h2>getAvailableDrivers()
</h2>
<pre>getAvailableDrivers() </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>PDO::getAvailableDrivers()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAvailableDrivers()</td>
</tr>
</table>
</div></div>
</div>
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
<h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</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::get_columns()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
<h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</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::get_dbs()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
<h2>Return list of function for the current database</h2>
<pre>get_functions() : array</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::get_functions()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
<h2>Return the last error for the current database connection</h2>
<pre>get_last_error() : 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::get_last_error()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
<h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</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::get_procedures()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
<h2>Retreives the data from a select query</h2>
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</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::get_query_data()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
<h2>Return schemas for databases that list them</h2>
<pre>get_schemas() : array</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::get_schemas()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
<h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</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::get_sequences()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
<h2>Retreives an array of non-user-created tables for
the connection/database</h2>
<pre>get_system_tables() : array</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::get_system_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
<h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</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::get_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
<h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</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::get_triggers()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
<h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</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::get_types()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
<h2>Return list of views for the current database</h2>
<pre>get_views() : array</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::get_views()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
<h2>inTransaction()
</h2>
<pre>inTransaction() </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>PDO::inTransaction()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::inTransaction()</td>
</tr>
</table>
</div></div>
</div>
<a name="insert_batch" id="insert_batch"></a><div class="element clickable method public insert_batch" data-toggle="collapse" data-target=".insert_batch .collapse">
<h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : 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::insert_batch()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
<h2>lastInsertId()
</h2>
<pre>lastInsertId() </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>PDO::lastInsertId()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::lastInsertId()</td>
</tr>
</table>
</div></div>
</div>
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
<h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</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>see</th>
<td>\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::num_rows()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
<h2>prepare()
</h2>
<pre>prepare() </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>PDO::prepare()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::prepare()</td>
</tr>
</table>
</div></div>
</div>
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
<h2>Create and execute a prepared statement with the provided parameters</h2>
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></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::prepare_execute()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
</div></div>
</div>
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
<h2>Simplifies prepared statements for database queries</h2>
<pre>prepare_query(string $sql, array $data) : mixed</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::prepare_query()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>PDOStatement / FALSE</div>
</div></div>
</div>
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
<h2>query()
</h2>
<pre>query() </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>PDO::query()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::query()</td>
</tr>
</table>
</div></div>
</div>
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
<h2>quote()
</h2>
<pre>quote() </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>PDO::quote()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::quote()</td>
</tr>
</table>
</div></div>
</div>
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
<h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : 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_ident()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$ident</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<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(string $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>string</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>
<pre>rollBack() </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>PDO::rollBack()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::rollBack()</td>
</tr>
</table>
</div></div>
</div>
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
<h2>setAttribute()
</h2>
<pre>setAttribute() </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>PDO::setAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::setAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
<h2>Empty a table</h2> <h2>Empty a table</h2>
<pre>truncate(string $table) : void</pre> <pre>truncate(string $table) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -874,111 +132,13 @@ the connection/database</h2>
</div> </div>
</div></div> </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>
<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()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</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"> <a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$last_query</td>
</tr></table>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$sql</td>
</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>$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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$util</td>
</tr></table>
</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>Set the backtick as the MySQL escape character</h2> <h2>Set the backtick as the MySQL escape character</h2>
<pre>$escape_char : string</pre> <pre>$escape_char : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$statement</td>
</tr></table>
</div></div>
</div> </div>
</div> </div>
</div> </div>
@ -986,8 +146,9 @@ the connection/database</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

131
docs/classes/MySQL_SQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,32 +52,41 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<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="#method_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 "><a href="#method_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="#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="#method_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 "><a href="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</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="#method_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="#method_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 "><a href="#method_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="#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="#method_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="#method_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> <li class="method public "><a href="#method_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>
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li> <li class="method public "><a href="#method_type_list" title="type_list() :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li> <li class="method public "><a href="#method_view_list" title="view_list() :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CMySQL_SQL" id="\MySQL_SQL"></a><div href="../classes/MySQL_SQL.html" class="element class"> <a id="\MySQL_SQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/MySQL_SQL.html">MySQL_SQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">MySQL specifc SQL</p> <p class="short_description">MySQL specifc SQL</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -89,12 +95,12 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse"> <a id="method_column_list"></a><div class="element clickable method public method_column_list" data-toggle="collapse" data-target=".method_column_list .collapse">
<h2>SQL to show infromation about columns in a table</h2> <h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -104,32 +110,32 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse"> <a id="method_db_list"></a><div class="element clickable method public method_db_list" data-toggle="collapse" data-target=".method_db_list .collapse">
<h2>Returns sql to list other databases</h2> <h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre> <pre>db_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_function_list"></a><div class="element clickable method public method_function_list" data-toggle="collapse" data-target=".method_function_list .collapse">
<h2>Return sql to list functions</h2> <h2>Return sql to list functions</h2>
<pre>function_list() : string</pre> <pre>function_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse">
<h2>Limit clause</h2> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -147,52 +153,52 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse">
<h2>Return sql to list stored procedures</h2> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse"> <a id="method_sequence_list"></a><div class="element clickable method public method_sequence_list" data-toggle="collapse" data-target=".method_sequence_list .collapse">
<h2>Return sql to list sequences</h2> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : NULL</pre> <pre>sequence_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_system_table_list"></a><div class="element clickable method public method_system_table_list" data-toggle="collapse" data-target=".method_system_table_list .collapse">
<h2>Overridden in MySQL class</h2> <h2>Overridden in MySQL class</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse"> <a id="method_table_list"></a><div class="element clickable method public method_table_list" data-toggle="collapse" data-target=".method_table_list .collapse">
<h2>Returns sql to list tables</h2> <h2>Returns sql to list tables</h2>
<pre>table_list(string $database) : string</pre> <pre>table_list(string $database) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$database</h4> <h4>$database</h4>
@ -202,32 +208,32 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse"> <a id="method_trigger_list"></a><div class="element clickable method public method_trigger_list" data-toggle="collapse" data-target=".method_trigger_list .collapse">
<h2>Returns sql to list triggers</h2> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse"> <a id="method_type_list"></a><div class="element clickable method public method_type_list" data-toggle="collapse" data-target=".method_type_list .collapse">
<h2>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : string</pre> <pre>type_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse"> <a id="method_view_list"></a><div class="element clickable method public method_view_list" data-toggle="collapse" data-target=".method_view_list .collapse">
<h2>Returns sql to list views</h2> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
@ -238,8 +244,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

122
docs/classes/MySQL_Util.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,30 +52,34 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#backup_data" title="backup_data :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li> <li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li> <li class="method public "><a href="#method_create_table" title="create_table() :: Convienience public function for creating a new MySQL table"><span class="description">Convienience public function for creating a new MySQL table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Convienience public function for creating a new MySQL table"><span class="description">Convienience public function for creating a new MySQL table</span><pre>create_table()</pre></a></li> <li class="method public "><a href="#method_delete_table" title="delete_table() :: Convience public function for droping a table"><span class="description">Convience public function for droping a table</span><pre>delete_table()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: Convience public function for droping a table"><span class="description">Convience public function for droping a table</span><pre>delete_table()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CMySQL_Util" id="\MySQL_Util"></a><div href="../classes/MySQL_Util.html" class="element class"> <a id="\MySQL_Util"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/MySQL_Util.html">MySQL_Util</a>
</li>
</ul>
<div class="element class">
<p class="short_description">MySQL-specific backup, import and creation methods</p> <p class="short_description">MySQL-specific backup, import and creation methods</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -87,46 +88,22 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) </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_Util::__call()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct(object $conn) : void</pre> <pre>__construct($conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$conn</h4></div>
<h4>$conn</h4>
<code>object</code><p>&$conn</p>
</div>
</div></div> </div></div>
</div> </div>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $exclude) : string</pre> <pre>backup_data(array $exclude) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$exclude</h4> <h4>$exclude</h4>
@ -136,22 +113,22 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse"> <a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse">
<h2>Convienience public function for creating a new MySQL table</h2> <h2>Convienience public function for creating a new MySQL table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -173,12 +150,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse"> <a id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse">
<h2>Convience public function for droping a table</h2> <h2>Convience public function for droping a table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -188,28 +165,15 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
<h2>Reference to the current connection object</h2>
<pre>$conn </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_Util::$$conn</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

897
docs/classes/ODBC.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,90 +54,39 @@
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li> <i class="icon-custom icon-method"></i> Methods
<li class="method public "><a href="#__construct" title="__construct :: Use ODBC to connect to a database"><span class="description">Use ODBC to connect to a database</span><pre>__construct()</pre></a></li> <ul>
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep() <li class="method public "><a href="#method___construct" title="__construct() :: Use ODBC to connect to a database"><span class="description">Use ODBC to connect to a database</span><pre>__construct()</pre></a></li>
</span><pre>__sleep()</pre></a></li> <li class="method public "><a href="#method_insert_batch" title="insert_batch() :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup() <li class="method public "><a href="#method_truncate" title="truncate() :: Empty the current database"><span class="description">Empty the current database</span><pre>truncate()</pre></a></li>
</span><pre>__wakeup()</pre></a></li> </ul>
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li> </li>
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
</span><pre>beginTransaction()</pre></a></li>
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
</span><pre>commit()</pre></a></li>
<li class="method public inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
</span><pre>errorCode()</pre></a></li>
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
</span><pre>errorInfo()</pre></a></li>
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
</span><pre>exec()</pre></a></li>
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
</span><pre>getAttribute()</pre></a></li>
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
</span><pre>getAvailableDrivers()</pre></a></li>
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
</span><pre>inTransaction()</pre></a></li>
<li class="method public "><a href="#insert_batch" title="insert_batch :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
</span><pre>lastInsertId()</pre></a></li>
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
</span><pre>prepare()</pre></a></li>
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
</span><pre>query()</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()
</span><pre>setAttribute()</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"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li> <i class="icon-custom icon-property"></i> Properties
<li class="property public inherited"><a href="#%24last_query" title="$last_query :: "><span class="description">$last_query</span><pre>$last_query</pre></a></li> <ul></ul>
<li class="property public inherited"><a href="#%24sql" title="$sql :: "><span class="description">$sql</span><pre>$sql</pre></a></li> </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="nav-header protected">» Protected
<li class="property public inherited"><a href="#%24util" title="$util :: "><span class="description">$util</span><pre>$util</pre></a></li> <ul><li class="property protected "><a href="#property_escape_char" title="$escape_char() :: Don't define the escape char - or define it in sub-drivers in a refactor"><span class="description"></span><pre>$escape_char</pre></a></li></ul>
<li class="nav-header protected">» Protected</li> </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 :: "><span class="description">$statement</span><pre>$statement</pre></a></li>
</ul> </ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CODBC" id="\ODBC"></a><div href="../classes/ODBC.html" class="element class"> <a id="\ODBC"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/ODBC.html">ODBC</a>
</li>
</ul>
<div class="element class">
<p class="short_description">ODBC Database Driver</p> <p class="short_description">ODBC Database Driver</p>
<div class="details"> <div class="details">
<p class="long_description"><p>For general database access for databases not specified by the main drivers</p></p> <div class="long_description">For general database access for databases not specified by the main drivers</div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -149,12 +95,12 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Use ODBC to connect to a database</h2> <h2>Use ODBC to connect to a database</h2>
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre> <pre>__construct(string $dsn, string $username, string $password, array $options) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$dsn</h4> <h4>$dsn</h4>
@ -174,457 +120,12 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse"> <a id="method_insert_batch"></a><div class="element clickable method public method_insert_batch" data-toggle="collapse" data-target=".method_insert_batch .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </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>PDO::__sleep()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__sleep()</td>
</tr>
</table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </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>PDO::__wakeup()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__wakeup()</td>
</tr>
</table>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</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::affected_rows()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
<h2>beginTransaction()
</h2>
<pre>beginTransaction() </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>PDO::beginTransaction()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::beginTransaction()</td>
</tr>
</table>
</div></div>
</div>
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
<h2>commit()
</h2>
<pre>commit() </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>PDO::commit()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::commit()</td>
</tr>
</table>
</div></div>
</div>
<a name="driver_query" id="driver_query"></a><div class="element clickable method public driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
<h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</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::driver_query()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$filtered_index</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
<h2>Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</h2>
<pre>empty_table(string $table) : mixed</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::empty_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
<h2>errorCode()
</h2>
<pre>errorCode() </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>PDO::errorCode()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::errorCode()</td>
</tr>
</table>
</div></div>
</div>
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
<h2>errorInfo()
</h2>
<pre>errorInfo() </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>PDO::errorInfo()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::errorInfo()</td>
</tr>
</table>
</div></div>
</div>
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
<h2>exec()
</h2>
<pre>exec() </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>PDO::exec()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::exec()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
<h2>getAttribute()
</h2>
<pre>getAttribute() </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>PDO::getAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
<h2>getAvailableDrivers()
</h2>
<pre>getAvailableDrivers() </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>PDO::getAvailableDrivers()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAvailableDrivers()</td>
</tr>
</table>
</div></div>
</div>
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
<h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</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::get_columns()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
<h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</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::get_dbs()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
<h2>Return list of function for the current database</h2>
<pre>get_functions() : array</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::get_functions()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
<h2>Return the last error for the current database connection</h2>
<pre>get_last_error() : 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::get_last_error()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
<h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</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::get_procedures()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
<h2>Retreives the data from a select query</h2>
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</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::get_query_data()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
<h2>Return schemas for databases that list them</h2>
<pre>get_schemas() : array</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::get_schemas()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
<h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</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::get_sequences()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
<h2>Retreives an array of non-user-created tables for
the connection/database</h2>
<pre>get_system_tables() : array</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::get_system_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
<h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</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::get_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
<h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</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::get_triggers()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
<h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</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::get_types()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
<h2>Return list of views for the current database</h2>
<pre>get_views() : array</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::get_views()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
<h2>inTransaction()
</h2>
<pre>inTransaction() </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>PDO::inTransaction()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::inTransaction()</td>
</tr>
</table>
</div></div>
</div>
<a name="insert_batch" id="insert_batch"></a><div class="element clickable method public insert_batch" data-toggle="collapse" data-target=".insert_batch .collapse">
<h2>Create sql for batch insert</h2> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -638,231 +139,12 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse">
<h2>lastInsertId()
</h2>
<pre>lastInsertId() </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>PDO::lastInsertId()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::lastInsertId()</td>
</tr>
</table>
</div></div>
</div>
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
<h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</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>see</th>
<td>\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::num_rows()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
<h2>prepare()
</h2>
<pre>prepare() </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>PDO::prepare()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::prepare()</td>
</tr>
</table>
</div></div>
</div>
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
<h2>Create and execute a prepared statement with the provided parameters</h2>
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></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::prepare_execute()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
</div></div>
</div>
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
<h2>Simplifies prepared statements for database queries</h2>
<pre>prepare_query(string $sql, array $data) : mixed</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::prepare_query()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>PDOStatement / FALSE</div>
</div></div>
</div>
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
<h2>query()
</h2>
<pre>query() </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>PDO::query()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::query()</td>
</tr>
</table>
</div></div>
</div>
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
<h2>quote()
</h2>
<pre>quote() </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>PDO::quote()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::quote()</td>
</tr>
</table>
</div></div>
</div>
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
<h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : 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_ident()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$ident</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<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(string $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>string</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>
<pre>rollBack() </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>PDO::rollBack()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::rollBack()</td>
</tr>
</table>
</div></div>
</div>
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
<h2>setAttribute()
</h2>
<pre>setAttribute() </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>PDO::setAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::setAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
<h2>Empty the current database</h2> <h2>Empty the current database</h2>
<pre>truncate(string $table) : void</pre> <pre>truncate(string $table) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -870,111 +152,13 @@ the connection/database</h2>
</div> </div>
</div></div> </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>
<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()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</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"> <a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$last_query</td>
</tr></table>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$sql</td>
</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>$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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$util</td>
</tr></table>
</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>Don't define the escape char - or define it in sub-drivers in a refactor</h2> <h2>Don't define the escape char - or define it in sub-drivers in a refactor</h2>
<pre>$escape_char </pre> <pre>$escape_char </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$statement</td>
</tr></table>
</div></div>
</div> </div>
</div> </div>
</div> </div>
@ -982,8 +166,9 @@ the connection/database</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

131
docs/classes/ODBC_SQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,32 +52,41 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<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="#method_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 "><a href="#method_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="#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="#method_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 "><a href="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</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="#method_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="#method_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 "><a href="#method_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="#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="#method_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="#method_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> <li class="method public "><a href="#method_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>
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li> <li class="method public "><a href="#method_type_list" title="type_list() :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li> <li class="method public "><a href="#method_view_list" title="view_list() :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CODBC_SQL" id="\ODBC_SQL"></a><div href="../classes/ODBC_SQL.html" class="element class"> <a id="\ODBC_SQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/ODBC_SQL.html">ODBC_SQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">ODBC SQL Class</p> <p class="short_description">ODBC SQL Class</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -89,12 +95,12 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse"> <a id="method_column_list"></a><div class="element clickable method public method_column_list" data-toggle="collapse" data-target=".method_column_list .collapse">
<h2>SQL to show infromation about columns in a table</h2> <h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : NULL</pre> <pre>column_list(string $table) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -104,32 +110,32 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse"> <a id="method_db_list"></a><div class="element clickable method public method_db_list" data-toggle="collapse" data-target=".method_db_list .collapse">
<h2>Returns sql to list other databases</h2> <h2>Returns sql to list other databases</h2>
<pre>db_list() : NULL</pre> <pre>db_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_function_list"></a><div class="element clickable method public method_function_list" data-toggle="collapse" data-target=".method_function_list .collapse">
<h2>Return sql to list functions</h2> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse">
<h2>Limit clause</h2> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -147,82 +153,82 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse">
<h2>Return sql to list stored procedures</h2> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : NULL</pre> <pre>procedure_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse"> <a id="method_sequence_list"></a><div class="element clickable method public method_sequence_list" data-toggle="collapse" data-target=".method_sequence_list .collapse">
<h2>Return sql to list sequences</h2> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : NULL</pre> <pre>sequence_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_system_table_list"></a><div class="element clickable method public method_system_table_list" data-toggle="collapse" data-target=".method_system_table_list .collapse">
<h2>Returns sql to list system tables</h2> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : NULL</pre> <pre>system_table_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse"> <a id="method_table_list"></a><div class="element clickable method public method_table_list" data-toggle="collapse" data-target=".method_table_list .collapse">
<h2>Returns sql to list tables</h2> <h2>Returns sql to list tables</h2>
<pre>table_list() : NULL</pre> <pre>table_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse"> <a id="method_trigger_list"></a><div class="element clickable method public method_trigger_list" data-toggle="collapse" data-target=".method_trigger_list .collapse">
<h2>Returns sql to list triggers</h2> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : NULL</pre> <pre>trigger_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse"> <a id="method_type_list"></a><div class="element clickable method public method_type_list" data-toggle="collapse" data-target=".method_type_list .collapse">
<h2>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : NULL</pre> <pre>type_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse"> <a id="method_view_list"></a><div class="element clickable method public method_view_list" data-toggle="collapse" data-target=".method_view_list .collapse">
<h2>Returns sql to list views</h2> <h2>Returns sql to list views</h2>
<pre>view_list() : NULL</pre> <pre>view_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
@ -233,8 +239,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

122
docs/classes/ODBC_Util.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,30 +52,34 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#backup_data" title="backup_data :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li> <li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li> <li class="method public "><a href="#method_create_table" title="create_table() :: Database-specific method to create a new table"><span class="description">Database-specific method to create a new table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Database-specific method to create a new table"><span class="description">Database-specific method to create a new table</span><pre>create_table()</pre></a></li> <li class="method public "><a href="#method_delete_table" title="delete_table() :: Remove a table from the database"><span class="description">Remove a table from the database</span><pre>delete_table()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: Remove a table from the database"><span class="description">Remove a table from the database</span><pre>delete_table()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CODBC_Util" id="\ODBC_Util"></a><div href="../classes/ODBC_Util.html" class="element class"> <a id="\ODBC_Util"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/ODBC_Util.html">ODBC_Util</a>
</li>
</ul>
<div class="element class">
<p class="short_description">ODBC-specific backup, import and creation methods</p> <p class="short_description">ODBC-specific backup, import and creation methods</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -87,66 +88,42 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) </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_Util::__call()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct(object $conn) : void</pre> <pre>__construct($conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$conn</h4></div>
<h4>$conn</h4>
<code>object</code><p>&$conn</p>
</div>
</div></div> </div></div>
</div> </div>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data() : string</pre> <pre>backup_data() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse"> <a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse">
<h2>Database-specific method to create a new table</h2> <h2>Database-specific method to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -168,12 +145,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse"> <a id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse">
<h2>Remove a table from the database</h2> <h2>Remove a table from the database</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -183,28 +160,15 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
<h2>Reference to the current connection object</h2>
<pre>$conn </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_Util::$$conn</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

915
docs/classes/PgSQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,92 +52,32 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public "><a href="#__construct" title="__construct :: Connect to a PosgreSQL database"><span class="description">Connect to a PosgreSQL database</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Connect to a PosgreSQL database"><span class="description">Connect to a PosgreSQL database</span><pre>__construct()</pre></a></li>
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep() <li class="method public "><a href="#method_get_schemas" title="get_schemas() :: Get a list of schemas for the current connection"><span class="description">Get a list of schemas for the current connection</span><pre>get_schemas()</pre></a></li>
</span><pre>__sleep()</pre></a></li> <li class="method public "><a href="#method_truncate" title="truncate() :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
</span><pre>__wakeup()</pre></a></li>
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
</span><pre>beginTransaction()</pre></a></li>
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
</span><pre>commit()</pre></a></li>
<li class="method public inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
</span><pre>errorCode()</pre></a></li>
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
</span><pre>errorInfo()</pre></a></li>
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
</span><pre>exec()</pre></a></li>
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
</span><pre>getAttribute()</pre></a></li>
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
</span><pre>getAvailableDrivers()</pre></a></li>
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public "><a href="#get_schemas" title="get_schemas :: Get a list of schemas for the current connection"><span class="description">Get a list of schemas for the current connection</span><pre>get_schemas()</pre></a></li>
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
</span><pre>inTransaction()</pre></a></li>
<li class="method public inherited"><a href="#insert_batch" title="insert_batch :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
</span><pre>lastInsertId()</pre></a></li>
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
</span><pre>prepare()</pre></a></li>
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
</span><pre>query()</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()
</span><pre>setAttribute()</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 :: "><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 :: "><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> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CPgSQL" id="\PgSQL"></a><div href="../classes/PgSQL.html" class="element class"> <a id="\PgSQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/PgSQL.html">PgSQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">PostgreSQL specifc class</p> <p class="short_description">PostgreSQL specifc class</p>
<div class="details"> <div class="details">
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p> <div class="long_description">Extends PDO to simplify cross-database issues</div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -149,12 +86,12 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Connect to a PosgreSQL database</h2> <h2>Connect to a PosgreSQL database</h2>
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre> <pre>__construct(string $dsn, string $username, string $password, array $options) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$dsn</h4> <h4>$dsn</h4>
@ -174,695 +111,22 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse"> <a id="method_get_schemas"></a><div class="element clickable method public method_get_schemas" data-toggle="collapse" data-target=".method_get_schemas .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </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>PDO::__sleep()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__sleep()</td>
</tr>
</table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </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>PDO::__wakeup()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__wakeup()</td>
</tr>
</table>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</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::affected_rows()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
<h2>beginTransaction()
</h2>
<pre>beginTransaction() </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>PDO::beginTransaction()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::beginTransaction()</td>
</tr>
</table>
</div></div>
</div>
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
<h2>commit()
</h2>
<pre>commit() </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>PDO::commit()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::commit()</td>
</tr>
</table>
</div></div>
</div>
<a name="driver_query" id="driver_query"></a><div class="element clickable method public driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
<h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</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::driver_query()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$filtered_index</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
<h2>Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</h2>
<pre>empty_table(string $table) : mixed</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::empty_table()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
<h2>errorCode()
</h2>
<pre>errorCode() </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>PDO::errorCode()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::errorCode()</td>
</tr>
</table>
</div></div>
</div>
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
<h2>errorInfo()
</h2>
<pre>errorInfo() </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>PDO::errorInfo()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::errorInfo()</td>
</tr>
</table>
</div></div>
</div>
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
<h2>exec()
</h2>
<pre>exec() </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>PDO::exec()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::exec()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
<h2>getAttribute()
</h2>
<pre>getAttribute() </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>PDO::getAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
<h2>getAvailableDrivers()
</h2>
<pre>getAvailableDrivers() </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>PDO::getAvailableDrivers()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::getAvailableDrivers()</td>
</tr>
</table>
</div></div>
</div>
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
<h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</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::get_columns()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
<h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</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::get_dbs()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
<h2>Return list of function for the current database</h2>
<pre>get_functions() : array</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::get_functions()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
<h2>Return the last error for the current database connection</h2>
<pre>get_last_error() : 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::get_last_error()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
<h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</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::get_procedures()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
<h2>Retreives the data from a select query</h2>
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</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::get_query_data()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
<h2>Get a list of schemas for the current connection</h2> <h2>Get a list of schemas for the current connection</h2>
<pre>get_schemas() : array</pre> <pre>get_schemas() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse">
<h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</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::get_sequences()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
<h2>Retreives an array of non-user-created tables for
the connection/database</h2>
<pre>get_system_tables() : array</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::get_system_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
<h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</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::get_tables()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
<h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</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::get_triggers()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
<h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</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::get_types()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
<h2>Return list of views for the current database</h2>
<pre>get_views() : array</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::get_views()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
<h2>inTransaction()
</h2>
<pre>inTransaction() </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>PDO::inTransaction()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::inTransaction()</td>
</tr>
</table>
</div></div>
</div>
<a name="insert_batch" id="insert_batch"></a><div class="element clickable method public insert_batch" data-toggle="collapse" data-target=".insert_batch .collapse">
<h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : 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::insert_batch()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
<h2>lastInsertId()
</h2>
<pre>lastInsertId() </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>PDO::lastInsertId()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::lastInsertId()</td>
</tr>
</table>
</div></div>
</div>
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
<h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</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>see</th>
<td>\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::num_rows()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
<h2>prepare()
</h2>
<pre>prepare() </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>PDO::prepare()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::prepare()</td>
</tr>
</table>
</div></div>
</div>
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
<h2>Create and execute a prepared statement with the provided parameters</h2>
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></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::prepare_execute()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
</div></div>
</div>
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
<h2>Simplifies prepared statements for database queries</h2>
<pre>prepare_query(string $sql, array $data) : mixed</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::prepare_query()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>PDOStatement / FALSE</div>
</div></div>
</div>
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
<h2>query()
</h2>
<pre>query() </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>PDO::query()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::query()</td>
</tr>
</table>
</div></div>
</div>
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
<h2>quote()
</h2>
<pre>quote() </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>PDO::quote()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::quote()</td>
</tr>
</table>
</div></div>
</div>
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
<h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : 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_ident()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$ident</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<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(string $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>string</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>
<pre>rollBack() </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>PDO::rollBack()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::rollBack()</td>
</tr>
</table>
</div></div>
</div>
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
<h2>setAttribute()
</h2>
<pre>setAttribute() </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>PDO::setAttribute()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::setAttribute()</td>
</tr>
</table>
</div></div>
</div>
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
<h2>Empty a table</h2> <h2>Empty a table</h2>
<pre>truncate(string $table) : void</pre> <pre>truncate(string $table) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -870,126 +134,15 @@ the connection/database</h2>
</div> </div>
</div></div> </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>
<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()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<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</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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$last_query</td>
</tr></table>
</div></div>
</div>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$sql</td>
</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>$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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$util</td>
</tr></table>
</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>$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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$escape_char</td>
</tr></table>
</div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<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>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::$$statement</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

131
docs/classes/PgSQL_SQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,32 +52,41 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<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="#method_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 "><a href="#method_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="#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="#method_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 "><a href="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</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="#method_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="#method_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 "><a href="#method_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="#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="#method_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="#method_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> <li class="method public "><a href="#method_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>
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li> <li class="method public "><a href="#method_type_list" title="type_list() :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li> <li class="method public "><a href="#method_view_list" title="view_list() :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CPgSQL_SQL" id="\PgSQL_SQL"></a><div href="../classes/PgSQL_SQL.html" class="element class"> <a id="\PgSQL_SQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/PgSQL_SQL.html">PgSQL_SQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">PostgreSQL specifc SQL</p> <p class="short_description">PostgreSQL specifc SQL</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -89,12 +95,12 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse"> <a id="method_column_list"></a><div class="element clickable method public method_column_list" data-toggle="collapse" data-target=".method_column_list .collapse">
<h2>Return sql to list columns of the specified table</h2> <h2>Return sql to list columns of the specified table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -104,32 +110,32 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse"> <a id="method_db_list"></a><div class="element clickable method public method_db_list" data-toggle="collapse" data-target=".method_db_list .collapse">
<h2>Returns sql to list other databases</h2> <h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre> <pre>db_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_function_list"></a><div class="element clickable method public method_function_list" data-toggle="collapse" data-target=".method_function_list .collapse">
<h2>Return sql to list functions</h2> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse">
<h2>Limit clause</h2> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -147,82 +153,82 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse">
<h2>Return sql to list stored procedures</h2> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse"> <a id="method_sequence_list"></a><div class="element clickable method public method_sequence_list" data-toggle="collapse" data-target=".method_sequence_list .collapse">
<h2>Return sql to list sequences</h2> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre> <pre>sequence_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_system_table_list"></a><div class="element clickable method public method_system_table_list" data-toggle="collapse" data-target=".method_system_table_list .collapse">
<h2>Returns sql to list system tables</h2> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse"> <a id="method_table_list"></a><div class="element clickable method public method_table_list" data-toggle="collapse" data-target=".method_table_list .collapse">
<h2>Returns sql to list tables</h2> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse"> <a id="method_trigger_list"></a><div class="element clickable method public method_trigger_list" data-toggle="collapse" data-target=".method_trigger_list .collapse">
<h2>Returns sql to list triggers</h2> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse"> <a id="method_type_list"></a><div class="element clickable method public method_type_list" data-toggle="collapse" data-target=".method_type_list .collapse">
<h2>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : string</pre> <pre>type_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse"> <a id="method_view_list"></a><div class="element clickable method public method_view_list" data-toggle="collapse" data-target=".method_view_list .collapse">
<h2>Returns sql to list views</h2> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
@ -233,8 +239,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

122
docs/classes/PgSQL_Util.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,30 +52,34 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#backup_data" title="backup_data :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li> <li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li> <li class="method public "><a href="#method_create_table" title="create_table() :: Database-specific method to create a new table"><span class="description">Database-specific method to create a new table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Database-specific method to create a new table"><span class="description">Database-specific method to create a new table</span><pre>create_table()</pre></a></li> <li class="method public "><a href="#method_delete_table" title="delete_table() :: Database-specific SQL for dropping a table"><span class="description">Database-specific SQL for dropping a table</span><pre>delete_table()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: Database-specific SQL for dropping a table"><span class="description">Database-specific SQL for dropping a table</span><pre>delete_table()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CPgSQL_Util" id="\PgSQL_Util"></a><div href="../classes/PgSQL_Util.html" class="element class"> <a id="\PgSQL_Util"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/PgSQL_Util.html">PgSQL_Util</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Posgres-specific backup, import and creation methods</p> <p class="short_description">Posgres-specific backup, import and creation methods</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -87,46 +88,22 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) </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_Util::__call()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct(object $conn) : void</pre> <pre>__construct($conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$conn</h4></div>
<h4>$conn</h4>
<code>object</code><p>&$conn</p>
</div>
</div></div> </div></div>
</div> </div>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $exclude) : string</pre> <pre>backup_data(array $exclude) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$exclude</h4> <h4>$exclude</h4>
@ -136,22 +113,22 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse"> <a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse">
<h2>Database-specific method to create a new table</h2> <h2>Database-specific method to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -173,12 +150,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse"> <a id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse">
<h2>Database-specific SQL for dropping a table</h2> <h2>Database-specific SQL for dropping a table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -188,28 +165,15 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
<h2>Reference to the current connection object</h2>
<pre>$conn </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_Util::$$conn</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

716
docs/classes/Query_Builder.html
View File

File diff suppressed because it is too large Load Diff

349
docs/classes/Query_Builder_Base.html
View File

@ -1,349 +0,0 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » \Query_Builder_Base</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">23</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>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<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="#__call" title="__call :: Calls a function further down the inheritence chain"><span class="description">Calls a function further down the inheritence chain</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Empty base constructor"><span class="description">Empty base constructor</span><pre>__construct()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><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 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="method protected "><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 protected "><a href="#_like" title="_like :: Simplify 'like' methods"><span class="description">Simplify 'like' methods</span><pre>_like()</pre></a></li>
<li class="method protected "><a href="#_run" title="_run :: Executes the compiled query"><span class="description">Executes the compiled query</span><pre>_run()</pre></a></li>
<li class="method protected "><a href="#_select" title="_select :: Method to simplify select_ methods"><span class="description">Method to simplify select_ methods</span><pre>_select()</pre></a></li>
<li class="method protected "><a href="#_where" title="_where :: Do all the repeditive stuff for where/having type methods"><span class="description">Do all the repeditive stuff for where/having type methods</span><pre>_where()</pre></a></li>
<li class="method protected "><a href="#_where_in" title="_where_in :: Simplify where_in methods"><span class="description">Simplify where_in methods</span><pre>_where_in()</pre></a></li>
<li class="method protected "><a href="#_where_string" title="_where_string :: Simplify generating where string"><span class="description">Simplify generating where string</span><pre>_where_string()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CQuery_Builder_Base" id="\Query_Builder_Base"></a><div href="../classes/Query_Builder_Base.html" class="element class">
<p class="short_description">Base class for Query Bulder - Encapsulates protected methods</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
<h2>Calls a function further down the inheritence chain</h2>
<pre>__call(string $name, array $params) : mixed</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>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Empty base constructor</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="_compile" id="_compile"></a><div class="element clickable method protected _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="_get_compile" id="_get_compile"></a><div class="element clickable method protected _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>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>resturn</th>
<td>string</td>
</tr></table>
<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>
<div class="subelement argument">
<h4>$reset</h4>
<code></code><p>bool</p></div>
</div></div>
</div>
<a name="_having" id="_having"></a><div class="element clickable method protected _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_Base.html">\Query_Builder_Base</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$conj</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder_Base.html">\Query_Builder_Base</a></code></div>
</div></div>
</div>
<a name="_like" id="_like"></a><div class="element clickable method protected _like" data-toggle="collapse" data-target="._like .collapse">
<h2>Simplify 'like' methods</h2>
<pre>_like(string $field, mixed $val, string $pos, string $like, string $conj) : <a href="../classes/Query_Builder_Base.html">\Query_Builder_Base</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$pos</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$like</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$conj</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder_Base.html">\Query_Builder_Base</a></code></div>
</div></div>
</div>
<a name="_run" id="_run"></a><div class="element clickable method protected _run" data-toggle="collapse" data-target="._run .collapse">
<h2>Executes the compiled query</h2>
<pre>_run(string $type, string $table, bool $simple) : mixed</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>
<div class="subelement argument">
<h4>$simple</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="_select" id="_select"></a><div class="element clickable method protected _select" data-toggle="collapse" data-target="._select .collapse">
<h2>Method to simplify select_ methods</h2>
<pre>_select(string $field, string $as) : 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>$field</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$as</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="_where" id="_where"></a><div class="element clickable method protected _where" data-toggle="collapse" data-target="._where .collapse">
<h2>Do all the repeditive stuff for where/having type methods</h2>
<pre>_where(mixed $key, mixed $val) : array</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>$key</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="_where_in" id="_where_in"></a><div class="element clickable method protected _where_in" data-toggle="collapse" data-target="._where_in .collapse">
<h2>Simplify where_in methods</h2>
<pre>_where_in(mixed $key, mixed $val, $in, $conj) : <a href="../classes/Query_Builder_Base.html">\Query_Builder_Base</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$in</h4>
<code></code><p>string</p></div>
<div class="subelement argument">
<h4>$conj</h4>
<code></code><p>string</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder_Base.html">\Query_Builder_Base</a></code></div>
</div></div>
</div>
<a name="_where_string" id="_where_string"></a><div class="element clickable method protected _where_string" data-toggle="collapse" data-target="._where_string .collapse">
<h2>Simplify generating where string</h2>
<pre>_where_string(mixed $key, mixed $val, string $conj) : <a href="../classes/Query_Builder_Base.html">\Query_Builder_Base</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$conj</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder_Base.html">\Query_Builder_Base</a></code></div>
</div></div>
</div>
</div>
</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-11-09T15:10:09-05:00.<br></footer></div>
</div>
</body>
</html>

90
docs/classes/Query_Parser.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,27 +54,41 @@
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li> <i class="icon-custom icon-method"></i> Methods
<li class="method public "><a href="#__construct" title="__construct :: Constructor/entry point into parser"><span class="description">Constructor/entry point into parser</span><pre>__construct()</pre></a></li> <ul>
<li class="method public "><a href="#parse_join" title="parse_join :: Public parser method for seting the parse string"><span class="description">Public parser method for seting the parse string</span><pre>parse_join()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Constructor/entry point into parser"><span class="description">Constructor/entry point into parser</span><pre>__construct()</pre></a></li>
<li class="nav-header private">» Private</li> <li class="method public "><a href="#method_parse_join" title="parse_join() :: Public parser method for seting the parse string"><span class="description">Public parser method for seting the parse string</span><pre>parse_join()</pre></a></li>
<li class="method private "><a href="#filter_array" title="filter_array :: Returns a more useful match array"><span class="description">Returns a more useful match array</span><pre>filter_array()</pre></a></li> </ul>
</li>
<li class="nav-header private">» Private
<ul><li class="method private "><a href="#method_filter_array" title="filter_array() :: Returns a more useful match array"><span class="description">Returns a more useful match array</span><pre>filter_array()</pre></a></li></ul>
</li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li> <i class="icon-custom icon-property"></i> Properties
<li class="property public "><a href="#%24matches" title="$matches :: Regex matches"><span class="description">Regex matches</span><pre>$matches</pre></a></li> <ul><li class="property public "><a href="#property_matches" title="$matches() :: Regex matches"><span class="description"></span><pre>$matches</pre></a></li></ul>
<li class="nav-header private">» Private</li> </li>
<li class="property private "><a href="#%24match_patterns" title="$match_patterns :: Regex patterns for various syntax components"><span class="description">Regex patterns for various syntax components</span><pre>$match_patterns</pre></a></li> <li class="nav-header private">» Private
<ul><li class="property private "><a href="#property_match_patterns" title="$match_patterns() :: Regex patterns for various syntax components"><span class="description"></span><pre>$match_patterns</pre></a></li></ul>
</li>
</ul> </ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CQuery_Parser" id="\Query_Parser"></a><div href="../classes/Query_Parser.html" class="element class"> <a id="\Query_Parser"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Query_Parser.html">Query_Parser</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p> <p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td> <td><a href="../packages/Query.Query.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -86,57 +97,51 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Constructor/entry point into parser</h2> <h2>Constructor/entry point into parser</h2>
<pre>__construct($sql) </pre> <pre>__construct($sql) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$sql</h4></div>
<h4>$sql</h4>
<code></code><p>string</p></div>
</div></div> </div></div>
</div> </div>
<a name="parse_join" id="parse_join"></a><div class="element clickable method public parse_join" data-toggle="collapse" data-target=".parse_join .collapse"> <a id="method_parse_join"></a><div class="element clickable method public method_parse_join" data-toggle="collapse" data-target=".method_parse_join .collapse">
<h2>Public parser method for seting the parse string</h2> <h2>Public parser method for seting the parse string</h2>
<pre>parse_join($sql) </pre> <pre>parse_join($sql) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$sql</h4></div>
<h4>$sql</h4>
<code></code><p>string</p></div>
</div></div> </div></div>
</div> </div>
<a name="filter_array" id="filter_array"></a><div class="element clickable method private filter_array" data-toggle="collapse" data-target=".filter_array .collapse"> <a id="method_filter_array"></a><div class="element clickable method private method_filter_array" data-toggle="collapse" data-target=".method_filter_array .collapse">
<h2>Returns a more useful match array</h2> <h2>Returns a more useful match array</h2>
<pre>filter_array($array) : array</pre> <pre>filter_array($array) : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$array</h4></div>
<h4>$array</h4>
<code></code><p>array</p></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24matches" id="$matches"> </a><div class="element clickable property public $matches" data-toggle="collapse" data-target=".$matches .collapse"> <a id="property_matches"> </a><div class="element clickable property public property_matches" data-toggle="collapse" data-target=".property_matches .collapse">
<h2>Regex matches</h2> <h2>Regex matches</h2>
<pre>$matches : array</pre> <pre>$matches : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="%24match_patterns" id="$match_patterns"> </a><div class="element clickable property private $match_patterns" data-toggle="collapse" data-target=".$match_patterns .collapse"> <a id="property_match_patterns"> </a><div class="element clickable property private property_match_patterns" data-toggle="collapse" data-target=".property_match_patterns .collapse">
<h2>Regex patterns for various syntax components</h2> <h2>Regex patterns for various syntax components</h2>
<pre>$match_patterns : array</pre> <pre>$match_patterns : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
</div> </div>
</div> </div>
@ -144,8 +149,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

900
docs/classes/SQLite.html
View File

File diff suppressed because it is too large Load Diff

131
docs/classes/SQLite_SQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,32 +52,41 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<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="#method_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 "><a href="#method_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="#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="#method_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 "><a href="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</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="#method_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="#method_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 "><a href="#method_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="#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="#method_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="#method_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> <li class="method public "><a href="#method_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>
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li> <li class="method public "><a href="#method_type_list" title="type_list() :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li> <li class="method public "><a href="#method_view_list" title="view_list() :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CSQLite_SQL" id="\SQLite_SQL"></a><div href="../classes/SQLite_SQL.html" class="element class"> <a id="\SQLite_SQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/SQLite_SQL.html">SQLite_SQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">SQLite Specific SQL</p> <p class="short_description">SQLite Specific SQL</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -89,12 +95,12 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse"> <a id="method_column_list"></a><div class="element clickable method public method_column_list" data-toggle="collapse" data-target=".method_column_list .collapse">
<h2>SQL to show infromation about columns in a table</h2> <h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -104,32 +110,32 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse"> <a id="method_db_list"></a><div class="element clickable method public method_db_list" data-toggle="collapse" data-target=".method_db_list .collapse">
<h2>Returns sql to list other databases</h2> <h2>Returns sql to list other databases</h2>
<pre>db_list() : NULL</pre> <pre>db_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_function_list"></a><div class="element clickable method public method_function_list" data-toggle="collapse" data-target=".method_function_list .collapse">
<h2>Return sql to list functions</h2> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse">
<h2>Limit clause</h2> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$sql</h4> <h4>$sql</h4>
@ -147,82 +153,82 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse">
<h2>Return sql to list stored procedures</h2> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : NULL</pre> <pre>procedure_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse"> <a id="method_sequence_list"></a><div class="element clickable method public method_sequence_list" data-toggle="collapse" data-target=".method_sequence_list .collapse">
<h2>Return sql to list sequences</h2> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : NULL</pre> <pre>sequence_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_system_table_list"></a><div class="element clickable method public method_system_table_list" data-toggle="collapse" data-target=".method_system_table_list .collapse">
<h2>Overridden in SQLite class</h2> <h2>Overridden in SQLite class</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse"> <a id="method_table_list"></a><div class="element clickable method public method_table_list" data-toggle="collapse" data-target=".method_table_list .collapse">
<h2>Returns sql to list tables</h2> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse"> <a id="method_trigger_list"></a><div class="element clickable method public method_trigger_list" data-toggle="collapse" data-target=".method_trigger_list .collapse">
<h2>Returns sql to list triggers</h2> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : NULL</pre> <pre>trigger_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse"> <a id="method_type_list"></a><div class="element clickable method public method_type_list" data-toggle="collapse" data-target=".method_type_list .collapse">
<h2>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : array</pre> <pre>type_list() : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse"> <a id="method_view_list"></a><div class="element clickable method public method_view_list" data-toggle="collapse" data-target=".method_view_list .collapse">
<h2>Returns sql to list views</h2> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
@ -233,8 +239,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

122
docs/classes/SQLite_Util.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,30 +52,34 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#backup_data" title="backup_data :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li> <li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li> <li class="method public "><a href="#method_create_table" title="create_table() :: Convenience public function to create a new table"><span class="description">Convenience public function to create a new table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Convenience public function to create a new table"><span class="description">Convenience public function to create a new table</span><pre>create_table()</pre></a></li> <li class="method public "><a href="#method_delete_table" title="delete_table() :: SQL to drop the specified table"><span class="description">SQL to drop the specified table</span><pre>delete_table()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: SQL to drop the specified table"><span class="description">SQL to drop the specified table</span><pre>delete_table()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CSQLite_Util" id="\SQLite_Util"></a><div href="../classes/SQLite_Util.html" class="element class"> <a id="\SQLite_Util"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/SQLite_Util.html">SQLite_Util</a>
</li>
</ul>
<div class="element class">
<p class="short_description">SQLite-specific backup, import and creation methods</p> <p class="short_description">SQLite-specific backup, import and creation methods</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td> <td><a href="../packages/Query.Drivers.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -87,46 +88,22 @@
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) </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_Util::__call()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct(object $conn) : void</pre> <pre>__construct($conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$conn</h4></div>
<h4>$conn</h4>
<code>object</code><p>&$conn</p>
</div>
</div></div> </div></div>
</div> </div>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $excluded) : string</pre> <pre>backup_data(array $excluded) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$excluded</h4> <h4>$excluded</h4>
@ -136,22 +113,22 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse"> <a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse">
<h2>Convenience public function to create a new table</h2> <h2>Convenience public function to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -173,12 +150,12 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse"> <a id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse">
<h2>SQL to drop the specified table</h2> <h2>SQL to drop the specified table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
@ -188,28 +165,15 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
<h2>Reference to the current connection object</h2>
<pre>$conn </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_Util::$$conn</td>
</tr></table>
</div></div>
</div>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

417
docs/classes/iDB_PDO.html
View File

@ -1,417 +0,0 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » \iDB_PDO</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">23</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<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="#__construct" title="__construct :: PDO constructor wrapper"><span class="description">PDO constructor wrapper</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public "><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public "><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
<li class="method public "><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public "><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public "><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public "><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public "><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public "><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public "><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
<li class="method public "><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public "><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public "><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public "><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public "><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public "><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public "><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
<li class="method public "><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</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="#truncate" title="truncate :: Empty the passed table"><span class="description">Empty the passed table</span><pre>truncate()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CiDB_PDO" id="\iDB_PDO"></a><div href="../classes/iDB_PDO.html" class="element interface">
<p class="short_description">Base Database class</p>
<div class="details">
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>PDO constructor wrapper</h2>
<pre>__construct(string $dsn) </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>$dsn</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</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>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="driver_query" id="driver_query"></a><div class="element clickable method public driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
<h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</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>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$filtered_index</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
<h2>Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</h2>
<pre>empty_table(string $table) : mixed</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>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
<h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</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>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
<h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</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>array</code></div>
</div></div>
</div>
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
<h2>Return list of function for the current database</h2>
<pre>get_functions() : array</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>array</code></div>
</div></div>
</div>
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
<h2>Return the last error for the current database connection</h2>
<pre>get_last_error() : 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="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
<h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</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>array</code></div>
</div></div>
</div>
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
<h2>Retreives the data from a select query</h2>
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</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>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
<h2>Return schemas for databases that list them</h2>
<pre>get_schemas() : array</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>array</code></div>
</div></div>
</div>
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
<h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</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>array</code></div>
</div></div>
</div>
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
<h2>Retreives an array of non-user-created tables for
the connection/database</h2>
<pre>get_system_tables() : array</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>array</code></div>
</div></div>
</div>
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
<h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</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>array</code></div>
</div></div>
</div>
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
<h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</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>array</code></div>
</div></div>
</div>
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
<h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</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>array</code></div>
</div></div>
</div>
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
<h2>Return list of views for the current database</h2>
<pre>get_views() : array</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>array</code></div>
</div></div>
</div>
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
<h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>see</th>
<td>\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
<h2>Create and execute a prepared statement with the provided parameters</h2>
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></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>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
</div></div>
</div>
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
<h2>Simplifies prepared statements for database queries</h2>
<pre>prepare_query(string $sql, array $data) : mixed</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>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>PDOStatement / FALSE</div>
</div></div>
</div>
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
<h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : 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>$ident</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<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(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>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
<h2>Empty the passed table</h2>
<pre>truncate(string $table) : void</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>string</code>
</div>
</div></div>
</div>
</div>
</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-12-18T16:02:48-05:00.<br></footer></div>
</div>
</body>
</html>

135
docs/classes/iDB_SQL.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,34 +52,43 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public "><a href="#column_list" title="column_list :: Get information about the columns in the <li class="method public "><a href="#method_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 class="description">Get information about the columns in the
specified table</span><pre>column_list()</pre></a></li> 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="#method_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="#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="#method_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="#method_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="#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="#method_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="#method_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="#method_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="#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="#method_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="#method_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> <li class="method public "><a href="#method_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>
<li class="method public "><a href="#type_list" title="type_list :: Return sql to list database field types"><span class="description">Return sql to list database field types</span><pre>type_list()</pre></a></li> <li class="method public "><a href="#method_type_list" title="type_list() :: Return sql to list database field types"><span class="description">Return sql to list database field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li> <li class="method public "><a href="#method_view_list" title="view_list() :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CiDB_SQL" id="\iDB_SQL"></a><div href="../classes/iDB_SQL.html" class="element interface"> <a id="\iDB_SQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/iDB_SQL.html">iDB_SQL</a>
</li>
</ul>
<div class="element interface">
<p class="short_description">parent for database manipulation subclasses</p> <p class="short_description">parent for database manipulation subclasses</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td> <td><a href="../packages/Query.Query.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -91,47 +97,45 @@ specified table</span><pre>column_list()</pre></a></li>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse"> <a id="method_column_list"></a><div class="element clickable method public method_column_list" data-toggle="collapse" data-target=".method_column_list .collapse">
<h2>Get information about the columns in the <h2>Get information about the columns in the
specified table</h2> specified table</h2>
<pre>column_list($table) : string</pre> <pre>column_list($table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$table</h4></div>
<h4>$table</h4>
<code></code><p>string</p></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse"> <a id="method_db_list"></a><div class="element clickable method public method_db_list" data-toggle="collapse" data-target=".method_db_list .collapse">
<h2>Returns sql to list other databases</h2> <h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre> <pre>db_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_function_list"></a><div class="element clickable method public method_function_list" data-toggle="collapse" data-target=".method_function_list .collapse">
<h2>Return sql to list functions</h2> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse">
<h2>Get database specific sql for limit clause</h2> <h2>Get database specific sql for limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>abstract</th> <th>abstract</th>
<td></td> <td></td>
@ -153,22 +157,22 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse">
<h2>Return sql to list stored procedures</h2> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse">
<h2>Get the sql for random ordering</h2> <h2>Get the sql for random ordering</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>abstract</th> <th>abstract</th>
<td></td> <td></td>
@ -177,62 +181,62 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse"> <a id="method_sequence_list"></a><div class="element clickable method public method_sequence_list" data-toggle="collapse" data-target=".method_sequence_list .collapse">
<h2>Return sql to list sequences</h2> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre> <pre>sequence_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_system_table_list"></a><div class="element clickable method public method_system_table_list" data-toggle="collapse" data-target=".method_system_table_list .collapse">
<h2>Returns sql to list system tables</h2> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse"> <a id="method_table_list"></a><div class="element clickable method public method_table_list" data-toggle="collapse" data-target=".method_table_list .collapse">
<h2>Returns sql to list tables</h2> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse"> <a id="method_trigger_list"></a><div class="element clickable method public method_trigger_list" data-toggle="collapse" data-target=".method_trigger_list .collapse">
<h2>Returns sql to list triggers</h2> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse"> <a id="method_type_list"></a><div class="element clickable method public method_type_list" data-toggle="collapse" data-target=".method_type_list .collapse">
<h2>Return sql to list database field types</h2> <h2>Return sql to list database field types</h2>
<pre>type_list() : mixed</pre> <pre>type_list() : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse"> <a id="method_view_list"></a><div class="element clickable method public method_view_list" data-toggle="collapse" data-target=".method_view_list .collapse">
<h2>Returns sql to list views</h2> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
@ -243,8 +247,9 @@ specified table</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

172
docs/classes/iDB_Util.html
View File

@ -1,172 +0,0 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » \iDB_Util</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">23</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<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="#backup_data" title="backup_data :: Return an SQL file with the database data as insert statements"><span class="description">Return an SQL file with the database data as insert statements</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Return an SQL file with the database table structure"><span class="description">Return an SQL file with the database table structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Get database-specific sql to create a new table"><span class="description">Get database-specific sql to create a new table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: Get database-specific sql to drop a table"><span class="description">Get database-specific sql to drop a table</span><pre>delete_table()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CiDB_Util" id="\iDB_Util"></a><div href="../classes/iDB_Util.html" class="element interface">
<p class="short_description">Interface defining database / table creation methods</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
<h2>Return an SQL file with the database data as insert statements</h2>
<pre>backup_data() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
<h2>Return an SQL file with the database table structure</h2>
<pre>backup_structure() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
<h2>Get database-specific sql to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$columns</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$constraints</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$indexes</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
<h2>Get database-specific sql to drop a table</h2>
<pre>delete_table(string $name) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
</div>
</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-12-18T16:15:17-05:00.<br></footer></div>
</div>
</body>
</html>

85
docs/classes/iPDO.html
View File

@ -1,85 +0,0 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » \iPDO</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">23</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list"></ul>
</div>
<div class="span8">
<a name="%5CiPDO" id="\iPDO"></a><div href="../classes/iPDO.html" class="element interface">
<p class="short_description">Another interface, just for more fun</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
</div>
</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-12-18T16:02:48-05:00.<br></footer></div>
</div>
</body>
</html>

468
docs/classes/iQuery_Builder.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -55,72 +52,81 @@
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div> </div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list"><li class="nav-header">
<li class="nav-header"> <i class="icon-custom icon-method"></i> Methods
<i class="icon-custom icon-method"></i> Methods</li> <ul>
<li class="method public "><a href="#count_all" title="count_all :: Retreive the number of rows in the selected table"><span class="description">Retreive the number of rows in the selected table</span><pre>count_all()</pre></a></li> <li class="method public "><a href="#method_count_all" title="count_all() :: Retreive the number of rows in the selected table"><span class="description">Retreive the number of rows in the selected table</span><pre>count_all()</pre></a></li>
<li class="method public "><a href="#count_all_results" title="count_all_results :: Retrieve the number of results for the generated query - used <li class="method public "><a href="#method_count_all_results" title="count_all_results() :: Retrieve the number of results for the generated query - used
in place of the get() method"><span class="description">Retrieve the number of results for the generated query - used in place of the get() method"><span class="description">Retrieve the number of results for the generated query - used
in place of the get() method</span><pre>count_all_results()</pre></a></li> in place of the get() method</span><pre>count_all_results()</pre></a></li>
<li class="method public "><a href="#delete" title="delete :: Deletes data from a table"><span class="description">Deletes data from a table</span><pre>delete()</pre></a></li> <li class="method public "><a href="#method_delete" title="delete() :: Deletes data from a table"><span class="description">Deletes data from a table</span><pre>delete()</pre></a></li>
<li class="method public "><a href="#distinct" title="distinct :: Adds the 'distinct' keyword to a query"><span class="description">Adds the 'distinct' keyword to a query</span><pre>distinct()</pre></a></li> <li class="method public "><a href="#method_distinct" title="distinct() :: Adds the 'distinct' keyword to a query"><span class="description">Adds the 'distinct' keyword to a query</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#from" title="from :: Specify the database table to select from"><span class="description">Specify the database table to select from</span><pre>from()</pre></a></li> <li class="method public "><a href="#method_from" title="from() :: Specify the database table to select from"><span class="description">Specify the database table to select from</span><pre>from()</pre></a></li>
<li class="method public "><a href="#get" title="get :: Select and retrieve all records from the current table, and/or <li class="method public "><a href="#method_get" title="get() :: Select and retrieve all records from the current table, and/or
execute current compiled query"><span class="description">Select and retrieve all records from the current table, and/or execute current compiled query"><span class="description">Select and retrieve all records from the current table, and/or
execute current compiled query</span><pre>get()</pre></a></li> execute current compiled query</span><pre>get()</pre></a></li>
<li class="method public "><a href="#get_compiled_delete" title="get_compiled_delete :: Returns the generated 'delete' sql query"><span class="description">Returns the generated 'delete' sql query</span><pre>get_compiled_delete()</pre></a></li> <li class="method public "><a href="#method_get_compiled_delete" title="get_compiled_delete() :: Returns the generated 'delete' sql query"><span class="description">Returns the generated 'delete' sql query</span><pre>get_compiled_delete()</pre></a></li>
<li class="method public "><a href="#get_compiled_insert" title="get_compiled_insert :: Returns the generated 'insert' sql query"><span class="description">Returns the generated 'insert' sql query</span><pre>get_compiled_insert()</pre></a></li> <li class="method public "><a href="#method_get_compiled_insert" title="get_compiled_insert() :: Returns the generated 'insert' sql query"><span class="description">Returns the generated 'insert' sql query</span><pre>get_compiled_insert()</pre></a></li>
<li class="method public "><a href="#get_compiled_select" title="get_compiled_select :: Returns the generated 'select' sql query"><span class="description">Returns the generated 'select' sql query</span><pre>get_compiled_select()</pre></a></li> <li class="method public "><a href="#method_get_compiled_select" title="get_compiled_select() :: Returns the generated 'select' sql query"><span class="description">Returns the generated 'select' sql query</span><pre>get_compiled_select()</pre></a></li>
<li class="method public "><a href="#get_compiled_update" title="get_compiled_update :: Returns the generated 'update' sql query"><span class="description">Returns the generated 'update' sql query</span><pre>get_compiled_update()</pre></a></li> <li class="method public "><a href="#method_get_compiled_update" title="get_compiled_update() :: Returns the generated 'update' sql query"><span class="description">Returns the generated 'update' sql query</span><pre>get_compiled_update()</pre></a></li>
<li class="method public "><a href="#get_where" title="get_where :: Convience method for get() with a where clause"><span class="description">Convience method for get() with a where clause</span><pre>get_where()</pre></a></li> <li class="method public "><a href="#method_get_where" title="get_where() :: Convience method for get() with a where clause"><span class="description">Convience method for get() with a where clause</span><pre>get_where()</pre></a></li>
<li class="method public "><a href="#group_by" title="group_by :: Group the results by the selected field(s)"><span class="description">Group the results by the selected field(s)</span><pre>group_by()</pre></a></li> <li class="method public "><a href="#method_group_by" title="group_by() :: Group the results by the selected field(s)"><span class="description">Group the results by the selected field(s)</span><pre>group_by()</pre></a></li>
<li class="method public "><a href="#group_end" title="group_end :: Ends a query group"><span class="description">Ends a query group</span><pre>group_end()</pre></a></li> <li class="method public "><a href="#method_group_end" title="group_end() :: Ends a query group"><span class="description">Ends a query group</span><pre>group_end()</pre></a></li>
<li class="method public "><a href="#group_start" title="group_start :: Adds a paren to the current query for query grouping"><span class="description">Adds a paren to the current query for query grouping</span><pre>group_start()</pre></a></li> <li class="method public "><a href="#method_group_start" title="group_start() :: Adds a paren to the current query for query grouping"><span class="description">Adds a paren to the current query for query grouping</span><pre>group_start()</pre></a></li>
<li class="method public "><a href="#having" title="having :: Generates a 'Having' clause"><span class="description">Generates a 'Having' clause</span><pre>having()</pre></a></li> <li class="method public "><a href="#method_having" title="having() :: Generates a 'Having' clause"><span class="description">Generates a 'Having' clause</span><pre>having()</pre></a></li>
<li class="method public "><a href="#insert" title="insert :: Creates an insert clause, and executes it"><span class="description">Creates an insert clause, and executes it</span><pre>insert()</pre></a></li> <li class="method public "><a href="#method_insert" title="insert() :: Creates an insert clause, and executes it"><span class="description">Creates an insert clause, and executes it</span><pre>insert()</pre></a></li>
<li class="method public "><a href="#join" title="join :: Creates a join phrase in a compiled query"><span class="description">Creates a join phrase in a compiled query</span><pre>join()</pre></a></li> <li class="method public "><a href="#method_join" title="join() :: Creates a join phrase in a compiled query"><span class="description">Creates a join phrase in a compiled query</span><pre>join()</pre></a></li>
<li class="method public "><a href="#like" title="like :: Creates a Like clause in the sql statement"><span class="description">Creates a Like clause in the sql statement</span><pre>like()</pre></a></li> <li class="method public "><a href="#method_like" title="like() :: Creates a Like clause in the sql statement"><span class="description">Creates a Like clause in the sql statement</span><pre>like()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Set a limit on the current sql statement"><span class="description">Set a limit on the current sql statement</span><pre>limit()</pre></a></li> <li class="method public "><a href="#method_limit" title="limit() :: Set a limit on the current sql statement"><span class="description">Set a limit on the current sql statement</span><pre>limit()</pre></a></li>
<li class="method public "><a href="#not_like" title="not_like :: Generates a NOT LIKE clause"><span class="description">Generates a NOT LIKE clause</span><pre>not_like()</pre></a></li> <li class="method public "><a href="#method_not_like" title="not_like() :: Generates a NOT LIKE clause"><span class="description">Generates a NOT LIKE clause</span><pre>not_like()</pre></a></li>
<li class="method public "><a href="#or_group_start" title="or_group_start :: Adds a paren to the current query for query grouping, <li class="method public "><a href="#method_or_group_start" title="or_group_start() :: Adds a paren to the current query for query grouping,
prefixed with 'OR'"><span class="description">Adds a paren to the current query for query grouping, prefixed with 'OR'"><span class="description">Adds a paren to the current query for query grouping,
prefixed with 'OR'</span><pre>or_group_start()</pre></a></li> prefixed with 'OR'</span><pre>or_group_start()</pre></a></li>
<li class="method public "><a href="#or_having" title="or_having :: Generates a 'Having' clause prefixed with 'OR'"><span class="description">Generates a 'Having' clause prefixed with 'OR'</span><pre>or_having()</pre></a></li> <li class="method public "><a href="#method_or_having" title="or_having() :: Generates a 'Having' clause prefixed with 'OR'"><span class="description">Generates a 'Having' clause prefixed with 'OR'</span><pre>or_having()</pre></a></li>
<li class="method public "><a href="#or_like" title="or_like :: Generates an OR Like clause"><span class="description">Generates an OR Like clause</span><pre>or_like()</pre></a></li> <li class="method public "><a href="#method_or_like" title="or_like() :: Generates an OR Like clause"><span class="description">Generates an OR Like clause</span><pre>or_like()</pre></a></li>
<li class="method public "><a href="#or_not_group_start" title="or_not_group_start :: Adds a paren to the current query for query grouping, <li class="method public "><a href="#method_or_not_group_start" title="or_not_group_start() :: Adds a paren to the current query for query grouping,
prefixed with 'OR NOT'"><span class="description">Adds a paren to the current query for query grouping, prefixed with 'OR NOT'"><span class="description">Adds a paren to the current query for query grouping,
prefixed with 'OR NOT'</span><pre>or_not_group_start()</pre></a></li> prefixed with 'OR NOT'</span><pre>or_not_group_start()</pre></a></li>
<li class="method public "><a href="#or_not_like" title="or_not_like :: Generates a OR NOT LIKE clause"><span class="description">Generates a OR NOT LIKE clause</span><pre>or_not_like()</pre></a></li> <li class="method public "><a href="#method_or_not_like" title="or_not_like() :: Generates a OR NOT LIKE clause"><span class="description">Generates a OR NOT LIKE clause</span><pre>or_not_like()</pre></a></li>
<li class="method public "><a href="#or_where" title='or_where :: Where clause prefixed with "OR"'><span class="description">Where clause prefixed with "OR"</span><pre>or_where()</pre></a></li> <li class="method public "><a href="#method_or_where" title='or_where() :: Where clause prefixed with "OR"'><span class="description">Where clause prefixed with "OR"</span><pre>or_where()</pre></a></li>
<li class="method public "><a href="#or_where_in" title='or_where_in :: Where in statement prefixed with "or"'><span class="description">Where in statement prefixed with "or"</span><pre>or_where_in()</pre></a></li> <li class="method public "><a href="#method_or_where_in" title='or_where_in() :: Where in statement prefixed with "or"'><span class="description">Where in statement prefixed with "or"</span><pre>or_where_in()</pre></a></li>
<li class="method public "><a href="#or_where_not_in" title="or_where_not_in :: OR WHERE NOT IN (FOO) clause"><span class="description">OR WHERE NOT IN (FOO) clause</span><pre>or_where_not_in()</pre></a></li> <li class="method public "><a href="#method_or_where_not_in" title="or_where_not_in() :: OR WHERE NOT IN (FOO) clause"><span class="description">OR WHERE NOT IN (FOO) clause</span><pre>or_where_not_in()</pre></a></li>
<li class="method public "><a href="#order_by" title="order_by :: Order the results by the selected field(s)"><span class="description">Order the results by the selected field(s)</span><pre>order_by()</pre></a></li> <li class="method public "><a href="#method_order_by" title="order_by() :: Order the results by the selected field(s)"><span class="description">Order the results by the selected field(s)</span><pre>order_by()</pre></a></li>
<li class="method public "><a href="#reset_query" title="reset_query :: Clear out the class variables, so the next query can be run"><span class="description">Clear out the class variables, so the next query can be run</span><pre>reset_query()</pre></a></li> <li class="method public "><a href="#method_reset_query" title="reset_query() :: Clear out the class variables, so the next query can be run"><span class="description">Clear out the class variables, so the next query can be run</span><pre>reset_query()</pre></a></li>
<li class="method public "><a href="#select" title="select :: Specifies rows to select in a query"><span class="description">Specifies rows to select in a query</span><pre>select()</pre></a></li> <li class="method public "><a href="#method_select" title="select() :: Specifies rows to select in a query"><span class="description">Specifies rows to select in a query</span><pre>select()</pre></a></li>
<li class="method public "><a href="#select_avg" title="select_avg :: Selects the average value of a field from a query"><span class="description">Selects the average value of a field from a query</span><pre>select_avg()</pre></a></li> <li class="method public "><a href="#method_select_avg" title="select_avg() :: Selects the average value of a field from a query"><span class="description">Selects the average value of a field from a query</span><pre>select_avg()</pre></a></li>
<li class="method public "><a href="#select_max" title="select_max :: Selects the maximum value of a field from a query"><span class="description">Selects the maximum value of a field from a query</span><pre>select_max()</pre></a></li> <li class="method public "><a href="#method_select_max" title="select_max() :: Selects the maximum value of a field from a query"><span class="description">Selects the maximum value of a field from a query</span><pre>select_max()</pre></a></li>
<li class="method public "><a href="#select_min" title="select_min :: Selects the minimum value of a field from a query"><span class="description">Selects the minimum value of a field from a query</span><pre>select_min()</pre></a></li> <li class="method public "><a href="#method_select_min" title="select_min() :: Selects the minimum value of a field from a query"><span class="description">Selects the minimum value of a field from a query</span><pre>select_min()</pre></a></li>
<li class="method public "><a href="#select_sum" title="select_sum :: Selects the sum of a field from a query"><span class="description">Selects the sum of a field from a query</span><pre>select_sum()</pre></a></li> <li class="method public "><a href="#method_select_sum" title="select_sum() :: Selects the sum of a field from a query"><span class="description">Selects the sum of a field from a query</span><pre>select_sum()</pre></a></li>
<li class="method public "><a href="#set" title="set :: Sets values for inserts / updates / deletes"><span class="description">Sets values for inserts / updates / deletes</span><pre>set()</pre></a></li> <li class="method public "><a href="#method_set" title="set() :: Sets values for inserts / updates / deletes"><span class="description">Sets values for inserts / updates / deletes</span><pre>set()</pre></a></li>
<li class="method public "><a href="#update" title="update :: Creates an update clause, and executes it"><span class="description">Creates an update clause, and executes it</span><pre>update()</pre></a></li> <li class="method public "><a href="#method_update" title="update() :: Creates an update clause, and executes it"><span class="description">Creates an update clause, and executes it</span><pre>update()</pre></a></li>
<li class="method public "><a href="#where" title="where :: Specify condition(s) in the where clause of a query <li class="method public "><a href="#method_where" title="where() :: Specify condition(s) in the where clause of a query
Note: this function works with key / value, or a Note: this function works with key / value, or a
passed array with key / value pairs"><span class="description">Specify condition(s) in the where clause of a query passed array with key / value pairs"><span class="description">Specify condition(s) in the where clause of a query
Note: this function works with key / value, or a Note: this function works with key / value, or a
passed array with key / value pairs</span><pre>where()</pre></a></li> 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="#method_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="method public "><a href="#method_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>
</ul> </ul>
</li></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a name="%5CiQuery_Builder" id="\iQuery_Builder"></a><div href="../classes/iQuery_Builder.html" class="element interface"> <a id="\iQuery_Builder"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/iQuery_Builder.html">iQuery_Builder</a>
</li>
</ul>
<div class="element interface">
<p class="short_description">Interface defining the Query Builder class</p> <p class="short_description">Interface defining the Query Builder class</p>
<div class="details"> <div class="details">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<th>package</th> <th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td> <td><a href="../packages/Query.Query.html">Query</a></td>
</tr> </tr>
<tr> <tr>
<th>subpackage</th> <th>subpackage</th>
@ -129,12 +135,12 @@ passed array with key / value pairs</span><pre>where()</pre></a></li>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i class="icon-custom icon-method"></i> Methods</h3>
<a name="count_all" id="count_all"></a><div class="element clickable method public count_all" data-toggle="collapse" data-target=".count_all .collapse"> <a id="method_count_all"></a><div class="element clickable method public method_count_all" data-toggle="collapse" data-target=".method_count_all .collapse">
<h2>Retreive the number of rows in the selected table</h2> <h2>Retreive the number of rows in the selected table</h2>
<pre>count_all(string $table) : int</pre> <pre>count_all(string $table) : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -144,13 +150,13 @@ passed array with key / value pairs</span><pre>where()</pre></a></li>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a name="count_all_results" id="count_all_results"></a><div class="element clickable method public count_all_results" data-toggle="collapse" data-target=".count_all_results .collapse"> <a id="method_count_all_results"></a><div class="element clickable method public method_count_all_results" data-toggle="collapse" data-target=".method_count_all_results .collapse">
<h2>Retrieve the number of results for the generated query - used <h2>Retrieve the number of results for the generated query - used
in place of the get() method</h2> in place of the get() method</h2>
<pre>count_all_results(string $table) : int</pre> <pre>count_all_results(string $table) : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -160,12 +166,12 @@ in place of the get() method</h2>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a name="delete" id="delete"></a><div class="element clickable method public delete" data-toggle="collapse" data-target=".delete .collapse"> <a id="method_delete"></a><div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse">
<h2>Deletes data from a table</h2> <h2>Deletes data from a table</h2>
<pre>delete(string $table, mixed $where) : mixed</pre> <pre>delete(string $table, mixed $where) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -179,26 +185,26 @@ in place of the get() method</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse"> <a id="method_distinct"></a><div class="element clickable method public method_distinct" data-toggle="collapse" data-target=".method_distinct .collapse">
<h2>Adds the 'distinct' keyword to a query</h2> <h2>Adds the 'distinct' keyword to a query</h2>
<pre>distinct() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>distinct() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
</tr></table> </tr></table>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="from" id="from"></a><div class="element clickable method public from" data-toggle="collapse" data-target=".from .collapse"> <a id="method_from"></a><div class="element clickable method public method_from" data-toggle="collapse" data-target=".method_from .collapse">
<h2>Specify the database table to select from</h2> <h2>Specify the database table to select from</h2>
<pre>from(string $tblname) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>from(string $tblname) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -209,21 +215,18 @@ in place of the get() method</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse"> <a id="method_get"></a><div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse">
<h2>Select and retrieve all records from the current table, and/or <h2>Select and retrieve all records from the current table, and/or
execute current compiled query</h2> execute current compiled query</h2>
<pre>get($table, int $limit, int $offset) : object</pre> <pre>get(mixed $table, int $limit, int $offset) : object</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$table</h4></div>
<h4>$table</h4>
<code></code>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$limit</h4> <h4>$limit</h4>
<code>int</code> <code>int</code>
@ -236,12 +239,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>object</code></div> <div class="subelement response"><code>object</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_compiled_delete" id="get_compiled_delete"></a><div class="element clickable method public get_compiled_delete" data-toggle="collapse" data-target=".get_compiled_delete .collapse"> <a id="method_get_compiled_delete"></a><div class="element clickable method public method_get_compiled_delete" data-toggle="collapse" data-target=".method_get_compiled_delete .collapse">
<h2>Returns the generated 'delete' sql query</h2> <h2>Returns the generated 'delete' sql query</h2>
<pre>get_compiled_delete(string $table, bool $reset) : string</pre> <pre>get_compiled_delete(string $table, bool $reset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -255,12 +258,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_compiled_insert" id="get_compiled_insert"></a><div class="element clickable method public get_compiled_insert" data-toggle="collapse" data-target=".get_compiled_insert .collapse"> <a id="method_get_compiled_insert"></a><div class="element clickable method public method_get_compiled_insert" data-toggle="collapse" data-target=".method_get_compiled_insert .collapse">
<h2>Returns the generated 'insert' sql query</h2> <h2>Returns the generated 'insert' sql query</h2>
<pre>get_compiled_insert(string $table, bool $reset) : string</pre> <pre>get_compiled_insert(string $table, bool $reset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -274,12 +277,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_compiled_select" id="get_compiled_select"></a><div class="element clickable method public get_compiled_select" data-toggle="collapse" data-target=".get_compiled_select .collapse"> <a id="method_get_compiled_select"></a><div class="element clickable method public method_get_compiled_select" data-toggle="collapse" data-target=".method_get_compiled_select .collapse">
<h2>Returns the generated 'select' sql query</h2> <h2>Returns the generated 'select' sql query</h2>
<pre>get_compiled_select(string $table, bool $reset) : string</pre> <pre>get_compiled_select(string $table, bool $reset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -293,12 +296,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_compiled_update" id="get_compiled_update"></a><div class="element clickable method public get_compiled_update" data-toggle="collapse" data-target=".get_compiled_update .collapse"> <a id="method_get_compiled_update"></a><div class="element clickable method public method_get_compiled_update" data-toggle="collapse" data-target=".method_get_compiled_update .collapse">
<h2>Returns the generated 'update' sql query</h2> <h2>Returns the generated 'update' sql query</h2>
<pre>get_compiled_update(string $table, bool $reset) : string</pre> <pre>get_compiled_update(string $table, bool $reset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -312,12 +315,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="get_where" id="get_where"></a><div class="element clickable method public get_where" data-toggle="collapse" data-target=".get_where .collapse"> <a id="method_get_where"></a><div class="element clickable method public method_get_where" data-toggle="collapse" data-target=".method_get_where .collapse">
<h2>Convience method for get() with a where clause</h2> <h2>Convience method for get() with a where clause</h2>
<pre>get_where(string $table, array $where, int $limit, int $offset) : object</pre> <pre>get_where(string $table, array $where, int $limit, int $offset) : object</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -339,12 +342,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>object</code></div> <div class="subelement response"><code>object</code></div>
</div></div> </div></div>
</div> </div>
<a name="group_by" id="group_by"></a><div class="element clickable method public group_by" data-toggle="collapse" data-target=".group_by .collapse"> <a id="method_group_by"></a><div class="element clickable method public method_group_by" data-toggle="collapse" data-target=".method_group_by .collapse">
<h2>Group the results by the selected field(s)</h2> <h2>Group the results by the selected field(s)</h2>
<pre>group_by(mixed $field) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>group_by(mixed $field) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -355,43 +358,43 @@ execute current compiled query</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="group_end" id="group_end"></a><div class="element clickable method public group_end" data-toggle="collapse" data-target=".group_end .collapse"> <a id="method_group_end"></a><div class="element clickable method public method_group_end" data-toggle="collapse" data-target=".method_group_end .collapse">
<h2>Ends a query group</h2> <h2>Ends a query group</h2>
<pre>group_end() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>group_end() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
</tr></table> </tr></table>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="group_start" id="group_start"></a><div class="element clickable method public group_start" data-toggle="collapse" data-target=".group_start .collapse"> <a id="method_group_start"></a><div class="element clickable method public method_group_start" data-toggle="collapse" data-target=".method_group_start .collapse">
<h2>Adds a paren to the current query for query grouping</h2> <h2>Adds a paren to the current query for query grouping</h2>
<pre>group_start() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>group_start() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
</tr></table> </tr></table>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="having" id="having"></a><div class="element clickable method public having" data-toggle="collapse" data-target=".having .collapse"> <a id="method_having"></a><div class="element clickable method public method_having" data-toggle="collapse" data-target=".method_having .collapse">
<h2>Generates a 'Having' clause</h2> <h2>Generates a 'Having' clause</h2>
<pre>having(mixed $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>having(mixed $key, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -406,15 +409,15 @@ execute current compiled query</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="insert" id="insert"></a><div class="element clickable method public insert" data-toggle="collapse" data-target=".insert .collapse"> <a id="method_insert"></a><div class="element clickable method public method_insert" data-toggle="collapse" data-target=".method_insert .collapse">
<h2>Creates an insert clause, and executes it</h2> <h2>Creates an insert clause, and executes it</h2>
<pre>insert(string $table, mixed $data) : mixed</pre> <pre>insert(string $table, mixed $data) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -428,12 +431,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="join" id="join"></a><div class="element clickable method public join" data-toggle="collapse" data-target=".join .collapse"> <a id="method_join"></a><div class="element clickable method public method_join" data-toggle="collapse" data-target=".method_join .collapse">
<h2>Creates a join phrase in a compiled query</h2> <h2>Creates a join phrase in a compiled query</h2>
<pre>join(string $table, string $condition, string $type) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>join(string $table, string $condition, string $type) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -452,15 +455,15 @@ execute current compiled query</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="like" id="like"></a><div class="element clickable method public like" data-toggle="collapse" data-target=".like .collapse"> <a id="method_like"></a><div class="element clickable method public method_like" data-toggle="collapse" data-target=".method_like .collapse">
<h2>Creates a Like clause in the sql statement</h2> <h2>Creates a Like clause in the sql statement</h2>
<pre>like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -479,15 +482,15 @@ execute current compiled query</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse">
<h2>Set a limit on the current sql statement</h2> <h2>Set a limit on the current sql statement</h2>
<pre>limit(int $limit, int $offset) : string</pre> <pre>limit(int $limit, int $offset) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$limit</h4> <h4>$limit</h4>
@ -501,12 +504,12 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="not_like" id="not_like"></a><div class="element clickable method public not_like" data-toggle="collapse" data-target=".not_like .collapse"> <a id="method_not_like"></a><div class="element clickable method public method_not_like" data-toggle="collapse" data-target=".method_not_like .collapse">
<h2>Generates a NOT LIKE clause</h2> <h2>Generates a NOT LIKE clause</h2>
<pre>not_like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>not_like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -525,30 +528,30 @@ execute current compiled query</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_group_start" id="or_group_start"></a><div class="element clickable method public or_group_start" data-toggle="collapse" data-target=".or_group_start .collapse"> <a id="method_or_group_start"></a><div class="element clickable method public method_or_group_start" data-toggle="collapse" data-target=".method_or_group_start .collapse">
<h2>Adds a paren to the current query for query grouping, <h2>Adds a paren to the current query for query grouping,
prefixed with 'OR'</h2> prefixed with 'OR'</h2>
<pre>or_group_start() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_group_start() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
</tr></table> </tr></table>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_having" id="or_having"></a><div class="element clickable method public or_having" data-toggle="collapse" data-target=".or_having .collapse"> <a id="method_or_having"></a><div class="element clickable method public method_or_having" data-toggle="collapse" data-target=".method_or_having .collapse">
<h2>Generates a 'Having' clause prefixed with 'OR'</h2> <h2>Generates a 'Having' clause prefixed with 'OR'</h2>
<pre>or_having(mixed $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_having(mixed $key, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -563,15 +566,15 @@ prefixed with 'OR'</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_like" id="or_like"></a><div class="element clickable method public or_like" data-toggle="collapse" data-target=".or_like .collapse"> <a id="method_or_like"></a><div class="element clickable method public method_or_like" data-toggle="collapse" data-target=".method_or_like .collapse">
<h2>Generates an OR Like clause</h2> <h2>Generates an OR Like clause</h2>
<pre>or_like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -590,30 +593,30 @@ prefixed with 'OR'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_not_group_start" id="or_not_group_start"></a><div class="element clickable method public or_not_group_start" data-toggle="collapse" data-target=".or_not_group_start .collapse"> <a id="method_or_not_group_start"></a><div class="element clickable method public method_or_not_group_start" data-toggle="collapse" data-target=".method_or_not_group_start .collapse">
<h2>Adds a paren to the current query for query grouping, <h2>Adds a paren to the current query for query grouping,
prefixed with 'OR NOT'</h2> prefixed with 'OR NOT'</h2>
<pre>or_not_group_start() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_not_group_start() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
</tr></table> </tr></table>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_not_like" id="or_not_like"></a><div class="element clickable method public or_not_like" data-toggle="collapse" data-target=".or_not_like .collapse"> <a id="method_or_not_like"></a><div class="element clickable method public method_or_not_like" data-toggle="collapse" data-target=".method_or_not_like .collapse">
<h2>Generates a OR NOT LIKE clause</h2> <h2>Generates a OR NOT LIKE clause</h2>
<pre>or_not_like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_not_like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -632,15 +635,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_where" id="or_where"></a><div class="element clickable method public or_where" data-toggle="collapse" data-target=".or_where .collapse"> <a id="method_or_where"></a><div class="element clickable method public method_or_where" data-toggle="collapse" data-target=".method_or_where .collapse">
<h2>Where clause prefixed with "OR"</h2> <h2>Where clause prefixed with "OR"</h2>
<pre>or_where(string $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_where(string $key, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -655,15 +658,15 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_where_in" id="or_where_in"></a><div class="element clickable method public or_where_in" data-toggle="collapse" data-target=".or_where_in .collapse"> <a id="method_or_where_in"></a><div class="element clickable method public method_or_where_in" data-toggle="collapse" data-target=".method_or_where_in .collapse">
<h2>Where in statement prefixed with "or"</h2> <h2>Where in statement prefixed with "or"</h2>
<pre>or_where_in(string $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_where_in(string $field, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -678,15 +681,15 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="or_where_not_in" id="or_where_not_in"></a><div class="element clickable method public or_where_not_in" data-toggle="collapse" data-target=".or_where_not_in .collapse"> <a id="method_or_where_not_in"></a><div class="element clickable method public method_or_where_not_in" data-toggle="collapse" data-target=".method_or_where_not_in .collapse">
<h2>OR WHERE NOT IN (FOO) clause</h2> <h2>OR WHERE NOT IN (FOO) clause</h2>
<pre>or_where_not_in(string $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>or_where_not_in(string $field, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -701,15 +704,15 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="order_by" id="order_by"></a><div class="element clickable method public order_by" data-toggle="collapse" data-target=".order_by .collapse"> <a id="method_order_by"></a><div class="element clickable method public method_order_by" data-toggle="collapse" data-target=".method_order_by .collapse">
<h2>Order the results by the selected field(s)</h2> <h2>Order the results by the selected field(s)</h2>
<pre>order_by(string $field, string $type) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>order_by(string $field, string $type) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -724,21 +727,21 @@ prefixed with 'OR NOT'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="reset_query" id="reset_query"></a><div class="element clickable method public reset_query" data-toggle="collapse" data-target=".reset_query .collapse"> <a id="method_reset_query"></a><div class="element clickable method public method_reset_query" data-toggle="collapse" data-target=".method_reset_query .collapse">
<h2>Clear out the class variables, so the next query can be run</h2> <h2>Clear out the class variables, so the next query can be run</h2>
<pre>reset_query() : void</pre> <pre>reset_query() : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a name="select" id="select"></a><div class="element clickable method public select" data-toggle="collapse" data-target=".select .collapse"> <a id="method_select"></a><div class="element clickable method public method_select" data-toggle="collapse" data-target=".method_select .collapse">
<h2>Specifies rows to select in a query</h2> <h2>Specifies rows to select in a query</h2>
<pre>select(string $fields) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>select(string $fields) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -749,15 +752,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="select_avg" id="select_avg"></a><div class="element clickable method public select_avg" data-toggle="collapse" data-target=".select_avg .collapse"> <a id="method_select_avg"></a><div class="element clickable method public method_select_avg" data-toggle="collapse" data-target=".method_select_avg .collapse">
<h2>Selects the average value of a field from a query</h2> <h2>Selects the average value of a field from a query</h2>
<pre>select_avg(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>select_avg(string $field, string $as) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -772,15 +775,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="select_max" id="select_max"></a><div class="element clickable method public select_max" data-toggle="collapse" data-target=".select_max .collapse"> <a id="method_select_max"></a><div class="element clickable method public method_select_max" data-toggle="collapse" data-target=".method_select_max .collapse">
<h2>Selects the maximum value of a field from a query</h2> <h2>Selects the maximum value of a field from a query</h2>
<pre>select_max(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>select_max(string $field, string $as) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -795,15 +798,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="select_min" id="select_min"></a><div class="element clickable method public select_min" data-toggle="collapse" data-target=".select_min .collapse"> <a id="method_select_min"></a><div class="element clickable method public method_select_min" data-toggle="collapse" data-target=".method_select_min .collapse">
<h2>Selects the minimum value of a field from a query</h2> <h2>Selects the minimum value of a field from a query</h2>
<pre>select_min(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>select_min(string $field, string $as) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -818,15 +821,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="select_sum" id="select_sum"></a><div class="element clickable method public select_sum" data-toggle="collapse" data-target=".select_sum .collapse"> <a id="method_select_sum"></a><div class="element clickable method public method_select_sum" data-toggle="collapse" data-target=".method_select_sum .collapse">
<h2>Selects the sum of a field from a query</h2> <h2>Selects the sum of a field from a query</h2>
<pre>select_sum(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>select_sum(string $field, string $as) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -841,15 +844,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code> <code>string</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse"> <a id="method_set"></a><div class="element clickable method public method_set" data-toggle="collapse" data-target=".method_set .collapse">
<h2>Sets values for inserts / updates / deletes</h2> <h2>Sets values for inserts / updates / deletes</h2>
<pre>set(mixed $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>set(mixed $key, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -864,15 +867,15 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="update" id="update"></a><div class="element clickable method public update" data-toggle="collapse" data-target=".update .collapse"> <a id="method_update"></a><div class="element clickable method public method_update" data-toggle="collapse" data-target=".method_update .collapse">
<h2>Creates an update clause, and executes it</h2> <h2>Creates an update clause, and executes it</h2>
<pre>update(string $table, mixed $data) : mixed</pre> <pre>update(string $table, mixed $data) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$table</h4> <h4>$table</h4>
@ -886,14 +889,14 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a name="where" id="where"></a><div class="element clickable method public where" data-toggle="collapse" data-target=".where .collapse"> <a id="method_where"></a><div class="element clickable method public method_where" data-toggle="collapse" data-target=".method_where .collapse">
<h2>Specify condition(s) in the where clause of a query <h2>Specify condition(s) in the where clause of a query
Note: this function works with key / value, or a Note: this function works with key / value, or a
passed array with key / value pairs</h2> passed array with key / value pairs</h2>
<pre>where(mixed $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>where(mixed $key, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -908,15 +911,15 @@ passed array with key / value pairs</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="where_in" id="where_in"></a><div class="element clickable method public where_in" data-toggle="collapse" data-target=".where_in .collapse"> <a id="method_where_in"></a><div class="element clickable method public method_where_in" data-toggle="collapse" data-target=".method_where_in .collapse">
<h2>Where clause with 'IN' statement</h2> <h2>Where clause with 'IN' statement</h2>
<pre>where_in(mixed $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>where_in(mixed $field, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -931,15 +934,15 @@ passed array with key / value pairs</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a name="where_not_in" id="where_not_in"></a><div class="element clickable method public where_not_in" data-toggle="collapse" data-target=".where_not_in .collapse"> <a id="method_where_not_in"></a><div class="element clickable method public method_where_not_in" data-toggle="collapse" data-target=".method_where_not_in .collapse">
<h2>WHERE NOT IN (FOO) clause</h2> <h2>WHERE NOT IN (FOO) clause</h2>
<pre>where_not_in(string $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre> <pre>where_not_in(string $field, mixed $val) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<table class="table table-bordered"><tr> <table class="table table-bordered"><tr>
<th>fluent</th> <th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td> <td>This method is part of a fluent interface and will return the same instance</td>
@ -954,7 +957,7 @@ passed array with key / value pairs</h2>
<code>mixed</code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </div></div>
</div> </div>
</div> </div>
@ -963,8 +966,9 @@ passed array with key / value pairs</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

5
docs/css/bootstrap.css vendored
View File

@ -2105,6 +2105,11 @@ button.btn.small, input[type="submit"].btn.small {
color: #999999; color: #999999;
text-transform: uppercase; text-transform: uppercase;
} }
.nav-list .nav-header * {
text-transform:none;
}
.nav-list > li + .nav-header { .nav-list > li + .nav-header {
margin-top: 9px; margin-top: 9px;
} }

1
docs/css/bootstrap.min.css vendored
View File

@ -412,6 +412,7 @@ button.btn.small,input[type="submit"].btn.small{*padding-top:3px;*padding-bottom
.nav-list{padding-left:14px;padding-right:14px;margin-bottom:0;} .nav-list{padding-left:14px;padding-right:14px;margin-bottom:0;}
.nav-list>li>a,.nav-list .nav-header{display:block;padding:3px 15px;margin-left:-15px;margin-right:-15px;text-shadow:0 1px 0 rgba(255, 255, 255, 0.5);} .nav-list>li>a,.nav-list .nav-header{display:block;padding:3px 15px;margin-left:-15px;margin-right:-15px;text-shadow:0 1px 0 rgba(255, 255, 255, 0.5);}
.nav-list .nav-header{font-size:11px;font-weight:bold;line-height:18px;color:#999999;text-transform:uppercase;} .nav-list .nav-header{font-size:11px;font-weight:bold;line-height:18px;color:#999999;text-transform:uppercase;}
.nav-list .nav-header *{text-transform:none;}
.nav-list>li+.nav-header{margin-top:9px;} .nav-list>li+.nav-header{margin-top:9px;}
.nav-list .active>a,.nav-list .active>a:hover{color:#ffffff;text-shadow:0 -1px 0 rgba(0, 0, 0, 0.2);background-color:#0088cc;} .nav-list .active>a,.nav-list .active>a:hover{color:#ffffff;text-shadow:0 -1px 0 rgba(0, 0, 0, 0.2);background-color:#0088cc;}
.nav-list [class^="icon-"]{margin-right:2px;} .nav-list [class^="icon-"]{margin-right:2px;}

43
docs/css/template.css
View File

@ -2,7 +2,7 @@
@import url(bootstrap-responsive.css); @import url(bootstrap-responsive.css);
@import url(prettify.css); @import url(prettify.css);
@import url(jquery.iviewer.css); @import url(jquery.iviewer.css);
@import url(http://fonts.googleapis.com/css?family=Crimson+Text|Philosopher|Forum); @import url(http://fonts.googleapis.com/css?family=Forum);
body body
{ {
@ -16,6 +16,10 @@ a
color: #55A72F; color: #55A72F;
} }
td p:last-of-type {
margin: 0;
}
li.l0, li.l1, li.l2, li.l3, li.l5, li.l6, li.l7, li.l8 li.l0, li.l1, li.l2, li.l3, li.l5, li.l6, li.l7, li.l8
{ {
list-style-type: decimal; list-style-type: decimal;
@ -83,6 +87,10 @@ a.brand, h2, .hero-unit h1
background: white; background: white;
} }
.dropdown-menu a{
overflow: hidden;
text-overflow: ellipsis;
}
h2 h2
{ {
border-bottom: 1px dashed #55A72F; border-bottom: 1px dashed #55A72F;
@ -116,11 +124,10 @@ h2:first-of-type
.hero-unit h1 .hero-unit h1
{ {
text-align: center;
font-weight: normal; font-weight: normal;
text-align: center; text-align: center;
color: white; color: white;
text-shadow: black 0px 0px 15px; text-shadow: black 0 0 15px;
} }
.hero-unit h2 .hero-unit h2
@ -241,6 +248,15 @@ div.element .table th
text-transform: capitalize; text-transform: capitalize;
} }
div.detail-description
{
padding-left: 30px;
}
div.detail-description table th {
vertical-align: top;
}
body.invert body.invert
{ {
background: white; background: white;
@ -303,7 +319,7 @@ ul.side-nav li.view-simple pre
ul.side-nav li.view-simple a ul.side-nav li.view-simple a
{ {
padding-bottom: 0px; padding-bottom: 0;
} }
i.icon-custom i.icon-custom
@ -353,10 +369,6 @@ i.icon-interface { background-image: url('../img/icons/interface.png'); }
div.element.property h1, div.element.property h1,
i.icon-property { background-image: url('../img/icons/property.png'); } i.icon-property { background-image: url('../img/icons/property.png'); }
i.icon-show-public { background-image: url('../img/icons/visibility_public.png'); }
i.icon-show-protected { background-image: url('../img/icons/visibility_protected.png'); }
i.icon-show-private { background-image: url('../img/icons/visibility_private.png'); }
span.empty-namespace span.empty-namespace
{ {
color: silver; color: silver;
@ -380,6 +392,7 @@ div.element div.subelement
{ {
margin-left: 10px; margin-left: 10px;
padding-bottom: 5px; padding-bottom: 5px;
clear: both;
} }
pre code pre code
@ -399,7 +412,7 @@ div.element div.subelement > code
div.element div.subelement > p div.element div.subelement > p
{ {
margin-left: 20px; margin-left: 20px;
margin-right: 40px; margin-right: 50px;
} }
div.element div.subelement h4 div.element div.subelement h4
@ -411,6 +424,7 @@ div.element div.subelement h4
div.element div.subelement.response div.element div.subelement.response
{ {
padding-bottom: 15px; padding-bottom: 15px;
margin-right: 50px;
} }
div.labels div.labels
@ -423,6 +437,12 @@ div.labels
font-size: 13px; font-size: 13px;
} }
.detail-description code {
white-space: pre;
display: inline-block;
padding: 10px;
}
.go_to_top .go_to_top
{ {
float: right; float: right;
@ -442,6 +462,11 @@ div.labels
font-weight: bold; font-weight: bold;
} }
.iviewer_common
{
z-index: 100;
}
@media (min-width: 980px) @media (min-width: 980px)
{ {
a[name] a[name]

14
docs/deprecated.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -67,8 +64,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

162
docs/errors.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -57,8 +54,6 @@
<button class="btn critical">Critical</button><button class="btn error">Error</button><button class="btn notice">Notice</button> <button class="btn critical">Critical</button><button class="btn error">Error</button><button class="btn notice">Notice</button>
</div></li> </div></li>
<li class="nav-header">Navigation</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> </ul></div>
<div class="span8"> <div class="span8">
<ul class="breadcrumb"> <ul class="breadcrumb">
@ -67,150 +62,10 @@
</li> </li>
<li>Compilation Errors</li> <li>Compilation Errors</li>
</ul> </ul>
<div class="alert alert-info">No errors have been found in this project.</div>
<div class="package-contents"></div>
<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;">17</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>30</td>
<td>No DocBlock was found for property $select_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>33</td>
<td>No DocBlock was found for property $from_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>36</td>
<td>No DocBlock was found for property $set_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>39</td>
<td>No DocBlock was found for property $order_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>42</td>
<td>No DocBlock was found for property $group_string</td>
</tr>
<tr class="error">
<td>error</td>
<td>49</td>
<td>No DocBlock was found for property $set_array_keys</td>
</tr>
<tr class="error">
<td>error</td>
<td>52</td>
<td>No DocBlock was found for property $order_array</td>
</tr>
<tr class="error">
<td>error</td>
<td>55</td>
<td>No DocBlock was found for property $group_array</td>
</tr>
<tr class="error">
<td>error</td>
<td>62</td>
<td>No DocBlock was found for property $values</td>
</tr>
<tr class="error">
<td>error</td>
<td>65</td>
<td>No DocBlock was found for property $where_values</td>
</tr>
<tr class="error">
<td>error</td>
<td>68</td>
<td>No DocBlock was found for property $limit</td>
</tr>
<tr class="error">
<td>error</td>
<td>71</td>
<td>No DocBlock was found for property $offset</td>
</tr>
<tr class="error">
<td>error</td>
<td>74</td>
<td>No DocBlock was found for property $sql</td>
</tr>
<tr class="error">
<td>error</td>
<td>85</td>
<td>No DocBlock was found for property $query_map</td>
</tr>
<tr class="error">
<td>error</td>
<td>88</td>
<td>No DocBlock was found for property $having_map</td>
</tr>
<tr class="error">
<td>error</td>
<td>91</td>
<td>No DocBlock was found for property $conn_name</td>
</tr>
<tr class="error">
<td>error</td>
<td>94</td>
<td>No DocBlock was found for property $queries</td>
</tr>
</tbody>
</table></div>
</div>
<div class="package-contents"></div> <div class="package-contents"></div>
<div class="package-contents"></div> <div class="package-contents"></div>
<div class="package-contents"></div> <div class="package-contents"></div>
@ -236,8 +91,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

14
docs/graph_class.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -64,8 +61,9 @@
}); });
</script><div class="row"><footer class="span12"> </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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

20
docs/js/template.js
View File

@ -10,7 +10,7 @@ function initializeContents()
$(".element a.more").hide(); $(".element a.more").hide();
$(".clickable.class,.clickable.interface").click(function() { $(".clickable.class,.clickable.interface").click(function() {
document.location = $(this).attr('href'); document.location = $("a.more", this).attr('href');
}); });
// change the cursor to a pointer to make it more explicit that this it clickable // change the cursor to a pointer to make it more explicit that this it clickable
@ -107,13 +107,13 @@ $(document).ready(function() {
$(this).parents('.side-nav').find('.active').removeClass('active'); $(this).parents('.side-nav').find('.active').removeClass('active');
$(this).parent().addClass('active'); $(this).parent().addClass('active');
$('div.namespace-contents').load( $('div.namespace-contents').load(
this.href + ' div.namespace-contents', {}, function(){ this.href + ' div.namespace-contents', function(){
initializeContents(); initializeContents();
$(window).scrollTop($('div.namespace-contents').position().top); $(window).scrollTop($('div.namespace-contents').position().top);
} }
); );
$('div.package-contents').load( $('div.package-contents').load(
this.href + ' div.package-contents', {}, function(){ this.href + ' div.package-contents', function(){
initializeContents(); initializeContents();
$(window).scrollTop($('div.package-contents').position().top); $(window).scrollTop($('div.package-contents').position().top);
} }
@ -140,7 +140,10 @@ $(document).ready(function() {
var thisPath = filterPath(this.pathname) || locationPath; var thisPath = filterPath(this.pathname) || locationPath;
if (locationPath == thisPath && (location.hostname == this.hostname || !this.hostname) && this.hash.replace(/#/, '')) if (locationPath == thisPath && (location.hostname == this.hostname || !this.hostname) && this.hash.replace(/#/, ''))
{ {
var $target = $(this.hash), target = this.hash; var target = decodeURIComponent(this.hash.replace(/#/,''));
// note: I'm using attribute selector, because id selector can't match elements with '$'
var $target = $('[id="'+target+'"]');
if ($target.length > 0) if ($target.length > 0)
{ {
$(this).click(function (event) $(this).click(function (event)
@ -182,4 +185,11 @@ $(document).ready(function() {
} }
return []; return [];
} }
});
// Hide API Documentation menu if it's empty
$('.nav .dropdown a[href=#api]').next().filter(function(el) {
if ($(el).children().length == 0) {
return true;
}
}).parent().hide();
});

20
docs/markers.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -63,12 +60,6 @@
</li> </li>
<li>Markers</li> <li>Markers</li>
</ul> </ul>
<div class="alert alert-info">
The following markers were found:
<ul><li>todo 
<span class="label label-info">2</span>
</li></ul>
</div>
<div id="marker-accordion"> <div id="marker-accordion">
<div class="package-contents"> <div class="package-contents">
<a name="drivers/pgsql/pgsql_util.php" id="drivers/pgsql/pgsql_util.php"></a><h3> <a name="drivers/pgsql/pgsql_util.php" id="drivers/pgsql/pgsql_util.php"></a><h3>
@ -109,8 +100,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:35-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

346
docs/namespaces/default.html
View File

@ -1,346 +0,0 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » default</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">23</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-map-marker"></i> Namespaces</li>
<li>
<a href="../namespaces/default.html" title="default"><i class="icon-th"></i>default</a><ul class="nav nav-list nav-namespaces"></ul>
</li>
</ul>
</div>
<div class="span8 namespace-contents">
<ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-th"></i></a><span class="divider">\</span>
</li>
<li class="active"><a href="../namespaces/default.html">default</a></li>
</ul>
<div class="namespace-indent">
<h3>
<i class="icon-custom icon-function"></i> Functions</h3>
<a name="Query" id="Query"></a><div class="element clickable function Query" data-toggle="collapse" data-target=".Query .collapse">
<h2>Connection function</h2>
<pre>Query(mixed $params) : <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>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$params</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a name="db_filter" id="db_filter"></a><div class="element clickable function db_filter" data-toggle="collapse" data-target=".db_filter .collapse">
<h2>Filter out db rows into one array</h2>
<pre>db_filter(array $array, mixed $index) : array</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>$array</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$index</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="do_include" id="do_include"></a><div class="element clickable function do_include" data-toggle="collapse" data-target=".do_include .collapse">
<h2>Bulk directory loading workaround for use
with array_map and glob</h2>
<pre>do_include(string $path) : void</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>$path</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="mb_trim" id="mb_trim"></a><div class="element clickable function mb_trim" data-toggle="collapse" data-target=".mb_trim .collapse">
<h2>Multibyte-safe trim function</h2>
<pre>mb_trim($string) : 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>$string</h4>
<code></code><p>string</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="query_autoload" id="query_autoload"></a><div class="element clickable function query_autoload" data-toggle="collapse" data-target=".query_autoload .collapse">
<h2>Load a Query class</h2>
<pre>query_autoload(string $class) </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>$class</h4>
<code>string</code>
</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="iDB_SQL" id="iDB_SQL"></a><div class="element ajax clickable interface" href="../classes/iDB_SQL.html">
<h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a>
</h1>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/iDB_SQL.html" class="more">« More »</a>
</div>
<a name="iQuery_Builder" id="iQuery_Builder"></a><div class="element ajax clickable interface" href="../classes/iQuery_Builder.html">
<h1>iQuery_Builder<a href="../classes/iQuery_Builder.html"></a>
</h1>
<p class="short_description">Interface defining the Query Builder class</p>
<div class="details collapse"></div>
<a href="../classes/iQuery_Builder.html" class="more">« More »</a>
</div>
<a name="BadConnectionException" id="BadConnectionException"></a><div class="element ajax clickable class" href="../classes/BadConnectionException.html">
<h1>BadConnectionException<a href="../classes/BadConnectionException.html"></a>
</h1>
<p class="short_description">Generic exception for bad connection strings</p>
<div class="details collapse"></div>
<a href="../classes/BadConnectionException.html" class="more">« More »</a>
</div>
<a name="BadDBDriverException" id="BadDBDriverException"></a><div class="element ajax clickable class" href="../classes/BadDBDriverException.html">
<h1>BadDBDriverException<a href="../classes/BadDBDriverException.html"></a>
</h1>
<p class="short_description">Generic exception for bad drivers</p>
<div class="details collapse"></div>
<a href="../classes/BadDBDriverException.html" class="more">« More »</a>
</div>
<a name="DB_PDO" id="DB_PDO"></a><div class="element ajax clickable class" href="../classes/DB_PDO.html">
<h1>DB_PDO<a href="../classes/DB_PDO.html"></a>
</h1>
<p class="short_description">Base Database class</p>
<div class="details collapse"></div>
<a href="../classes/DB_PDO.html" class="more">« More »</a>
</div>
<a name="DB_Util" id="DB_Util"></a><div class="element ajax clickable class" href="../classes/DB_Util.html">
<h1>DB_Util<a href="../classes/DB_Util.html"></a>
</h1>
<p class="short_description">Abstract class defining database / table creation methods</p>
<div class="details collapse"></div>
<a href="../classes/DB_Util.html" class="more">« More »</a>
</div>
<a name="Firebird" id="Firebird"></a><div class="element ajax clickable class" href="../classes/Firebird.html">
<h1>Firebird<a href="../classes/Firebird.html"></a>
</h1>
<p class="short_description">Firebird Database class</p>
<div class="details collapse"></div>
<a href="../classes/Firebird.html" class="more">« More »</a>
</div>
<a name="Firebird_Result" id="Firebird_Result"></a><div class="element ajax clickable class" href="../classes/Firebird_Result.html">
<h1>Firebird_Result<a href="../classes/Firebird_Result.html"></a>
</h1>
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods</p>
<div class="details collapse"></div>
<a href="../classes/Firebird_Result.html" class="more">« More »</a>
</div>
<a name="Firebird_SQL" id="Firebird_SQL"></a><div class="element ajax clickable class" href="../classes/Firebird_SQL.html">
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html"></a>
</h1>
<p class="short_description">Firebird Specific SQL</p>
<div class="details collapse"></div>
<a href="../classes/Firebird_SQL.html" class="more">« More »</a>
</div>
<a name="Firebird_Util" id="Firebird_Util"></a><div class="element ajax clickable class" href="../classes/Firebird_Util.html">
<h1>Firebird_Util<a href="../classes/Firebird_Util.html"></a>
</h1>
<p class="short_description">Firebird-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/Firebird_Util.html" class="more">« More »</a>
</div>
<a name="MySQL" id="MySQL"></a><div class="element ajax clickable class" href="../classes/MySQL.html">
<h1>MySQL<a href="../classes/MySQL.html"></a>
</h1>
<p class="short_description">MySQL specific class</p>
<div class="details collapse"></div>
<a href="../classes/MySQL.html" class="more">« More »</a>
</div>
<a name="MySQL_SQL" id="MySQL_SQL"></a><div class="element ajax clickable class" href="../classes/MySQL_SQL.html">
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html"></a>
</h1>
<p class="short_description">MySQL specifc SQL</p>
<div class="details collapse"></div>
<a href="../classes/MySQL_SQL.html" class="more">« More »</a>
</div>
<a name="MySQL_Util" id="MySQL_Util"></a><div class="element ajax clickable class" href="../classes/MySQL_Util.html">
<h1>MySQL_Util<a href="../classes/MySQL_Util.html"></a>
</h1>
<p class="short_description">MySQL-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/MySQL_Util.html" class="more">« More »</a>
</div>
<a name="ODBC" id="ODBC"></a><div class="element ajax clickable class" href="../classes/ODBC.html">
<h1>ODBC<a href="../classes/ODBC.html"></a>
</h1>
<p class="short_description">ODBC Database Driver</p>
<div class="details collapse"></div>
<a href="../classes/ODBC.html" class="more">« More »</a>
</div>
<a name="ODBC_SQL" id="ODBC_SQL"></a><div class="element ajax clickable class" href="../classes/ODBC_SQL.html">
<h1>ODBC_SQL<a href="../classes/ODBC_SQL.html"></a>
</h1>
<p class="short_description">ODBC SQL Class</p>
<div class="details collapse"></div>
<a href="../classes/ODBC_SQL.html" class="more">« More »</a>
</div>
<a name="ODBC_Util" id="ODBC_Util"></a><div class="element ajax clickable class" href="../classes/ODBC_Util.html">
<h1>ODBC_Util<a href="../classes/ODBC_Util.html"></a>
</h1>
<p class="short_description">ODBC-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/ODBC_Util.html" class="more">« More »</a>
</div>
<a name="PgSQL" id="PgSQL"></a><div class="element ajax clickable class" href="../classes/PgSQL.html">
<h1>PgSQL<a href="../classes/PgSQL.html"></a>
</h1>
<p class="short_description">PostgreSQL specifc class</p>
<div class="details collapse"></div>
<a href="../classes/PgSQL.html" class="more">« More »</a>
</div>
<a name="PgSQL_SQL" id="PgSQL_SQL"></a><div class="element ajax clickable class" href="../classes/PgSQL_SQL.html">
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html"></a>
</h1>
<p class="short_description">PostgreSQL specifc SQL</p>
<div class="details collapse"></div>
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
</div>
<a name="PgSQL_Util" id="PgSQL_Util"></a><div class="element ajax clickable class" href="../classes/PgSQL_Util.html">
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html"></a>
</h1>
<p class="short_description">Posgres-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/PgSQL_Util.html" class="more">« More »</a>
</div>
<a name="Query_Builder" id="Query_Builder"></a><div class="element ajax clickable class" href="../classes/Query_Builder.html">
<h1>Query_Builder<a href="../classes/Query_Builder.html"></a>
</h1>
<p class="short_description">Convienience class for creating sql queries - also the class that
instantiates the specific db driver</p>
<div class="details collapse"></div>
<a href="../classes/Query_Builder.html" class="more">« More »</a>
</div>
<a name="Query_Parser" id="Query_Parser"></a><div class="element ajax clickable class" href="../classes/Query_Parser.html">
<h1>Query_Parser<a href="../classes/Query_Parser.html"></a>
</h1>
<p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p>
<div class="details collapse"></div>
<a href="../classes/Query_Parser.html" class="more">« More »</a>
</div>
<a name="SQLite" id="SQLite"></a><div class="element ajax clickable class" href="../classes/SQLite.html">
<h1>SQLite<a href="../classes/SQLite.html"></a>
</h1>
<p class="short_description">SQLite specific class</p>
<div class="details collapse"></div>
<a href="../classes/SQLite.html" class="more">« More »</a>
</div>
<a name="SQLite_SQL" id="SQLite_SQL"></a><div class="element ajax clickable class" href="../classes/SQLite_SQL.html">
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html"></a>
</h1>
<p class="short_description">SQLite Specific SQL</p>
<div class="details collapse"></div>
<a href="../classes/SQLite_SQL.html" class="more">« More »</a>
</div>
<a name="SQLite_Util" id="SQLite_Util"></a><div class="element ajax clickable class" href="../classes/SQLite_Util.html">
<h1>SQLite_Util<a href="../classes/SQLite_Util.html"></a>
</h1>
<p class="short_description">SQLite-specific backup, import and creation methods</p>
<div class="details collapse"></div>
<a href="../classes/SQLite_Util.html" class="more">« More »</a>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="QBASE_PATH" id="QBASE_PATH"> </a><div class="element clickable constant QBASE_PATH" data-toggle="collapse" data-target=".QBASE_PATH .collapse">
<h2>Reference to root path</h2>
<pre>QBASE_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="QDRIVER_PATH" id="QDRIVER_PATH"> </a><div class="element clickable constant QDRIVER_PATH" data-toggle="collapse" data-target=".QDRIVER_PATH .collapse">
<h2>Path to driver classes</h2>
<pre>QDRIVER_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</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 2013-05-03T13:07:08-04:00.<br></footer></div>
</div>
</body>
</html>

115
docs/namespaces/global.html Normal file
View File

@ -0,0 +1,115 @@
<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » global</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-map-marker"></i> Namespaces</li>
<li>
<span class="empty-namespace"><i class="icon-stop"></i>global</span><ul class="nav nav-list nav-namespaces"></ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-function"></i> Functions</li>
<li class="function "><a href="#function_Query" title="Query() :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li>
<li class="function "><a href="#function_db_filter" title="db_filter() :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li>
<li class="function "><a href="#function_do_include" title="do_include() :: Bulk directory loading workaround for use
with array_map and glob"><span class="description">Bulk directory loading workaround for use
with array_map and glob</span><pre>do_include</pre></a></li>
<li class="function "><a href="#function_mb_trim" title="mb_trim() :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</pre></a></li>
<li class="function "><a href="#function_query_autoload" title="query_autoload() :: Load a Query class"><span class="description">Load a Query class</span><pre>query_autoload</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-interface"></i> Interfaces</li>
<li><a href="#iDB_SQL" title="parent for database manipulation subclasses">iDB_SQL</a></li>
<li><a href="#iQuery_Builder" title="Interface defining the Query Builder class">iQuery_Builder</a></li>
<li class="nav-header">
<i class="icon-custom icon-class"></i> Classes</li>
<li><a href="#Query_Parser" title="Utility Class to parse sql clauses for properly escaping identifiers">Query_Parser</a></li>
<li><a href="#DB_PDO" title="Base Database class">DB_PDO</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>
<li><a href="#PgSQL_SQL" title="PostgreSQL specifc SQL">PgSQL_SQL</a></li>
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
<li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li>
<li><a href="#ODBC_Util" title="ODBC-specific backup, import and creation methods">ODBC_Util</a></li>
<li><a href="#ODBC_SQL" title="ODBC SQL Class">ODBC_SQL</a></li>
<li><a href="#ODBC" title="ODBC Database Driver">ODBC</a></li>
<li><a href="#MySQL_Util" title="MySQL-specific backup, import and creation methods">MySQL_Util</a></li>
<li><a href="#MySQL" title="MySQL specific class">MySQL</a></li>
<li><a href="#MySQL_SQL" title="MySQL specifc SQL">MySQL_SQL</a></li>
<li><a href="#SQLite_Util" title="SQLite-specific backup, import and creation methods">SQLite_Util</a></li>
<li><a href="#SQLite" title="SQLite specific class">SQLite</a></li>
<li><a href="#SQLite_SQL" title="SQLite Specific SQL">SQLite_SQL</a></li>
<li><a href="#Firebird_SQL" title="Firebird Specific SQL">Firebird_SQL</a></li>
<li><a href="#Firebird_Result" title="Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods">Firebird_Result</a></li>
<li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant "><a href="#constant_QBASE_PATH" title="QBASE_PATH() :: Reference to root path"><span class="description">Reference to root path</span><pre>QBASE_PATH</pre></a></li>
<li class="constant "><a href="#constant_QDRIVER_PATH" title="QDRIVER_PATH() :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li>
</ul>
</div>
<div class="span8 namespace-contents"></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.1.0
</a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div>
</body>
</html>

74
docs/packages/.html
View File

@ -1,74 +0,0 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » </title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<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">23</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-map-marker"></i> Packages</li>
<li>
<span class="empty-package"><i class="icon-folder-close"></i></span><ul class="nav nav-list nav-packages"></ul>
</li>
</ul>
</div>
<div class="span8 package-contents"></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 2013-05-03T13:07:08-04:00.<br></footer></div>
</div>
</body>
</html>

45
docs/packages/Default.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -59,43 +56,17 @@
<li class="nav-header"> <li class="nav-header">
<i class="icon-map-marker"></i> Packages</li> <i class="icon-map-marker"></i> Packages</li>
<li> <li>
<a href="../packages/Default.html" title="Default"><i class="icon-folder-open"></i>Default</a><ul class="nav nav-list nav-packages"></ul> <span class="empty-package"><i class="icon-folder-close"></i>Default</span><ul class="nav nav-list nav-packages"></ul>
</li> </li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant "><a href="#QBASE_PATH" title="QBASE_PATH :: Reference to root path"><span class="description">Reference to root path</span><pre>QBASE_PATH</pre></a></li>
<li class="constant "><a href="#QDRIVER_PATH" title="QDRIVER_PATH :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li>
</ul> </ul>
</div> </div>
<div class="span8 package-contents"> <div class="span8 package-contents"></div>
<ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
</li>
<li class="active"><a href="../packages/Default.html">Default</a></li>
</ul>
<div class="package-indent">
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="QBASE_PATH" id="QBASE_PATH"> </a><div class="element clickable constant QBASE_PATH" data-toggle="collapse" data-target=".QBASE_PATH .collapse">
<h2>Reference to root path</h2>
<pre>QBASE_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="QDRIVER_PATH" id="QDRIVER_PATH"> </a><div class="element clickable constant QDRIVER_PATH" data-toggle="collapse" data-target=".QDRIVER_PATH .collapse">
<h2>Path to driver classes</h2>
<pre>QDRIVER_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

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

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -83,24 +80,23 @@ data-fetching methods">Firebird_Result</a></li>
</ul> </ul>
</div> </div>
<div class="span8 package-contents"> <div class="span8 package-contents">
<ul class="breadcrumb"> <ul class="breadcrumb"><li>
<li> <a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li><a href="../packages/Query.html">Query</a></li>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span> <li class="active">
<span class="divider">\</span><a href="../packages/Query.Drivers.html">Drivers</a>
</li> </li>
<li><a href="../packages/Query.html">Query</a></li> </li></ul>
<span class="divider">\</span><li class="active"><a href="../packages/Query.Drivers.html">Drivers</a></li>
</ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="Firebird" id="Firebird"></a><div class="element ajax clickable class" href="../classes/Firebird.html"> <div id="Firebird" class="element ajax clickable class">
<h1>Firebird<a href="../classes/Firebird.html"></a> <h1>Firebird<a href="../classes/Firebird.html"></a>
</h1> </h1>
<p class="short_description">Firebird Database class</p> <p class="short_description">Firebird Database class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird.html" class="more">« More »</a> <a href="../classes/Firebird.html" class="more">« More »</a>
</div> </div>
<a name="Firebird_Result" id="Firebird_Result"></a><div class="element ajax clickable class" href="../classes/Firebird_Result.html"> <div id="Firebird_Result" class="element ajax clickable class">
<h1>Firebird_Result<a href="../classes/Firebird_Result.html"></a> <h1>Firebird_Result<a href="../classes/Firebird_Result.html"></a>
</h1> </h1>
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements <p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
@ -108,98 +104,98 @@ data-fetching methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird_Result.html" class="more">« More »</a> <a href="../classes/Firebird_Result.html" class="more">« More »</a>
</div> </div>
<a name="Firebird_SQL" id="Firebird_SQL"></a><div class="element ajax clickable class" href="../classes/Firebird_SQL.html"> <div id="Firebird_SQL" class="element ajax clickable class">
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html"></a> <h1>Firebird_SQL<a href="../classes/Firebird_SQL.html"></a>
</h1> </h1>
<p class="short_description">Firebird Specific SQL</p> <p class="short_description">Firebird Specific SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird_SQL.html" class="more">« More »</a> <a href="../classes/Firebird_SQL.html" class="more">« More »</a>
</div> </div>
<a name="Firebird_Util" id="Firebird_Util"></a><div class="element ajax clickable class" href="../classes/Firebird_Util.html"> <div id="Firebird_Util" class="element ajax clickable class">
<h1>Firebird_Util<a href="../classes/Firebird_Util.html"></a> <h1>Firebird_Util<a href="../classes/Firebird_Util.html"></a>
</h1> </h1>
<p class="short_description">Firebird-specific backup, import and creation methods</p> <p class="short_description">Firebird-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird_Util.html" class="more">« More »</a> <a href="../classes/Firebird_Util.html" class="more">« More »</a>
</div> </div>
<a name="MySQL" id="MySQL"></a><div class="element ajax clickable class" href="../classes/MySQL.html"> <div id="MySQL" class="element ajax clickable class">
<h1>MySQL<a href="../classes/MySQL.html"></a> <h1>MySQL<a href="../classes/MySQL.html"></a>
</h1> </h1>
<p class="short_description">MySQL specific class</p> <p class="short_description">MySQL specific class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/MySQL.html" class="more">« More »</a> <a href="../classes/MySQL.html" class="more">« More »</a>
</div> </div>
<a name="MySQL_SQL" id="MySQL_SQL"></a><div class="element ajax clickable class" href="../classes/MySQL_SQL.html"> <div id="MySQL_SQL" class="element ajax clickable class">
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html"></a> <h1>MySQL_SQL<a href="../classes/MySQL_SQL.html"></a>
</h1> </h1>
<p class="short_description">MySQL specifc SQL</p> <p class="short_description">MySQL specifc SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/MySQL_SQL.html" class="more">« More »</a> <a href="../classes/MySQL_SQL.html" class="more">« More »</a>
</div> </div>
<a name="MySQL_Util" id="MySQL_Util"></a><div class="element ajax clickable class" href="../classes/MySQL_Util.html"> <div id="MySQL_Util" class="element ajax clickable class">
<h1>MySQL_Util<a href="../classes/MySQL_Util.html"></a> <h1>MySQL_Util<a href="../classes/MySQL_Util.html"></a>
</h1> </h1>
<p class="short_description">MySQL-specific backup, import and creation methods</p> <p class="short_description">MySQL-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/MySQL_Util.html" class="more">« More »</a> <a href="../classes/MySQL_Util.html" class="more">« More »</a>
</div> </div>
<a name="ODBC" id="ODBC"></a><div class="element ajax clickable class" href="../classes/ODBC.html"> <div id="ODBC" class="element ajax clickable class">
<h1>ODBC<a href="../classes/ODBC.html"></a> <h1>ODBC<a href="../classes/ODBC.html"></a>
</h1> </h1>
<p class="short_description">ODBC Database Driver</p> <p class="short_description">ODBC Database Driver</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/ODBC.html" class="more">« More »</a> <a href="../classes/ODBC.html" class="more">« More »</a>
</div> </div>
<a name="ODBC_SQL" id="ODBC_SQL"></a><div class="element ajax clickable class" href="../classes/ODBC_SQL.html"> <div id="ODBC_SQL" class="element ajax clickable class">
<h1>ODBC_SQL<a href="../classes/ODBC_SQL.html"></a> <h1>ODBC_SQL<a href="../classes/ODBC_SQL.html"></a>
</h1> </h1>
<p class="short_description">ODBC SQL Class</p> <p class="short_description">ODBC SQL Class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/ODBC_SQL.html" class="more">« More »</a> <a href="../classes/ODBC_SQL.html" class="more">« More »</a>
</div> </div>
<a name="ODBC_Util" id="ODBC_Util"></a><div class="element ajax clickable class" href="../classes/ODBC_Util.html"> <div id="ODBC_Util" class="element ajax clickable class">
<h1>ODBC_Util<a href="../classes/ODBC_Util.html"></a> <h1>ODBC_Util<a href="../classes/ODBC_Util.html"></a>
</h1> </h1>
<p class="short_description">ODBC-specific backup, import and creation methods</p> <p class="short_description">ODBC-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/ODBC_Util.html" class="more">« More »</a> <a href="../classes/ODBC_Util.html" class="more">« More »</a>
</div> </div>
<a name="PgSQL" id="PgSQL"></a><div class="element ajax clickable class" href="../classes/PgSQL.html"> <div id="PgSQL" class="element ajax clickable class">
<h1>PgSQL<a href="../classes/PgSQL.html"></a> <h1>PgSQL<a href="../classes/PgSQL.html"></a>
</h1> </h1>
<p class="short_description">PostgreSQL specifc class</p> <p class="short_description">PostgreSQL specifc class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/PgSQL.html" class="more">« More »</a> <a href="../classes/PgSQL.html" class="more">« More »</a>
</div> </div>
<a name="PgSQL_SQL" id="PgSQL_SQL"></a><div class="element ajax clickable class" href="../classes/PgSQL_SQL.html"> <div id="PgSQL_SQL" class="element ajax clickable class">
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html"></a> <h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html"></a>
</h1> </h1>
<p class="short_description">PostgreSQL specifc SQL</p> <p class="short_description">PostgreSQL specifc SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a> <a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
</div> </div>
<a name="PgSQL_Util" id="PgSQL_Util"></a><div class="element ajax clickable class" href="../classes/PgSQL_Util.html"> <div id="PgSQL_Util" class="element ajax clickable class">
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html"></a> <h1>PgSQL_Util<a href="../classes/PgSQL_Util.html"></a>
</h1> </h1>
<p class="short_description">Posgres-specific backup, import and creation methods</p> <p class="short_description">Posgres-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/PgSQL_Util.html" class="more">« More »</a> <a href="../classes/PgSQL_Util.html" class="more">« More »</a>
</div> </div>
<a name="SQLite" id="SQLite"></a><div class="element ajax clickable class" href="../classes/SQLite.html"> <div id="SQLite" class="element ajax clickable class">
<h1>SQLite<a href="../classes/SQLite.html"></a> <h1>SQLite<a href="../classes/SQLite.html"></a>
</h1> </h1>
<p class="short_description">SQLite specific class</p> <p class="short_description">SQLite specific class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/SQLite.html" class="more">« More »</a> <a href="../classes/SQLite.html" class="more">« More »</a>
</div> </div>
<a name="SQLite_SQL" id="SQLite_SQL"></a><div class="element ajax clickable class" href="../classes/SQLite_SQL.html"> <div id="SQLite_SQL" class="element ajax clickable class">
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html"></a> <h1>SQLite_SQL<a href="../classes/SQLite_SQL.html"></a>
</h1> </h1>
<p class="short_description">SQLite Specific SQL</p> <p class="short_description">SQLite Specific SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/SQLite_SQL.html" class="more">« More »</a> <a href="../classes/SQLite_SQL.html" class="more">« More »</a>
</div> </div>
<a name="SQLite_Util" id="SQLite_Util"></a><div class="element ajax clickable class" href="../classes/SQLite_Util.html"> <div id="SQLite_Util" class="element ajax clickable class">
<h1>SQLite_Util<a href="../classes/SQLite_Util.html"></a> <h1>SQLite_Util<a href="../classes/SQLite_Util.html"></a>
</h1> </h1>
<p class="short_description">SQLite-specific backup, import and creation methods</p> <p class="short_description">SQLite-specific backup, import and creation methods</p>
@ -211,8 +207,9 @@ data-fetching methods</p>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

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

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -77,59 +74,58 @@ instantiates the specific db driver">Query_Builder</a></li>
</ul> </ul>
</div> </div>
<div class="span8 package-contents"> <div class="span8 package-contents">
<ul class="breadcrumb"> <ul class="breadcrumb"><li>
<li> <a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li><a href="../packages/Query.html">Query</a></li>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span> <li class="active">
<span class="divider">\</span><a href="../packages/Query.Query.html">Query</a>
</li> </li>
<li><a href="../packages/Query.html">Query</a></li> </li></ul>
<span class="divider">\</span><li class="active"><a href="../packages/Query.Query.html">Query</a></li>
</ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="iDB_SQL" id="iDB_SQL"></a><div class="element ajax clickable interface" href="../classes/iDB_SQL.html"> <div id="iDB_SQL" class="element ajax clickable interface">
<h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a> <h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a>
</h1> </h1>
<p class="short_description">parent for database manipulation subclasses</p> <p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/iDB_SQL.html" class="more">« More »</a> <a href="../classes/iDB_SQL.html" class="more">« More »</a>
</div> </div>
<a name="iQuery_Builder" id="iQuery_Builder"></a><div class="element ajax clickable interface" href="../classes/iQuery_Builder.html"> <div id="iQuery_Builder" class="element ajax clickable interface">
<h1>iQuery_Builder<a href="../classes/iQuery_Builder.html"></a> <h1>iQuery_Builder<a href="../classes/iQuery_Builder.html"></a>
</h1> </h1>
<p class="short_description">Interface defining the Query Builder class</p> <p class="short_description">Interface defining the Query Builder class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/iQuery_Builder.html" class="more">« More »</a> <a href="../classes/iQuery_Builder.html" class="more">« More »</a>
</div> </div>
<a name="BadConnectionException" id="BadConnectionException"></a><div class="element ajax clickable class" href="../classes/BadConnectionException.html"> <div id="BadConnectionException" class="element ajax clickable class">
<h1>BadConnectionException<a href="../classes/BadConnectionException.html"></a> <h1>BadConnectionException<a href="../classes/BadConnectionException.html"></a>
</h1> </h1>
<p class="short_description">Generic exception for bad connection strings</p> <p class="short_description">Generic exception for bad connection strings</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/BadConnectionException.html" class="more">« More »</a> <a href="../classes/BadConnectionException.html" class="more">« More »</a>
</div> </div>
<a name="BadDBDriverException" id="BadDBDriverException"></a><div class="element ajax clickable class" href="../classes/BadDBDriverException.html"> <div id="BadDBDriverException" class="element ajax clickable class">
<h1>BadDBDriverException<a href="../classes/BadDBDriverException.html"></a> <h1>BadDBDriverException<a href="../classes/BadDBDriverException.html"></a>
</h1> </h1>
<p class="short_description">Generic exception for bad drivers</p> <p class="short_description">Generic exception for bad drivers</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/BadDBDriverException.html" class="more">« More »</a> <a href="../classes/BadDBDriverException.html" class="more">« More »</a>
</div> </div>
<a name="DB_PDO" id="DB_PDO"></a><div class="element ajax clickable class" href="../classes/DB_PDO.html"> <div id="DB_PDO" class="element ajax clickable class">
<h1>DB_PDO<a href="../classes/DB_PDO.html"></a> <h1>DB_PDO<a href="../classes/DB_PDO.html"></a>
</h1> </h1>
<p class="short_description">Base Database class</p> <p class="short_description">Base Database class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/DB_PDO.html" class="more">« More »</a> <a href="../classes/DB_PDO.html" class="more">« More »</a>
</div> </div>
<a name="DB_Util" id="DB_Util"></a><div class="element ajax clickable class" href="../classes/DB_Util.html"> <div id="DB_Util" class="element ajax clickable class">
<h1>DB_Util<a href="../classes/DB_Util.html"></a> <h1>DB_Util<a href="../classes/DB_Util.html"></a>
</h1> </h1>
<p class="short_description">Abstract class defining database / table creation methods</p> <p class="short_description">Abstract class defining database / table creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/DB_Util.html" class="more">« More »</a> <a href="../classes/DB_Util.html" class="more">« More »</a>
</div> </div>
<a name="Query_Builder" id="Query_Builder"></a><div class="element ajax clickable class" href="../classes/Query_Builder.html"> <div id="Query_Builder" class="element ajax clickable class">
<h1>Query_Builder<a href="../classes/Query_Builder.html"></a> <h1>Query_Builder<a href="../classes/Query_Builder.html"></a>
</h1> </h1>
<p class="short_description">Convienience class for creating sql queries - also the class that <p class="short_description">Convienience class for creating sql queries - also the class that
@ -137,7 +133,7 @@ instantiates the specific db driver</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Query_Builder.html" class="more">« More »</a> <a href="../classes/Query_Builder.html" class="more">« More »</a>
</div> </div>
<a name="Query_Parser" id="Query_Parser"></a><div class="element ajax clickable class" href="../classes/Query_Parser.html"> <div id="Query_Parser" class="element ajax clickable class">
<h1>Query_Parser<a href="../classes/Query_Parser.html"></a> <h1>Query_Parser<a href="../classes/Query_Parser.html"></a>
</h1> </h1>
<p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p> <p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p>
@ -149,8 +145,9 @@ instantiates the specific db driver</p>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

155
docs/packages/Query.html
View File

@ -1,4 +1,4 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> <!DOCTYPE html><html lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
@ -20,7 +20,6 @@
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li> <li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li> <li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul> </ul>
</li> </li>
@ -32,11 +31,9 @@
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu"> Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors  <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">23</span></a></li> <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers  <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo  <ul></ul></a></li>
<span class="label label-info">2</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements  <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li> <span class="label label-info">0</span></a></li>
</ul> </ul>
@ -70,31 +67,32 @@
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-function"></i> Functions</li> <i class="icon-custom icon-function"></i> Functions</li>
<li class="function "><a href="#Query" title="Query :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li> <li class="function "><a href="#function_Query" title="Query() :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li>
<li class="function "><a href="#db_filter" title="db_filter :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li> <li class="function "><a href="#function_db_filter" title="db_filter() :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li>
<li class="function "><a href="#do_include" title="do_include :: Bulk directory loading workaround for use <li class="function "><a href="#function_do_include" title="do_include() :: Bulk directory loading workaround for use
with array_map and glob"><span class="description">Bulk directory loading workaround for use with array_map and glob"><span class="description">Bulk directory loading workaround for use
with array_map and glob</span><pre>do_include</pre></a></li> with array_map and glob</span><pre>do_include</pre></a></li>
<li class="function "><a href="#mb_trim" title="mb_trim :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</pre></a></li> <li class="function "><a href="#function_mb_trim" title="mb_trim() :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</pre></a></li>
<li class="function "><a href="#query_autoload" title="query_autoload :: Load a Query class"><span class="description">Load a Query class</span><pre>query_autoload</pre></a></li> <li class="function "><a href="#function_query_autoload" title="query_autoload() :: Load a Query class"><span class="description">Load a Query class</span><pre>query_autoload</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant "><a href="#constant_QBASE_PATH" title="QBASE_PATH() :: Reference to root path"><span class="description">Reference to root path</span><pre>QBASE_PATH</pre></a></li>
<li class="constant "><a href="#constant_QDRIVER_PATH" title="QDRIVER_PATH() :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li>
</ul> </ul>
</div> </div>
<div class="span8 package-contents"> <div class="span8 package-contents">
<ul class="breadcrumb"> <ul class="breadcrumb"><li>
<li> <a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li class="active"><a href="../packages/Query.html">Query</a></li>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span> </li></ul>
</li>
<li class="active"><a href="../packages/Query.html">Query</a></li>
</ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-function"></i> Functions</h3> <i class="icon-custom icon-function"></i> Functions</h3>
<a name="Query" id="Query"></a><div class="element clickable function Query" data-toggle="collapse" data-target=".Query .collapse"> <a id="function_Query"></a><div class="element clickable function function_Query" data-toggle="collapse" data-target=".function_Query .collapse">
<h2>Connection function</h2> <h2>Connection function</h2>
<pre>Query(mixed $params) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre> <pre>Query(mixed $params) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$params</h4> <h4>$params</h4>
@ -104,12 +102,12 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div> <div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div> </div></div>
</div> </div>
<a name="db_filter" id="db_filter"></a><div class="element clickable function db_filter" data-toggle="collapse" data-target=".db_filter .collapse"> <a id="function_db_filter"></a><div class="element clickable function function_db_filter" data-toggle="collapse" data-target=".function_db_filter .collapse">
<h2>Filter out db rows into one array</h2> <h2>Filter out db rows into one array</h2>
<pre>db_filter(array $array, mixed $index) : array</pre> <pre>db_filter(array $array, mixed $index) : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$array</h4> <h4>$array</h4>
@ -123,13 +121,13 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a name="do_include" id="do_include"></a><div class="element clickable function do_include" data-toggle="collapse" data-target=".do_include .collapse"> <a id="function_do_include"></a><div class="element clickable function function_do_include" data-toggle="collapse" data-target=".function_do_include .collapse">
<h2>Bulk directory loading workaround for use <h2>Bulk directory loading workaround for use
with array_map and glob</h2> with array_map and glob</h2>
<pre>do_include(string $path) : void</pre> <pre>do_include(string $path) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$path</h4> <h4>$path</h4>
@ -137,26 +135,24 @@ with array_map and glob</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<a name="mb_trim" id="mb_trim"></a><div class="element clickable function mb_trim" data-toggle="collapse" data-target=".mb_trim .collapse"> <a id="function_mb_trim"></a><div class="element clickable function function_mb_trim" data-toggle="collapse" data-target=".function_mb_trim .collapse">
<h2>Multibyte-safe trim function</h2> <h2>Multibyte-safe trim function</h2>
<pre>mb_trim($string) : string</pre> <pre>mb_trim($string) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument"><h4>$string</h4></div>
<h4>$string</h4>
<code></code><p>string</p></div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a name="query_autoload" id="query_autoload"></a><div class="element clickable function query_autoload" data-toggle="collapse" data-target=".query_autoload .collapse"> <a id="function_query_autoload"></a><div class="element clickable function function_query_autoload" data-toggle="collapse" data-target=".function_query_autoload .collapse">
<h2>Load a Query class</h2> <h2>Load a Query class</h2>
<pre>query_autoload(string $class) </pre> <pre>query_autoload(string $class) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="span8"> <div class="row collapse"><div class="detail-description">
<p class="long_description"></p> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$class</h4> <h4>$class</h4>
@ -164,24 +160,37 @@ with array_map and glob</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<ul class="breadcrumb"> <h3>
<li> <i class="icon-custom icon-constant"></i> Constants</h3>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span> <a id="constant_QBASE_PATH"> </a><div class="element clickable constant constant_QBASE_PATH" data-toggle="collapse" data-target=".constant_QBASE_PATH .collapse">
<h2>Reference to root path</h2>
<pre>QBASE_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_QDRIVER_PATH"> </a><div class="element clickable constant constant_QDRIVER_PATH" data-toggle="collapse" data-target=".constant_QDRIVER_PATH .collapse">
<h2>Path to driver classes</h2>
<pre>QDRIVER_PATH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<ul class="breadcrumb"><li>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li><a href="../packages/Query.html">Query</a></li>
<li class="active">
<span class="divider">\</span><a href="../packages/Query.Drivers.html">Drivers</a>
</li> </li>
<li><a href="../packages/Query.html">Query</a></li> </li></ul>
<span class="divider">\</span><li class="active"><a href="../packages/Query.Drivers.html">Drivers</a></li>
</ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="Firebird" id="Firebird"></a><div class="element ajax clickable class" href="../classes/Firebird.html"> <div id="Firebird" class="element ajax clickable class">
<h1>Firebird<a href="../classes/Firebird.html"></a> <h1>Firebird<a href="../classes/Firebird.html"></a>
</h1> </h1>
<p class="short_description">Firebird Database class</p> <p class="short_description">Firebird Database class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird.html" class="more">« More »</a> <a href="../classes/Firebird.html" class="more">« More »</a>
</div> </div>
<a name="Firebird_Result" id="Firebird_Result"></a><div class="element ajax clickable class" href="../classes/Firebird_Result.html"> <div id="Firebird_Result" class="element ajax clickable class">
<h1>Firebird_Result<a href="../classes/Firebird_Result.html"></a> <h1>Firebird_Result<a href="../classes/Firebird_Result.html"></a>
</h1> </h1>
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements <p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
@ -189,98 +198,98 @@ data-fetching methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird_Result.html" class="more">« More »</a> <a href="../classes/Firebird_Result.html" class="more">« More »</a>
</div> </div>
<a name="Firebird_SQL" id="Firebird_SQL"></a><div class="element ajax clickable class" href="../classes/Firebird_SQL.html"> <div id="Firebird_SQL" class="element ajax clickable class">
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html"></a> <h1>Firebird_SQL<a href="../classes/Firebird_SQL.html"></a>
</h1> </h1>
<p class="short_description">Firebird Specific SQL</p> <p class="short_description">Firebird Specific SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird_SQL.html" class="more">« More »</a> <a href="../classes/Firebird_SQL.html" class="more">« More »</a>
</div> </div>
<a name="Firebird_Util" id="Firebird_Util"></a><div class="element ajax clickable class" href="../classes/Firebird_Util.html"> <div id="Firebird_Util" class="element ajax clickable class">
<h1>Firebird_Util<a href="../classes/Firebird_Util.html"></a> <h1>Firebird_Util<a href="../classes/Firebird_Util.html"></a>
</h1> </h1>
<p class="short_description">Firebird-specific backup, import and creation methods</p> <p class="short_description">Firebird-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Firebird_Util.html" class="more">« More »</a> <a href="../classes/Firebird_Util.html" class="more">« More »</a>
</div> </div>
<a name="MySQL" id="MySQL"></a><div class="element ajax clickable class" href="../classes/MySQL.html"> <div id="MySQL" class="element ajax clickable class">
<h1>MySQL<a href="../classes/MySQL.html"></a> <h1>MySQL<a href="../classes/MySQL.html"></a>
</h1> </h1>
<p class="short_description">MySQL specific class</p> <p class="short_description">MySQL specific class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/MySQL.html" class="more">« More »</a> <a href="../classes/MySQL.html" class="more">« More »</a>
</div> </div>
<a name="MySQL_SQL" id="MySQL_SQL"></a><div class="element ajax clickable class" href="../classes/MySQL_SQL.html"> <div id="MySQL_SQL" class="element ajax clickable class">
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html"></a> <h1>MySQL_SQL<a href="../classes/MySQL_SQL.html"></a>
</h1> </h1>
<p class="short_description">MySQL specifc SQL</p> <p class="short_description">MySQL specifc SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/MySQL_SQL.html" class="more">« More »</a> <a href="../classes/MySQL_SQL.html" class="more">« More »</a>
</div> </div>
<a name="MySQL_Util" id="MySQL_Util"></a><div class="element ajax clickable class" href="../classes/MySQL_Util.html"> <div id="MySQL_Util" class="element ajax clickable class">
<h1>MySQL_Util<a href="../classes/MySQL_Util.html"></a> <h1>MySQL_Util<a href="../classes/MySQL_Util.html"></a>
</h1> </h1>
<p class="short_description">MySQL-specific backup, import and creation methods</p> <p class="short_description">MySQL-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/MySQL_Util.html" class="more">« More »</a> <a href="../classes/MySQL_Util.html" class="more">« More »</a>
</div> </div>
<a name="ODBC" id="ODBC"></a><div class="element ajax clickable class" href="../classes/ODBC.html"> <div id="ODBC" class="element ajax clickable class">
<h1>ODBC<a href="../classes/ODBC.html"></a> <h1>ODBC<a href="../classes/ODBC.html"></a>
</h1> </h1>
<p class="short_description">ODBC Database Driver</p> <p class="short_description">ODBC Database Driver</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/ODBC.html" class="more">« More »</a> <a href="../classes/ODBC.html" class="more">« More »</a>
</div> </div>
<a name="ODBC_SQL" id="ODBC_SQL"></a><div class="element ajax clickable class" href="../classes/ODBC_SQL.html"> <div id="ODBC_SQL" class="element ajax clickable class">
<h1>ODBC_SQL<a href="../classes/ODBC_SQL.html"></a> <h1>ODBC_SQL<a href="../classes/ODBC_SQL.html"></a>
</h1> </h1>
<p class="short_description">ODBC SQL Class</p> <p class="short_description">ODBC SQL Class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/ODBC_SQL.html" class="more">« More »</a> <a href="../classes/ODBC_SQL.html" class="more">« More »</a>
</div> </div>
<a name="ODBC_Util" id="ODBC_Util"></a><div class="element ajax clickable class" href="../classes/ODBC_Util.html"> <div id="ODBC_Util" class="element ajax clickable class">
<h1>ODBC_Util<a href="../classes/ODBC_Util.html"></a> <h1>ODBC_Util<a href="../classes/ODBC_Util.html"></a>
</h1> </h1>
<p class="short_description">ODBC-specific backup, import and creation methods</p> <p class="short_description">ODBC-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/ODBC_Util.html" class="more">« More »</a> <a href="../classes/ODBC_Util.html" class="more">« More »</a>
</div> </div>
<a name="PgSQL" id="PgSQL"></a><div class="element ajax clickable class" href="../classes/PgSQL.html"> <div id="PgSQL" class="element ajax clickable class">
<h1>PgSQL<a href="../classes/PgSQL.html"></a> <h1>PgSQL<a href="../classes/PgSQL.html"></a>
</h1> </h1>
<p class="short_description">PostgreSQL specifc class</p> <p class="short_description">PostgreSQL specifc class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/PgSQL.html" class="more">« More »</a> <a href="../classes/PgSQL.html" class="more">« More »</a>
</div> </div>
<a name="PgSQL_SQL" id="PgSQL_SQL"></a><div class="element ajax clickable class" href="../classes/PgSQL_SQL.html"> <div id="PgSQL_SQL" class="element ajax clickable class">
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html"></a> <h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html"></a>
</h1> </h1>
<p class="short_description">PostgreSQL specifc SQL</p> <p class="short_description">PostgreSQL specifc SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a> <a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
</div> </div>
<a name="PgSQL_Util" id="PgSQL_Util"></a><div class="element ajax clickable class" href="../classes/PgSQL_Util.html"> <div id="PgSQL_Util" class="element ajax clickable class">
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html"></a> <h1>PgSQL_Util<a href="../classes/PgSQL_Util.html"></a>
</h1> </h1>
<p class="short_description">Posgres-specific backup, import and creation methods</p> <p class="short_description">Posgres-specific backup, import and creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/PgSQL_Util.html" class="more">« More »</a> <a href="../classes/PgSQL_Util.html" class="more">« More »</a>
</div> </div>
<a name="SQLite" id="SQLite"></a><div class="element ajax clickable class" href="../classes/SQLite.html"> <div id="SQLite" class="element ajax clickable class">
<h1>SQLite<a href="../classes/SQLite.html"></a> <h1>SQLite<a href="../classes/SQLite.html"></a>
</h1> </h1>
<p class="short_description">SQLite specific class</p> <p class="short_description">SQLite specific class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/SQLite.html" class="more">« More »</a> <a href="../classes/SQLite.html" class="more">« More »</a>
</div> </div>
<a name="SQLite_SQL" id="SQLite_SQL"></a><div class="element ajax clickable class" href="../classes/SQLite_SQL.html"> <div id="SQLite_SQL" class="element ajax clickable class">
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html"></a> <h1>SQLite_SQL<a href="../classes/SQLite_SQL.html"></a>
</h1> </h1>
<p class="short_description">SQLite Specific SQL</p> <p class="short_description">SQLite Specific SQL</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/SQLite_SQL.html" class="more">« More »</a> <a href="../classes/SQLite_SQL.html" class="more">« More »</a>
</div> </div>
<a name="SQLite_Util" id="SQLite_Util"></a><div class="element ajax clickable class" href="../classes/SQLite_Util.html"> <div id="SQLite_Util" class="element ajax clickable class">
<h1>SQLite_Util<a href="../classes/SQLite_Util.html"></a> <h1>SQLite_Util<a href="../classes/SQLite_Util.html"></a>
</h1> </h1>
<p class="short_description">SQLite-specific backup, import and creation methods</p> <p class="short_description">SQLite-specific backup, import and creation methods</p>
@ -288,59 +297,58 @@ data-fetching methods</p>
<a href="../classes/SQLite_Util.html" class="more">« More »</a> <a href="../classes/SQLite_Util.html" class="more">« More »</a>
</div> </div>
</div> </div>
<ul class="breadcrumb"> <ul class="breadcrumb"><li>
<li> <a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li><a href="../packages/Query.html">Query</a></li>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span> <li class="active">
<span class="divider">\</span><a href="../packages/Query.Query.html">Query</a>
</li> </li>
<li><a href="../packages/Query.html">Query</a></li> </li></ul>
<span class="divider">\</span><li class="active"><a href="../packages/Query.Query.html">Query</a></li>
</ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="iDB_SQL" id="iDB_SQL"></a><div class="element ajax clickable interface" href="../classes/iDB_SQL.html"> <div id="iDB_SQL" class="element ajax clickable interface">
<h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a> <h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a>
</h1> </h1>
<p class="short_description">parent for database manipulation subclasses</p> <p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/iDB_SQL.html" class="more">« More »</a> <a href="../classes/iDB_SQL.html" class="more">« More »</a>
</div> </div>
<a name="iQuery_Builder" id="iQuery_Builder"></a><div class="element ajax clickable interface" href="../classes/iQuery_Builder.html"> <div id="iQuery_Builder" class="element ajax clickable interface">
<h1>iQuery_Builder<a href="../classes/iQuery_Builder.html"></a> <h1>iQuery_Builder<a href="../classes/iQuery_Builder.html"></a>
</h1> </h1>
<p class="short_description">Interface defining the Query Builder class</p> <p class="short_description">Interface defining the Query Builder class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/iQuery_Builder.html" class="more">« More »</a> <a href="../classes/iQuery_Builder.html" class="more">« More »</a>
</div> </div>
<a name="BadConnectionException" id="BadConnectionException"></a><div class="element ajax clickable class" href="../classes/BadConnectionException.html"> <div id="BadConnectionException" class="element ajax clickable class">
<h1>BadConnectionException<a href="../classes/BadConnectionException.html"></a> <h1>BadConnectionException<a href="../classes/BadConnectionException.html"></a>
</h1> </h1>
<p class="short_description">Generic exception for bad connection strings</p> <p class="short_description">Generic exception for bad connection strings</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/BadConnectionException.html" class="more">« More »</a> <a href="../classes/BadConnectionException.html" class="more">« More »</a>
</div> </div>
<a name="BadDBDriverException" id="BadDBDriverException"></a><div class="element ajax clickable class" href="../classes/BadDBDriverException.html"> <div id="BadDBDriverException" class="element ajax clickable class">
<h1>BadDBDriverException<a href="../classes/BadDBDriverException.html"></a> <h1>BadDBDriverException<a href="../classes/BadDBDriverException.html"></a>
</h1> </h1>
<p class="short_description">Generic exception for bad drivers</p> <p class="short_description">Generic exception for bad drivers</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/BadDBDriverException.html" class="more">« More »</a> <a href="../classes/BadDBDriverException.html" class="more">« More »</a>
</div> </div>
<a name="DB_PDO" id="DB_PDO"></a><div class="element ajax clickable class" href="../classes/DB_PDO.html"> <div id="DB_PDO" class="element ajax clickable class">
<h1>DB_PDO<a href="../classes/DB_PDO.html"></a> <h1>DB_PDO<a href="../classes/DB_PDO.html"></a>
</h1> </h1>
<p class="short_description">Base Database class</p> <p class="short_description">Base Database class</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/DB_PDO.html" class="more">« More »</a> <a href="../classes/DB_PDO.html" class="more">« More »</a>
</div> </div>
<a name="DB_Util" id="DB_Util"></a><div class="element ajax clickable class" href="../classes/DB_Util.html"> <div id="DB_Util" class="element ajax clickable class">
<h1>DB_Util<a href="../classes/DB_Util.html"></a> <h1>DB_Util<a href="../classes/DB_Util.html"></a>
</h1> </h1>
<p class="short_description">Abstract class defining database / table creation methods</p> <p class="short_description">Abstract class defining database / table creation methods</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/DB_Util.html" class="more">« More »</a> <a href="../classes/DB_Util.html" class="more">« More »</a>
</div> </div>
<a name="Query_Builder" id="Query_Builder"></a><div class="element ajax clickable class" href="../classes/Query_Builder.html"> <div id="Query_Builder" class="element ajax clickable class">
<h1>Query_Builder<a href="../classes/Query_Builder.html"></a> <h1>Query_Builder<a href="../classes/Query_Builder.html"></a>
</h1> </h1>
<p class="short_description">Convienience class for creating sql queries - also the class that <p class="short_description">Convienience class for creating sql queries - also the class that
@ -348,7 +356,7 @@ instantiates the specific db driver</p>
<div class="details collapse"></div> <div class="details collapse"></div>
<a href="../classes/Query_Builder.html" class="more">« More »</a> <a href="../classes/Query_Builder.html" class="more">« More »</a>
</div> </div>
<a name="Query_Parser" id="Query_Parser"></a><div class="element ajax clickable class" href="../classes/Query_Parser.html"> <div id="Query_Parser" class="element ajax clickable class">
<h1>Query_Parser<a href="../classes/Query_Parser.html"></a> <h1>Query_Parser<a href="../classes/Query_Parser.html"></a>
</h1> </h1>
<p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p> <p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p>
@ -361,8 +369,9 @@ instantiates the specific db driver</p>
</div> </div>
<div class="row"><footer class="span12"> <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> 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> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.1.0
generated on 2013-05-03T13:07:08-04:00.<br></footer></div> </a> and<br>
generated on 2013-12-06T22:52:34-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

8593
docs/structure.xml
View File

File diff suppressed because one or more lines are too long

4
phpdoc.dist.xml
View File

@ -13,6 +13,10 @@
<files> <files>
<directory>.</directory> <directory>.</directory>
<directory>tests</directory> <directory>tests</directory>
<directory>coverage</directory>
<directory>vendor</directory>
<ignore>tests/*</ignore> <ignore>tests/*</ignore>
<ignore>coverage/*</ignore>
<ignore>vendor/*</ignore>
</files> </files>
</phpdoc> </phpdoc>

236
tests/core/db_qb_test.php
View File

@ -20,7 +20,10 @@ abstract class QBTest extends UnitTestCase {
public function __destruct() public function __destruct()
{ {
//echo '<pre>' . print_r($this->db->queries, TRUE) . '</pre>'; if (isset($_GET['show_queries']))
{
echo '<pre>' . print_r($this->db->queries, TRUE) . '</pre>';
}
} }
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
@ -173,6 +176,8 @@ abstract class QBTest extends UnitTestCase {
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
@ -223,7 +228,67 @@ abstract class QBTest extends UnitTestCase {
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
// --------------------------------------------------------------------------
// ! Grouping Tests
// --------------------------------------------------------------------------
public function TestGroup()
{
if (empty($this->db)) return;
$query = $this->db->select('id, key as k, val')
->from('create_test')
->group_start()
->where('id >', 1)
->where('id <', 900)
->group_end()
->limit(2, 1)
->get();
$this->assertIsA($query, 'PDOStatement');
}
public function TestOrGroup()
{
if (empty($this->db)) return;
$query = $this->db->select('id, key as k, val')
->from('create_test')
->group_start()
->where('id >', 1)
->where('id <', 900)
->group_end()
->or_group_start()
->where('id =', 0)
->group_end()
->limit(2, 1)
->get();
$this->assertIsA($query, 'PDOStatement');
}
public function TestOrNotGroup()
{
if (empty($this->db)) return;
$query = $this->db->select('id, key as k, val')
->from('create_test')
->group_start()
->where('id >', 1)
->where('id <', 900)
->group_end()
->or_not_group_start()
->where('id =', 0)
->group_end()
->limit(2, 1)
->get();
$this->assertIsA($query, 'PDOStatement');
}
// --------------------------------------------------------------------------
// ! Where In Tests
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
public function TestWhereIn() public function TestWhereIn()
@ -236,6 +301,48 @@ abstract class QBTest extends UnitTestCase {
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
// --------------------------------------------------------------------------
public function TestOrWhereIn()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->where('key', 'false')
->or_where_in('id', array(0, 6, 56, 563, 341))
->get();
$this->assertIsA($query, 'PDOStatement');
}
// --------------------------------------------------------------------------
public function TestWhereNotIn()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->where('key', 'false')
->where_not_in('id', array(0, 6, 56, 563, 341))
->get();
$this->assertIsA($query, 'PDOStatement');
}
// --------------------------------------------------------------------------
public function TestOrWhereNotIn()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->where('key', 'false')
->or_where_not_in('id', array(0, 6, 56, 563, 341))
->get();
$this->assertIsA($query, 'PDOStatement');
}
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
@ -363,8 +470,7 @@ abstract class QBTest extends UnitTestCase {
->where('id >', 0) ->where('id >', 0)
->where('id <', 9000) ->where('id <', 9000)
->group_by('k') ->group_by('k')
->group_by('id') ->group_by(array('id','val'))
->group_by('val')
->order_by('id', 'DESC') ->order_by('id', 'DESC')
->order_by('k', 'ASC') ->order_by('k', 'ASC')
->limit(5,2) ->limit(5,2)
@ -373,6 +479,10 @@ abstract class QBTest extends UnitTestCase {
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
// --------------------------------------------------------------------------
//public function TestOr
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
public function TestOrWhere() public function TestOrWhere()
@ -401,6 +511,74 @@ abstract class QBTest extends UnitTestCase {
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
// --------------------------------------------------------------------------
public function TestOrLike()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->like('key', 'og')
->or_like('key', 'val')
->get();
$this->assertIsA($query, 'PDOStatement');
}
// --------------------------------------------------------------------------
public function TestOrNotLike()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->like('key', 'og', 'before')
->or_not_like('key', 'val')
->get();
$this->assertIsA($query, 'PDOStatement');
}
// --------------------------------------------------------------------------
public function TestNotLike()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->like('key', 'og', 'before')
->not_like('key', 'val')
->get();
$this->assertIsA($query, 'PDOStatement');
}
// --------------------------------------------------------------------------
public function TestLikeBefore()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->like('key', 'og', 'before')
->get();
$this->assertIsA($query, 'PDOStatement');
}
// --------------------------------------------------------------------------
public function TestLikeAfter()
{
if (empty($this->db)) return;
$query = $this->db->from('create_test')
->like('key', 'og', 'after')
->get();
$this->assertIsA($query, 'PDOStatement');
}
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
@ -457,6 +635,21 @@ abstract class QBTest extends UnitTestCase {
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
// --------------------------------------------------------------------------
public function TestInsertArray()
{
if (empty($this->db)) return;
$query = $this->db->insert('test', array(
'id' => 587,
'key' => 1,
'val' => 2,
));
$this->assertIsA($query, 'PDOStatement');
}
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
public function TestInsertBatch() public function TestInsertBatch()
@ -492,11 +685,12 @@ abstract class QBTest extends UnitTestCase {
{ {
if (empty($this->db)) return; if (empty($this->db)) return;
$query = $this->db->set('id', 4) $query = $this->db->where('id', 4)
->set('key', 'gogle') ->update('create_test', array(
->set('val', 'non-word') 'id' => 4,
->where('id', 4) 'key' => 'gogle',
->update('create_test'); 'val' => 'non-word'
));
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
@ -541,7 +735,7 @@ abstract class QBTest extends UnitTestCase {
{ {
if (empty($this->db)) return; if (empty($this->db)) return;
$query = $this->db->where('id', 4)->delete('create_test'); $query = $this->db->delete('create_test', array('id' => 4));
$this->assertIsA($query, 'PDOStatement'); $this->assertIsA($query, 'PDOStatement');
} }
@ -592,6 +786,19 @@ abstract class QBTest extends UnitTestCase {
$this->assertTrue(is_numeric($this->db->num_rows())); $this->assertTrue(is_numeric($this->db->num_rows()));
} }
// --------------------------------------------------------------------------
// ! Compiled Query Tests
// --------------------------------------------------------------------------
public function TestGetCompiledSelect()
{
$sql = $this->db->from('create_test')->get_compled_select('', FALSE);
$qb_res = $this->db->get();
$sql_res = $this->db->query($sql);
$this->assertEqual($qb_res, $sql_res);
}
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
// ! Error Tests // ! Error Tests
@ -626,7 +833,8 @@ abstract class QBTest extends UnitTestCase {
'database' => 'test', 'database' => 'test',
'user' => NULL, 'user' => NULL,
'pass' => NULL, 'pass' => NULL,
'type' => 'mysql' 'type' => 'mysql',
'name' => 'foobar'
); );
$this->expectException('BadConnectionException'); $this->expectException('BadConnectionException');
@ -634,6 +842,14 @@ abstract class QBTest extends UnitTestCase {
$this->db = @Query($params); $this->db = @Query($params);
} }
// --------------------------------------------------------------------------
public function TestBadMethod()
{
$res = $this->db->foo();
$this->assertEqual(NULL, $res);
}
} }
// End of db_qb_test.php // End of db_qb_test.php

1
tests/databases/firebird/firebird-qb.php
View File

@ -26,6 +26,7 @@ class FirebirdQBTest extends QBTest {
// Test the query builder // Test the query builder
$params = new Stdclass(); $params = new Stdclass();
$params->name = 'fire';
$params->type = 'firebird'; $params->type = 'firebird';
$params->file = $dbpath; $params->file = $dbpath;
$params->host = 'localhost'; $params->host = 'localhost';

1
tests/databases/firebird/firebird.php
View File

@ -42,6 +42,7 @@ class FirebirdTest extends DBTest {
public function TestExists() public function TestExists()
{ {
$this->assertTrue(function_exists('ibase_connect')); $this->assertTrue(function_exists('ibase_connect'));
$this->assertTrue(function_exists('fbird_connect'));
} }
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------

BIN
tests/db_files/FB_TEST_DB.FDB
View File

Binary file not shown.

1
tests/php_test.ini Normal file
View File

@ -0,0 +1 @@
zend_extension="xdebug.so"

12
tests/simpletest/autorun.php
View File

@ -51,7 +51,17 @@ function run_local_tests() {
$suite = $loader->createSuiteFromClasses( $suite = $loader->createSuiteFromClasses(
basename(initial_file()), basename(initial_file()),
$loader->selectRunnableTests($candidates)); $loader->selectRunnableTests($candidates));
return $suite->run(new DefaultReporter()); if (function_exists("xdebug_start_code_coverage")) {
$coverage = new PHP_CodeCoverage;
$coverage->start('Query');
}
$ret = $suite->run(new DefaultReporter());
if (function_exists("xdebug_start_code_coverage")) {
$coverage->stop();
$writer = new PHP_CodeCoverage_Report_HTML;
$writer->process($coverage, QBASE_DIR . '/coverage/');
}
return $ret;
} catch (Exception $stack_frame_fix) { } catch (Exception $stack_frame_fix) {
print $stack_frame_fix->getMessage(); print $stack_frame_fix->getMessage();
return false; return false;