387 lines
18 KiB
HTML
387 lines
18 KiB
HTML
<!DOCTYPE html><html lang="en">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||
<meta charset="utf-8">
|
||
<title>Query » Query</title>
|
||
<meta name="author" content="Mike van Riel">
|
||
<meta name="description" content="">
|
||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||
</head>
|
||
<body>
|
||
<div class="navbar navbar-fixed-top">
|
||
<div class="navbar-inner"><div class="container">
|
||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
|
||
<li class="dropdown">
|
||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||
<li><a>Packages</a></li>
|
||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="dropdown" id="charts-menu">
|
||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||
</li>
|
||
<li class="dropdown" id="reports-menu">
|
||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||
<span class="label label-info">0</span></a></li>
|
||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||
<ul></ul></a></li>
|
||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||
<span class="label label-info">0</span></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul></div>
|
||
</div></div>
|
||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||
</div>
|
||
<div id="___" class="container">
|
||
<noscript><div class="alert alert-warning">
|
||
Javascript is disabled; several features are only available
|
||
if Javascript is enabled.
|
||
</div></noscript>
|
||
<div class="row">
|
||
<div class="span4">
|
||
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||
</div>
|
||
<ul class="side-nav nav nav-list">
|
||
<li class="nav-header">
|
||
<i class="icon-map-marker"></i> Packages</li>
|
||
<li>
|
||
<a href="../packages/Query.html" title="Query"><i class="icon-folder-open"></i>Query</a><ul class="nav nav-list nav-packages">
|
||
<li>
|
||
<a href="../packages/Query.Drivers.html" title="Drivers"><i class="icon-folder-open"></i>Drivers</a><ul class="nav nav-list nav-packages"></ul>
|
||
</li>
|
||
<li>
|
||
<a href="../packages/Query.Query.html" title="Query"><i class="icon-folder-open"></i>Query</a><ul class="nav nav-list nav-packages"></ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-header">
|
||
<i title="Functions" class="icon-custom icon-function"></i> Functions</li>
|
||
<li class="function "><a href="#function_Query" title="Query() :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li>
|
||
<li class="function "><a href="#function_db_filter" title="db_filter() :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li>
|
||
<li class="function "><a href="#function_do_include" title="do_include() :: Bulk directory loading workaround for use
|
||
with array_map and glob"><span class="description">Bulk directory loading workaround for use
|
||
with array_map and glob</span><pre>do_include</pre></a></li>
|
||
<li class="function "><a href="#function_mb_trim" title="mb_trim() :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</pre></a></li>
|
||
<li class="function "><a href="#function_query_autoload" title="query_autoload() :: Load query classes"><span class="description">Load query classes</span><pre>query_autoload</pre></a></li>
|
||
<li class="nav-header">
|
||
<i title="Interfaces" class="icon-custom icon-interface"></i> Interfaces</li>
|
||
<li><a href="#idriver" title="PDO Interface to implement for database drivers">idriver</a></li>
|
||
<li class="nav-header">
|
||
<i title="Constants" class="icon-custom icon-constant"></i> Constants</li>
|
||
<li class="constant "><a href="#constant_QBASE_PATH" title="QBASE_PATH() :: Reference to root path"><span class="description">Reference to root path</span><pre>QBASE_PATH</pre></a></li>
|
||
<li class="constant "><a href="#constant_QDRIVER_PATH" title="QDRIVER_PATH() :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span8 package-contents">
|
||
<ul class="breadcrumb"><li>
|
||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li class="active"><a href="../packages/Query.html">Query</a></li>
|
||
</li></ul>
|
||
<div class="package-indent">
|
||
<h3>
|
||
<i title="Functions" class="icon-custom icon-function"></i> Functions</h3>
|
||
<a id="function_Query"></a><div class="element clickable function function_Query" data-toggle="collapse" data-target=".function_Query .collapse" title="">
|
||
<h2>Connection function</h2>
|
||
<pre>Query(mixed $params<code> = ''</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$params</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Exceptions</h3>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th><code><a href="InvalidArgumentException.html">\InvalidArgumentException</a></code></th>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<th><code><a href="../classes/BadDBDriverException.html">\BadDBDriverException</a></code></th>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<th><code><a href="../classes/BadConnectionException.html">\BadConnectionException</a></code></th>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="function_db_filter"></a><div class="element clickable function function_db_filter" data-toggle="collapse" data-target=".function_db_filter .collapse" title="">
|
||
<h2>Filter out db rows into one array</h2>
|
||
<pre>db_filter(array $array, mixed $index) : array</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$array</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$index</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="function_do_include"></a><div class="element clickable function function_do_include" data-toggle="collapse" data-target=".function_do_include .collapse" title="">
|
||
<h2>Bulk directory loading workaround for use
|
||
with array_map and glob</h2>
|
||
<pre>do_include(string $path) : void</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$path</h4>
|
||
<code>string</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<a id="function_mb_trim"></a><div class="element clickable function function_mb_trim" data-toggle="collapse" data-target=".function_mb_trim .collapse" title="">
|
||
<h2>Multibyte-safe trim function</h2>
|
||
<pre>mb_trim(string $string) : string</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$string</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="function_query_autoload"></a><div class="element clickable function function_query_autoload" data-toggle="collapse" data-target=".function_query_autoload .collapse" title="">
|
||
<h2>Load query classes</h2>
|
||
<pre>query_autoload(string $class) </pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$class</h4>
|
||
<code>string</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<h3>
|
||
<i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||
<div id="idriver" class="element ajax clickable interface">
|
||
<h1>idriver<a href="../classes/idriver.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">PDO Interface to implement for database drivers</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/idriver.html" class="more">« More »</a>
|
||
</div>
|
||
<h3>
|
||
<i title="Constants" class="icon-custom icon-constant"></i> Constants</h3>
|
||
<a id="constant_QBASE_PATH"> </a><div class="element clickable constant constant_QBASE_PATH" data-toggle="collapse" data-target=".constant_QBASE_PATH .collapse" title="">
|
||
<h2>Reference to root path</h2>
|
||
<pre>QBASE_PATH = dirname(__FILE__) . '/' </pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="constant_QDRIVER_PATH"> </a><div class="element clickable constant constant_QDRIVER_PATH" data-toggle="collapse" data-target=".constant_QDRIVER_PATH .collapse" title="">
|
||
<h2>Path to driver classes</h2>
|
||
<pre>QDRIVER_PATH = QBASE_PATH . 'drivers/' </pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<ul class="breadcrumb"><li>
|
||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li><a href="../packages/Query.html">Query</a></li>
|
||
<li class="active">
|
||
<span class="divider">\</span><a href="../packages/Query.Drivers.html">Drivers</a>
|
||
</li>
|
||
</li></ul>
|
||
<div class="package-indent">
|
||
<h3>
|
||
<i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||
<div id="Firebird" class="element ajax clickable class">
|
||
<h1>Firebird<a href="../classes/Firebird.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Firebird Database class</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/Firebird.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="Firebird_Result" class="element ajax clickable class">
|
||
<h1>Firebird_Result<a href="../classes/Firebird_Result.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
|
||
data-fetching methods</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/Firebird_Result.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="Firebird_SQL" class="element ajax clickable class">
|
||
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Firebird Specific SQL</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/Firebird_SQL.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="Firebird_Util" class="element ajax clickable class">
|
||
<h1>Firebird_Util<a href="../classes/Firebird_Util.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Firebird-specific backup, import and creation methods</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/Firebird_Util.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="MySQL" class="element ajax clickable class">
|
||
<h1>MySQL<a href="../classes/MySQL.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">MySQL specific class</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/MySQL.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="MySQL_SQL" class="element ajax clickable class">
|
||
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">MySQL specifc SQL</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/MySQL_SQL.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="MySQL_Util" class="element ajax clickable class">
|
||
<h1>MySQL_Util<a href="../classes/MySQL_Util.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">MySQL-specific backup, import and creation methods</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/MySQL_Util.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="PgSQL" class="element ajax clickable class">
|
||
<h1>PgSQL<a href="../classes/PgSQL.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">PostgreSQL specifc class</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/PgSQL.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="PgSQL_SQL" class="element ajax clickable class">
|
||
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">PostgreSQL specifc SQL</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="PgSQL_Util" class="element ajax clickable class">
|
||
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Posgres-specific backup, import and creation methods</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/PgSQL_Util.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="SQLite" class="element ajax clickable class">
|
||
<h1>SQLite<a href="../classes/SQLite.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">SQLite specific class</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/SQLite.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="SQLite_SQL" class="element ajax clickable class">
|
||
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">SQLite Specific SQL</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/SQLite_SQL.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="SQLite_Util" class="element ajax clickable class">
|
||
<h1>SQLite_Util<a href="../classes/SQLite_Util.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">SQLite-specific backup, import and creation methods</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/SQLite_Util.html" class="more">« More »</a>
|
||
</div>
|
||
</div>
|
||
<ul class="breadcrumb"><li>
|
||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span><li><a href="../packages/Query.html">Query</a></li>
|
||
<li class="active">
|
||
<span class="divider">\</span><a href="../packages/Query.Query.html">Query</a>
|
||
</li>
|
||
</li></ul>
|
||
<div class="package-indent">
|
||
<h3>
|
||
<i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||
<div id="iDB_SQL" class="element ajax clickable interface">
|
||
<h1>iDB_SQL<a href="../classes/iDB_SQL.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">parent for database manipulation subclasses</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/iDB_SQL.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="iQuery_Builder" class="element ajax clickable interface">
|
||
<h1>iQuery_Builder<a href="../classes/iQuery_Builder.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Interface defining the Query Builder class</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/iQuery_Builder.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="Abstract_Driver" class="element ajax clickable class">
|
||
<h1>Abstract_Driver<a href="../classes/Abstract_Driver.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Base Database class</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/Abstract_Driver.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="BadConnectionException" class="element ajax clickable class">
|
||
<h1>BadConnectionException<a href="../classes/BadConnectionException.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Generic exception for bad connection strings</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/BadConnectionException.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="BadDBDriverException" class="element ajax clickable class">
|
||
<h1>BadDBDriverException<a href="../classes/BadDBDriverException.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Generic exception for bad drivers</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/BadDBDriverException.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="DB_Util" class="element ajax clickable class">
|
||
<h1>DB_Util<a href="../classes/DB_Util.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Abstract class defining database / table creation methods</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/DB_Util.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="Query_Builder" class="element ajax clickable class">
|
||
<h1>Query_Builder<a href="../classes/Query_Builder.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Convienience class for creating sql queries - also the class that
|
||
instantiates the specific db driver</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/Query_Builder.html" class="more">« More »</a>
|
||
</div>
|
||
<div id="Query_Parser" class="element ajax clickable class">
|
||
<h1>Query_Parser<a href="../classes/Query_Parser.html">¶</a>
|
||
</h1>
|
||
<p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p>
|
||
<div class="details collapse"></div>
|
||
<a href="../classes/Query_Parser.html" class="more">« More »</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="row"><footer class="span12">
|
||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
|
||
</a> and<br>
|
||
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
|
||
</div>
|
||
</body>
|
||
</html>
|