Query/docs/classes/Query.Driver_Interface.html
2015-08-25 13:45:40 -04:00

1528 lines
82 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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">0</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">1</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">1</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-1738069439"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1738069439" 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-1920375455"></a>
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
</div>
<div id="namespace-1920375455" 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-1733751916"></a>
<a href="../namespaces/Query.Drivers.html" style="margin-left: 30px; padding-left: 0">Drivers</a>
</div>
<div id="namespace-1733751916" 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-1764095543"></a>
<a href="../namespaces/Query.Drivers.Firebird.html" style="margin-left: 30px; padding-left: 0">Firebird</a>
</div>
<div id="namespace-1764095543" 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-502835022"></a>
<a href="../namespaces/Query.Drivers.Mysql.html" style="margin-left: 30px; padding-left: 0">Mysql</a>
</div>
<div id="namespace-502835022" 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-1162711144"></a>
<a href="../namespaces/Query.Drivers.Pdo_firebird.html" style="margin-left: 30px; padding-left: 0">Pdo_firebird</a>
</div>
<div id="namespace-1162711144" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Pdo_firebird.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pdo_firebird.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pdo_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-943134932"></a>
<a href="../namespaces/Query.Drivers.Pgsql.html" style="margin-left: 30px; padding-left: 0">Pgsql</a>
</div>
<div id="namespace-943134932" 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-1279523007"></a>
<a href="../namespaces/Query.Drivers.Sqlite.html" style="margin-left: 30px; padding-left: 0">Sqlite</a>
</div>
<div id="namespace-1279523007" 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>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.Driver_Interface.html">Driver_Interface</a></li>
<li class="interface"><a href="../classes/Query.Query_Builder_Interface.html">Query_Builder_Interface</a></li>
<li class="interface"><a href="../classes/Query.SQL_Interface.html">SQL_Interface</a></li>
<li class="class"><a href="../classes/Query.Abstract_Driver.html">Abstract_Driver</a></li>
<li class="class"><a href="../classes/Query.Abstract_Query_Builder.html">Abstract_Query_Builder</a></li>
<li class="class"><a href="../classes/Query.Abstract_SQL.html">Abstract_SQL</a></li>
<li class="class"><a href="../classes/Query.Abstract_Util.html">Abstract_Util</a></li>
<li class="class"><a href="../classes/Query.BadDBDriverException.html">BadDBDriverException</a></li>
<li class="class"><a href="../classes/Query.Connection_Manager.html">Connection_Manager</a></li>
<li class="class"><a href="../classes/Query.Query_Builder.html">Query_Builder</a></li>
<li class="class"><a href="../classes/Query.Query_Parser.html">Query_Parser</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.html">\Query</a>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\Query</small>Driver_Interface</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.Driver_Interface.html#method___construct">__construct()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_prepare_query">prepare_query()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_beginTransaction">beginTransaction()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_commit">commit()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_errorCode">errorCode()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_errorInfo">errorInfo()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_exec">exec()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_getAttribute">getAttribute()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_rollback">rollback()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_setAttribute">setAttribute()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_columns">get_columns()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_types">get_types()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_indexes">get_indexes()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_fks">get_fks()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_tables">get_tables()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_system_tables">get_system_tables()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_dbs">get_dbs()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_views">get_views()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_sequences">get_sequences()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_functions">get_functions()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_procedures">get_procedures()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_triggers">get_triggers()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_quote_ident">quote_ident()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_quote_table">quote_table()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_prepare_execute">prepare_execute()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_sql">get_sql()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_get_util">get_util()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_driver_query">driver_query()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_affected_rows">affected_rows()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_num_rows">num_rows()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_prefix_table">prefix_table()</a><br />
<a href="../classes/Query.Driver_Interface.html#method_insert_batch">insert_batch()</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/src.Query.Driver_Interface.html"><div class="path-wrapper">src/Query/Driver_Interface.php</div></a>
</dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">\Query\Drivers</div></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">$driver_options = 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>$driver_options </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_prepare_query" name="method_prepare_query" class="anchor"></a>
<article class="method">
<h3 class="public ">prepare_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;">prepare_query(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_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>Begin a transaction</em></p>
<h4>Returns</h4>
boolean
</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_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>Commit a transaction</em></p>
<h4>Returns</h4>
boolean
</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_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>Return the current error code</em></p>
<h4>Returns</h4>
mixed
</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_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>Return information about the current error</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_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>
</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>Get a connection attribute for the current db driver</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>
</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>Rollback a transaction</em></p>
<h4>Returns</h4>
boolean
</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_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 a connection 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>
</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_get_columns" name="method_get_columns" class="anchor"></a>
<article class="method">
<h3 class="public ">get_columns()</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;">get_columns(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_get_types" name="method_get_types" class="anchor"></a>
<article class="method">
<h3 class="public ">get_types()</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;">get_types() : 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_get_indexes" name="method_get_indexes" class="anchor"></a>
<article class="method">
<h3 class="public ">get_indexes()</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;">get_indexes(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_get_fks" name="method_get_fks" class="anchor"></a>
<article class="method">
<h3 class="public ">get_fks()</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;">get_fks(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_get_tables" name="method_get_tables" class="anchor"></a>
<article class="method">
<h3 class="public ">get_tables()</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;">get_tables() : 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_get_system_tables" name="method_get_system_tables" class="anchor"></a>
<article class="method">
<h3 class="public ">get_system_tables()</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;">get_system_tables() : 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_get_dbs" name="method_get_dbs" class="anchor"></a>
<article class="method">
<h3 class="public ">get_dbs()</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;">get_dbs() : 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_get_views" name="method_get_views" class="anchor"></a>
<article class="method">
<h3 class="public ">get_views()</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;">get_views() : 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_get_sequences" name="method_get_sequences" class="anchor"></a>
<article class="method">
<h3 class="public ">get_sequences()</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;">get_sequences() : 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_get_functions" name="method_get_functions" class="anchor"></a>
<article class="method">
<h3 class="public ">get_functions()</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;">get_functions() : 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_get_procedures" name="method_get_procedures" class="anchor"></a>
<article class="method">
<h3 class="public ">get_procedures()</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;">get_procedures() : 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_get_triggers" name="method_get_triggers" class="anchor"></a>
<article class="method">
<h3 class="public ">get_triggers()</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;">get_triggers() : 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_quote_ident" name="method_quote_ident" class="anchor"></a>
<article class="method">
<h3 class="public ">quote_ident()</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_ident(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_quote_table" name="method_quote_table" class="anchor"></a>
<article class="method">
<h3 class="public ">quote_table()</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_table(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_prepare_execute" name="method_prepare_execute" class="anchor"></a>
<article class="method">
<h3 class="public ">prepare_execute()</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_execute(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_get_sql" name="method_get_sql" class="anchor"></a>
<article class="method">
<h3 class="public ">get_sql()</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;">get_sql() : \Query\SQL_Interface</pre>
<p><em>Get the SQL class for the current driver</em></p>
<h4>Returns</h4>
<a href="../classes/Query.SQL_Interface.html">\Query\SQL_Interface</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_get_util" name="method_get_util" class="anchor"></a>
<article class="method">
<h3 class="public ">get_util()</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;">get_util() : \Query\Abstract_Util</pre>
<p><em>Get the Util class for the current driver</em></p>
<h4>Returns</h4>
<a href="../classes/Query.Abstract_Util.html">\Query\Abstract_Util</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_driver_query" name="method_driver_query" class="anchor"></a>
<article class="method">
<h3 class="public ">driver_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;">driver_query(string|array|null <span class="argument">$query</span>, boolean <span class="argument">$filtered_index = 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>$filtered_index </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_affected_rows" name="method_affected_rows" class="anchor"></a>
<article class="method">
<h3 class="public ">affected_rows()</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;">affected_rows() : 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_num_rows" name="method_num_rows" class="anchor"></a>
<article class="method">
<h3 class="public ">num_rows()</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;">num_rows() : 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"></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_prefix_table" name="method_prefix_table" class="anchor"></a>
<article class="method">
<h3 class="public ">prefix_table()</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;">prefix_table(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_insert_batch" name="method_insert_batch" class="anchor"></a>
<article class="method">
<h3 class="public ">insert_batch()</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;">insert_batch(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>
</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">Driver_Interface.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/src/Query/Driver_Interface.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 August 25th, 2015 at 13:45.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>