Query/docs/namespaces/default.html

618 lines
36 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-->
<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-1827946039"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1827946039" 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-1778715098"></a>
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
</div>
<div id="namespace-1778715098" 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-77957455"></a>
<a href="../namespaces/Query.Drivers.html" style="margin-left: 30px; padding-left: 0">Drivers</a>
</div>
<div id="namespace-77957455" 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-1344928351"></a>
<a href="../namespaces/Query.Drivers.Firebird.html" style="margin-left: 30px; padding-left: 0">Firebird</a>
</div>
<div id="namespace-1344928351" 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-1499832634"></a>
<a href="../namespaces/Query.Drivers.Mysql.html" style="margin-left: 30px; padding-left: 0">Mysql</a>
</div>
<div id="namespace-1499832634" 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-1953948445"></a>
<a href="../namespaces/Query.Drivers.Pgsql.html" style="margin-left: 30px; padding-left: 0">Pgsql</a>
</div>
<div id="namespace-1953948445" 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-1916077129"></a>
<a href="../namespaces/Query.Drivers.Sqlite.html" style="margin-left: 30px; padding-left: 0">Sqlite</a>
</div>
<div id="namespace-1916077129" 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 namespace">
<nav>
</nav>
<h1><small></small>\</h1>
<h2>Namespaces</h2>
<table class="table table-hover">
<tr>
<td><a href="../namespaces/Query.html">Query</a></td>
</tr>
</table>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>Namespace hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\</div>
</dd>
</dl>
</aside>
</div>
<div class="row-fluid">
<section class="span8 content namespace">
<h2>Functions</h2>
</section>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_array_zipper" name="method_array_zipper" class="anchor"></a>
<article class="method">
<h3 class=" ">array_zipper()</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;">array_zipper(array <span class="argument">$zipperInput</span>) : array</pre>
<p><em>Zip a set of arrays together on common keys</em></p>
<p>The $zipperInput array is an array of arrays indexed by their place in the output
array.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$zipperInput </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"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>Default</p>
</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"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>Default</p>
</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"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>Default</p>
</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 = &#039;&#039;</span>) : \Query\QueryBuilder|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>
<a href="../classes/Query.QueryBuilder.html">\Query\QueryBuilder</a>|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"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>Default</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_regex_in_array" name="method_regex_in_array" class="anchor"></a>
<article class="method">
<h3 class=" ">regex_in_array()</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;">regex_in_array(array <span class="argument">$array</span>, string <span class="argument">$pattern</span>) : boolean</pre>
<p><em>Determine whether a value in the passed array matches the pattern
passed</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$array </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$pattern </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>File</dt>
<dd><a href=""><div class="path-wrapper"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>Default</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_to_camel_case" name="method_to_camel_case" class="anchor"></a>
<article class="method">
<h3 class=" ">to_camel_case()</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;">to_camel_case(string <span class="argument">$snakeCase</span>) : string</pre>
<p><em>Create a camelCase string from snake_case</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$snakeCase </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"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>Default</p>
</td>
</tr>
</table>
</aside>
</div>
</div>
</section>
<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>