568 lines
32 KiB
HTML
568 lines
32 KiB
HTML
<!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="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
|
||
<link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/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="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
|
||
<![endif]-->
|
||
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
|
||
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
|
||
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/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> 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> Errors <span class="label label-info pull-right">0</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../reports/markers.html">
|
||
<i class="icon-list-alt"></i> Markers <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  <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-2139994162"></a>
|
||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||
</div>
|
||
<div id="namespace-2139994162" 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-177453566"></a>
|
||
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
|
||
</div>
|
||
<div id="namespace-177453566" 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-463692672"></a>
|
||
<a href="../namespaces/Query.Table.html" style="margin-left: 30px; padding-left: 0">Table</a>
|
||
</div>
|
||
<div id="namespace-463692672" class="accordion-body collapse ">
|
||
<div class="accordion-inner">
|
||
|
||
|
||
<ul>
|
||
<li class="class"><a href="../classes/Query.Table.Abstract_Table.html">Abstract_Table</a></li>
|
||
<li class="class"><a href="../classes/Query.Table.Table_Builder.html">Table_Builder</a></li>
|
||
<li class="class"><a href="../classes/Query.Table.Table_Foreign_Key.html">Table_Foreign_Key</a></li>
|
||
<li class="class"><a href="../classes/Query.Table.Table_Column.html">Table_Column</a></li>
|
||
<li class="class"><a href="../classes/Query.Table.Table_Index.html">Table_Index</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-797886778"></a>
|
||
<a href="../namespaces/Query.Driver.html" style="margin-left: 30px; padding-left: 0">Driver</a>
|
||
</div>
|
||
<div id="namespace-797886778" class="accordion-body collapse ">
|
||
<div class="accordion-inner">
|
||
|
||
|
||
<ul>
|
||
<li class="interface"><a href="../classes/Query.Driver.SQL_Interface.html">SQL_Interface</a></li>
|
||
<li class="interface"><a href="../classes/Query.Driver.Driver_Interface.html">Driver_Interface</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.Abstract_SQL.html">Abstract_SQL</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.Firebird_Result.html">Firebird_Result</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.Firebird_Util.html">Firebird_Util</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.Firebird.html">Firebird</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.MySQL_Util.html">MySQL_Util</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.Abstract_Util.html">Abstract_Util</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.Abstract_Driver.html">Abstract_Driver</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.SQLite_Util.html">SQLite_Util</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.PgSQL_Util.html">PgSQL_Util</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.PgSQL_SQL.html">PgSQL_SQL</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.MySQL_SQL.html">MySQL_SQL</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.Firebird_SQL.html">Firebird_SQL</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.SQLite.html">SQLite</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.SQLite_SQL.html">SQLite_SQL</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.PgSQL.html">PgSQL</a></li>
|
||
<li class="class"><a href="../classes/Query.Driver.MySQL.html">MySQL</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<ul>
|
||
<li class="interface"><a href="../classes/Query.Query_Builder_Interface.html">Query_Builder_Interface</a></li>
|
||
<li class="class"><a href="../classes/Query.Query_Parser.html">Query_Parser</a></li>
|
||
<li class="class"><a href="../classes/Query.Query_Builder.html">Query_Builder</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>
|
||
</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 file">
|
||
<nav>
|
||
</nav>
|
||
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
|
||
<h1><small></small>common.php</h1>
|
||
<p><em>Query</em></p>
|
||
<p>Free Query Builder / Database Abstraction Layer</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<aside class="span4 detailsbar">
|
||
<dl>
|
||
<dt>Package</dt>
|
||
<dd><div class="namespace-wrapper">Query\Core</div></dd>
|
||
|
||
<dt>See also</dt>
|
||
<dd><a href="https://github.com/aviat4ion/Query"><div class="namespace-wrapper">https://github.com/aviat4ion/Query</div></a></dd>
|
||
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
author
|
||
</th>
|
||
<td>
|
||
<p>Timothy J. Warren</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th>
|
||
copyright
|
||
</th>
|
||
<td>
|
||
<p>Copyright (c) 2012 - 2014</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th>
|
||
license
|
||
</th>
|
||
<td>
|
||
<p><a href="http://philsturgeon.co.uk/code/dbad-license">http://philsturgeon.co.uk/code/dbad-license</a></p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
</aside>
|
||
</div>
|
||
|
||
|
||
<div class="row-fluid">
|
||
<section class="span8 content file">
|
||
<h2>Functions</h2>
|
||
</section>
|
||
<aside class="span4 detailsbar"></aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_do_include" name="method_do_include" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class=" ">do_include()</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;">do_include(string <span class="argument">$path</span>) : void</pre>
|
||
<p><em>Bulk directory loading workaround for use
|
||
with array_map and glob</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$path</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
<dt>File</dt>
|
||
<dd><a href=""><div class="path-wrapper">common.php</div></a></dd>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
subpackage
|
||
</th>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th>
|
||
todo
|
||
</th>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_mb_trim" name="method_mb_trim" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class=" ">mb_trim()</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;">mb_trim(string <span class="argument">$string</span>) : string</pre>
|
||
<p><em>Multibyte-safe trim function</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$string</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
<dt>File</dt>
|
||
<dd><a href=""><div class="path-wrapper">common.php</div></a></dd>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
subpackage
|
||
</th>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th>
|
||
todo
|
||
</th>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_db_filter" name="method_db_filter" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class=" ">db_filter()</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;">db_filter(array <span class="argument">$array</span>, mixed <span class="argument">$index</span>) : array</pre>
|
||
<p><em>Filter out db rows into one array</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>mixed</td>
|
||
<td>$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>
|
||
<dt>File</dt>
|
||
<dd><a href=""><div class="path-wrapper">common.php</div></a></dd>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
subpackage
|
||
</th>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th>
|
||
todo
|
||
</th>
|
||
<td>
|
||
</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=" ">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(string|object|array <span class="argument">$params</span>) : \Query\Query_Builder|null</pre>
|
||
<p><em>Connection function</em></p>
|
||
<p>Send an array or object as connection parameters to create a connection. If
|
||
the array or object has an 'alias' parameter, passing that string to this
|
||
function will return that connection. Passing no parameters returns the last
|
||
connection created.</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string|object|array</td>
|
||
<td>$params</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
\Query\Query_Builder|null
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
<dt>File</dt>
|
||
<dd><a href=""><div class="path-wrapper">common.php</div></a></dd>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
subpackage
|
||
</th>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th>
|
||
todo
|
||
</th>
|
||
<td>
|
||
</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"></h3>
|
||
</div>
|
||
<div class="modal-body">
|
||
<pre data-src="../files/common.php.txt" class="language-php line-numbers"></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 April 24th, 2014 at 11:24.
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</footer>
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|