Query/docs/classes/Query.Drivers.DriverInterfa...

1848 lines
101 KiB
HTML
Raw Normal View History

2017-02-28 16:37:16 -05:00
<!DOCTYPE html>
<html lang="en">
<head>
<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=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/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">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">Query</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown">
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="../namespaces/Query.html">\Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">31</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">0</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1267959577"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1267959577" class="accordion-body collapse in">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-176910450"></a>
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
</div>
<div id="namespace-176910450" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-651832676"></a>
<a href="../namespaces/Query.Drivers.html" style="margin-left: 30px; padding-left: 0">Drivers</a>
</div>
<div id="namespace-651832676" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1658104378"></a>
<a href="../namespaces/Query.Drivers.Firebird.html" style="margin-left: 30px; padding-left: 0">Firebird</a>
</div>
<div id="namespace-1658104378" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Firebird.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Firebird.Result.html">Result</a></li>
<li class="class"><a href="../classes/Query.Drivers.Firebird.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Firebird.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-722363787"></a>
<a href="../namespaces/Query.Drivers.Mysql.html" style="margin-left: 30px; padding-left: 0">Mysql</a>
</div>
<div id="namespace-722363787" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Mysql.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Mysql.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Mysql.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1686235912"></a>
<a href="../namespaces/Query.Drivers.Pgsql.html" style="margin-left: 30px; padding-left: 0">Pgsql</a>
</div>
<div id="namespace-1686235912" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Pgsql.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pgsql.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pgsql.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1281454386"></a>
<a href="../namespaces/Query.Drivers.Sqlite.html" style="margin-left: 30px; padding-left: 0">Sqlite</a>
</div>
<div id="namespace-1281454386" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Sqlite.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Sqlite.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Sqlite.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.Drivers.DriverInterface.html">DriverInterface</a></li>
<li class="interface"><a href="../classes/Query.Drivers.PDOInterface.html">PDOInterface</a></li>
<li class="interface"><a href="../classes/Query.Drivers.PDOStatementInterface.html">PDOStatementInterface</a></li>
<li class="interface"><a href="../classes/Query.Drivers.SQLInterface.html">SQLInterface</a></li>
<li class="class"><a href="../classes/Query.Drivers.AbstractDriver.html">AbstractDriver</a></li>
<li class="class"><a href="../classes/Query.Drivers.AbstractSQL.html">AbstractSQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.AbstractUtil.html">AbstractUtil</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.QueryBuilderInterface.html">QueryBuilderInterface</a></li>
<li class="class"><a href="../classes/Query.AbstractQueryBuilder.html">AbstractQueryBuilder</a></li>
<li class="class"><a href="../classes/Query.BadDBDriverException.html">BadDBDriverException</a></li>
<li class="class"><a href="../classes/Query.ConnectionManager.html">ConnectionManager</a></li>
<li class="class"><a href="../classes/Query.DriverFactory.html">DriverFactory</a></li>
<li class="class"><a href="../classes/Query.QueryBuilder.html">QueryBuilder</a></li>
<li class="class"><a href="../classes/Query.QueryParser.html">QueryParser</a></li>
<li class="class"><a href="../classes/Query.State.html">State</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/Query.Drivers.html">\Query\Drivers</a>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\Query\Drivers</small>DriverInterface</h1>
<p><em>PDO Interface to implement for database drivers</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span6">
<a href="#methods">Methods</a>
</section>
<section class="span6">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span6">
<a href="../classes/Query.Drivers.DriverInterface.html#method___construct">__construct()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_beginTransaction">beginTransaction()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_commit">commit()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_errorCode">errorCode()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_errorInfo">errorInfo()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_exec">exec()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_getAttribute">getAttribute()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_getAvailableDrivers">getAvailableDrivers()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_inTransaction">inTransaction()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_lastInsertId">lastInsertId()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_prepare">prepare()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_query">query()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_quote">quote()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_rollBack">rollBack()</a><br />
<a href="../classes/Query.Drivers.PDOInterface.html#method_setAttribute">setAttribute()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_prepareQuery">prepareQuery()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getColumns">getColumns()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getTypes">getTypes()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getIndexes">getIndexes()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getFks">getFks()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getTables">getTables()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getSystemTables">getSystemTables()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getDbs">getDbs()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getViews">getViews()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getSequences">getSequences()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getFunctions">getFunctions()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getProcedures">getProcedures()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getTriggers">getTriggers()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_quoteIdent">quoteIdent()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_quoteTable">quoteTable()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_prepareExecute">prepareExecute()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_driverQuery">driverQuery()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_affectedRows">affectedRows()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_numRows">numRows()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_prefixTable">prefixTable()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_insertBatch">insertBatch()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_updateBatch">updateBatch()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getSql">getSql()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_getUtil">getUtil()</a><br />
<a href="../classes/Query.Drivers.DriverInterface.html#method_setLastQuery">setLastQuery()</a><br />
</section>
<section class="span6">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span6">
<em>No protected methods found</em>
</section>
<section class="span6">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span6">
<em>No private methods found</em>
</section>
<section class="span6">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd>
<a href="../files/Query.Drivers.DriverInterface.html"><div class="path-wrapper">Query/Drivers/DriverInterface.php</div></a>
</dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">\Default</div></dd>
<dt>Parents</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="namespace-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<h2>Methods</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method___construct" name="method___construct" class="anchor"></a>
<article class="method">
<h3 class="public ">__construct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">__construct(string <span class="argument">$dsn</span>, string <span class="argument">$username = NULL</span>, string <span class="argument">$password = NULL</span>, array <span class="argument">$driverOptions = array()</span>) </pre>
<p><em>Constructor/Connection method</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$dsn </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$username </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$password </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$driverOptions </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_beginTransaction" name="method_beginTransaction" class="anchor"></a>
<article class="method">
<h3 class="public ">beginTransaction()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">beginTransaction() : boolean</pre>
<p><em>Initiates a transaction</em></p>
<h4>Throws</h4>
<dl>
<dt>\PDOException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_commit" name="method_commit" class="anchor"></a>
<article class="method">
<h3 class="public ">commit()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">commit() : boolean</pre>
<p><em>Commits a transaction</em></p>
<h4>Throws</h4>
<dl>
<dt>\PDOException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_errorCode" name="method_errorCode" class="anchor"></a>
<article class="method">
<h3 class="public ">errorCode()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">errorCode() : mixed</pre>
<p><em>Fetch the SQLSTATE associated with the last operation on the database handle</em></p>
<h4>Returns</h4>
mixed
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_errorInfo" name="method_errorInfo" class="anchor"></a>
<article class="method">
<h3 class="public ">errorInfo()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">errorInfo() : array</pre>
<p><em>Fetch extended error information associated with the last operation on the database handle</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_exec" name="method_exec" class="anchor"></a>
<article class="method">
<h3 class="public ">exec()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">exec(string <span class="argument">$statement</span>) : integer</pre>
<p><em>Execute an SQL statement and return the number of affected rows</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$statement </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
integer
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getAttribute" name="method_getAttribute" class="anchor"></a>
<article class="method">
<h3 class="public ">getAttribute()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getAttribute(integer <span class="argument">$attribute</span>) : mixed</pre>
<p><em>Retrieve a database connection attribute</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$attribute </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
mixed
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getAvailableDrivers" name="method_getAvailableDrivers" class="anchor"></a>
<article class="method">
<h3 class="public ">getAvailableDrivers()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getAvailableDrivers() : array</pre>
<p><em>Return an array of available PDO drivers</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_inTransaction" name="method_inTransaction" class="anchor"></a>
<article class="method">
<h3 class="public ">inTransaction()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">inTransaction() : boolean</pre>
<p><em>Checks if inside a transaction</em></p>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_lastInsertId" name="method_lastInsertId" class="anchor"></a>
<article class="method">
<h3 class="public ">lastInsertId()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">lastInsertId(string <span class="argument">$name = NULL</span>) : string</pre>
<p><em>Returns teh ID of the last inserted row or sequence value</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name </td>
<td><p>Name of the sequence object from which the ID should be returned</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_prepare" name="method_prepare" class="anchor"></a>
<article class="method">
<h3 class="public ">prepare()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">prepare(string <span class="argument">$statement</span>, array <span class="argument">$options = NULL</span>) : \PDOStatement</pre>
<p><em>Prepares a statement for execution and returns a statement object</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$statement </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$options </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_query" name="method_query" class="anchor"></a>
<article class="method">
<h3 class="public ">query()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">query() : \PDOStatement</pre>
<p><em>Executes an SQL statement, returning a result set as a PDOStatement object</em></p>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_quote" name="method_quote" class="anchor"></a>
<article class="method">
<h3 class="public ">quote()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">quote(string <span class="argument">$string</span>, integer <span class="argument">$parameterType = \PDO::PARAM_STR</span>) : string|false</pre>
<p><em>Quotes a string for use in a query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$string </td>
<td></td>
</tr>
<tr>
<td>integer</td>
<td>$parameterType </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string|false
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_rollBack" name="method_rollBack" class="anchor"></a>
<article class="method">
<h3 class="public ">rollBack()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">rollBack() : boolean</pre>
<p><em>Rolls back a transaction</em></p>
<h4>Throws</h4>
<dl>
<dt>\PDOException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setAttribute" name="method_setAttribute" class="anchor"></a>
<article class="method">
<h3 class="public ">setAttribute()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setAttribute(integer <span class="argument">$attribute</span>, mixed <span class="argument">$value</span>) : boolean</pre>
<p><em>Set an attribute</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$attribute </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$value </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Query.Drivers.PDOInterface.html"><div class="path-wrapper">\Query\Drivers\PDOInterface</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_prepareQuery" name="method_prepareQuery" class="anchor"></a>
<article class="method">
<h3 class="public ">prepareQuery()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">prepareQuery(string <span class="argument">$sql</span>, array <span class="argument">$data</span>) : \PDOStatement</pre>
<p><em>Simplifies prepared statements for database queries</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$sql </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$data </td>
<td></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\InvalidArgumentException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
\PDOStatement
&mdash; <p>| FALSE</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getColumns" name="method_getColumns" class="anchor"></a>
<article class="method">
<h3 class="public ">getColumns()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getColumns(string <span class="argument">$table</span>) : array</pre>
<p><em>Retrieve column information for the current database table</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getTypes" name="method_getTypes" class="anchor"></a>
<article class="method">
<h3 class="public ">getTypes()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getTypes() : array</pre>
<p><em>Retrieve list of data types for the database</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getIndexes" name="method_getIndexes" class="anchor"></a>
<article class="method">
<h3 class="public ">getIndexes()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getIndexes(string <span class="argument">$table</span>) : array</pre>
<p><em>Retrieve indexes for the table</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getFks" name="method_getFks" class="anchor"></a>
<article class="method">
<h3 class="public ">getFks()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getFks(string <span class="argument">$table</span>) : array</pre>
<p><em>Retrieve foreign keys for the table</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getTables" name="method_getTables" class="anchor"></a>
<article class="method">
<h3 class="public ">getTables()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getTables() : array</pre>
<p><em>Return list of tables for the current database</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getSystemTables" name="method_getSystemTables" class="anchor"></a>
<article class="method">
<h3 class="public ">getSystemTables()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getSystemTables() : array</pre>
<p><em>Retrieves an array of non-user-created tables for
the connection/database</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getDbs" name="method_getDbs" class="anchor"></a>
<article class="method">
<h3 class="public ">getDbs()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getDbs() : array</pre>
<p><em>Return list of dbs for the current connection, if possible</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getViews" name="method_getViews" class="anchor"></a>
<article class="method">
<h3 class="public ">getViews()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getViews() : array</pre>
<p><em>Return list of views for the current database</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getSequences" name="method_getSequences" class="anchor"></a>
<article class="method">
<h3 class="public ">getSequences()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getSequences() : array</pre>
<p><em>Return list of sequences for the current database, if they exist</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getFunctions" name="method_getFunctions" class="anchor"></a>
<article class="method">
<h3 class="public ">getFunctions()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getFunctions() : array</pre>
<p><em>Return list of functions for the current database</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getProcedures" name="method_getProcedures" class="anchor"></a>
<article class="method">
<h3 class="public ">getProcedures()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getProcedures() : array</pre>
<p><em>Return list of stored procedures for the current database</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getTriggers" name="method_getTriggers" class="anchor"></a>
<article class="method">
<h3 class="public ">getTriggers()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getTriggers() : array</pre>
<p><em>Return list of triggers for the current database</em></p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_quoteIdent" name="method_quoteIdent" class="anchor"></a>
<article class="method">
<h3 class="public ">quoteIdent()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">quoteIdent(string|array <span class="argument">$ident</span>) : string|array</pre>
<p><em>Surrounds the string with the databases identifier escape characters</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string|array</td>
<td>$ident </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string|array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_quoteTable" name="method_quoteTable" class="anchor"></a>
<article class="method">
<h3 class="public ">quoteTable()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">quoteTable(string|array <span class="argument">$table</span>) : string|array</pre>
<p><em>Quote database table name, and set prefix</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string|array</td>
<td>$table </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string|array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_prepareExecute" name="method_prepareExecute" class="anchor"></a>
<article class="method">
<h3 class="public ">prepareExecute()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">prepareExecute(string <span class="argument">$sql</span>, array <span class="argument">$params</span>) : \PDOStatement</pre>
<p><em>Create and execute a prepared statement with the provided parameters</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$sql </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$params </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_driverQuery" name="method_driverQuery" class="anchor"></a>
<article class="method">
<h3 class="public ">driverQuery()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">driverQuery(string|array|null <span class="argument">$query</span>, boolean <span class="argument">$filteredIndex = TRUE</span>) : array</pre>
<p><em>Method to simplify retrieving db results for meta-data queries</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string|array|null</td>
<td>$query </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$filteredIndex </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_affectedRows" name="method_affectedRows" class="anchor"></a>
<article class="method">
<h3 class="public ">affectedRows()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">affectedRows() : integer</pre>
<p><em>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</em></p>
<h4>Returns</h4>
integer
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_numRows" name="method_numRows" class="anchor"></a>
<article class="method">
<h3 class="public ">numRows()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">numRows() : integer</pre>
<p><em>Return the number of rows returned for a SELECT query</em></p>
<h4>Returns</h4>
integer
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://us3.php.net/manual/en/pdostatement.rowcount.php#87110"><span class="namespace-wrapper">http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_prefixTable" name="method_prefixTable" class="anchor"></a>
<article class="method">
<h3 class="public ">prefixTable()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">prefixTable(string <span class="argument">$table</span>) : string</pre>
<p><em>Prefixes a table if it is not already prefixed</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_insertBatch" name="method_insertBatch" class="anchor"></a>
<article class="method">
<h3 class="public ">insertBatch()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">insertBatch(string <span class="argument">$table</span>, array <span class="argument">$data = array()</span>) : array</pre>
<p><em>Create sql for batch insert</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$data </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_updateBatch" name="method_updateBatch" class="anchor"></a>
<article class="method">
<h3 class="public ">updateBatch()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">updateBatch(string <span class="argument">$table</span>, array|object <span class="argument">$data</span>, string <span class="argument">$where</span>) : integer|null</pre>
<p><em>Creates a batch update, and executes it.</em></p>
<p>Returns the number of affected rows</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>array|object</td>
<td>$data </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$where </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
integer|null
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getSql" name="method_getSql" class="anchor"></a>
<article class="method">
<h3 class="public ">getSql()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getSql() : \Query\Drivers\SQLInterface</pre>
<p><em>Get the SQL class for the current driver</em></p>
<h4>Returns</h4>
<a href="../classes/Query.Drivers.SQLInterface.html">\Query\Drivers\SQLInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getUtil" name="method_getUtil" class="anchor"></a>
<article class="method">
<h3 class="public ">getUtil()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getUtil() : \Query\Drivers\AbstractUtil</pre>
<p><em>Get the Util class for the current driver</em></p>
<h4>Returns</h4>
<a href="../classes/Query.Drivers.AbstractUtil.html">\Query\Drivers\AbstractUtil</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setLastQuery" name="method_setLastQuery" class="anchor"></a>
<article class="method">
<h3 class="public ">setLastQuery()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setLastQuery(string <span class="argument">$queryString</span>) : void</pre>
<p><em>Set the last query sql</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$queryString </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">DriverInterface.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/Query/Drivers/DriverInterface.php.txt" class="language-php"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
<li><a href="../namespaces/Query.html">\Query</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on February 28th, 2017 at 21:36.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>