215 lines
11 KiB
HTML
215 lines
11 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\Query_Parser</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>Namespaces</a></li>
|
||
<li><a href="../namespaces/Query.html"><i class="icon-th"></i> Query</a></li>
|
||
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
|
||
<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-toolbar">
|
||
<div class="btn-group visibility" data-toggle="buttons-checkbox">
|
||
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
|
||
</div>
|
||
<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>
|
||
</div>
|
||
<ul class="side-nav nav nav-list">
|
||
<li class="nav-header">
|
||
<i title="Methods" class="icon-custom icon-method"></i> Methods
|
||
<ul>
|
||
<li class="method public "><a href="#method___construct" title="__construct() :: Constructor/entry point into parser"><span class="description">Constructor/entry point into parser</span><pre>__construct()</pre></a></li>
|
||
<li class="method public "><a href="#method_compile_join" title="compile_join() :: Compiles a join condition after parsing"><span class="description">Compiles a join condition after parsing</span><pre>compile_join()</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-header protected">» Protected
|
||
<ul>
|
||
<li class="method protected "><a href="#method_filter_array" title="filter_array() :: Returns a more useful match array"><span class="description">Returns a more useful match array</span><pre>filter_array()</pre></a></li>
|
||
<li class="method protected "><a href="#method_parse_join" title="parse_join() :: Public parser method for seting the parse string"><span class="description">Public parser method for seting the parse string</span><pre>parse_join()</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-header">
|
||
<i title="Properties" class="icon-custom icon-property"></i> Properties
|
||
<ul><li class="property public "><a href="#property_matches" title="$matches() :: Regex matches"><span class="description"></span><pre>$matches</pre></a></li></ul>
|
||
</li>
|
||
<li class="nav-header private">» Private
|
||
<ul>
|
||
<li class="property private "><a href="#property_db" title="$db() :: DB Driver"><span class="description"></span><pre>$db</pre></a></li>
|
||
<li class="property private "><a href="#property_match_patterns" title="$match_patterns() :: Regex patterns for various syntax components"><span class="description"></span><pre>$match_patterns</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="span8">
|
||
<a id="\Query\Query_Parser"></a><ul class="breadcrumb">
|
||
<li>
|
||
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
|
||
</li>
|
||
<li><a href="../namespaces/Query.html">Query</a></li>
|
||
<li class="active">
|
||
<span class="divider">\</span><a href="../classes/Query.Query_Parser.html">Query_Parser</a>
|
||
</li>
|
||
</ul>
|
||
<div class="element class">
|
||
<p class="short_description">Utility Class to parse sql clauses for properly escaping identifiers</p>
|
||
<div class="details">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>package</th>
|
||
<td><a href="../packages/Query.Query_Builder.html">Query</a></td>
|
||
</tr>
|
||
<tr>
|
||
<th>subpackage</th>
|
||
<td>Query_Builder</td>
|
||
</tr>
|
||
</table>
|
||
<h3>
|
||
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
|
||
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
|
||
<h2>Constructor/entry point into parser</h2>
|
||
<pre>__construct(string $sql<code> = ''</code>) </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>$sql</h4>
|
||
<code>string</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_compile_join"></a><div class="element clickable method public method_compile_join" data-toggle="collapse" data-target=".method_compile_join .collapse" title="public">
|
||
<h2>Compiles a join condition after parsing</h2>
|
||
<pre>compile_join(string $condition) : 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>$condition</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_filter_array"></a><div class="element clickable method protected method_filter_array" data-toggle="collapse" data-target=".method_filter_array .collapse" title="protected">
|
||
<h2>Returns a more useful match array</h2>
|
||
<pre>filter_array(array $array) : 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>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_parse_join"></a><div class="element clickable method protected method_parse_join" data-toggle="collapse" data-target=".method_parse_join .collapse" title="protected">
|
||
<h2>Public parser method for seting the parse string</h2>
|
||
<pre>parse_join(string $sql) </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>$sql</h4>
|
||
<code>string</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<h3>
|
||
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
|
||
<a id="property_matches"> </a><div class="element clickable property public property_matches" data-toggle="collapse" data-target=".property_matches .collapse" title="public">
|
||
<h2>Regex matches</h2>
|
||
<pre>$matches : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array('functions' => array(), 'identifiers' => array(), 'operators' => array(), 'combined' => array())</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_db"> </a><div class="element clickable property private property_db" data-toggle="collapse" data-target=".property_db .collapse" title="private">
|
||
<h2>DB Driver</h2>
|
||
<pre>$db : <a href="../classes/Query.Driver.Driver_Interface.html">\Query\Driver\Driver_Interface</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_match_patterns"> </a><div class="element clickable property private property_match_patterns" data-toggle="collapse" data-target=".property_match_patterns .collapse" title="private">
|
||
<h2>Regex patterns for various syntax components</h2>
|
||
<pre>$match_patterns : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array('function' => '([a-zA-Z0-9_]+\((.*?)\))', 'identifier' => '([a-zA-Z0-9_-]+\.?)+', 'operator' => '=|AND|&&?|~|\|\|?|\^|/|>=?|<=?|-|%|OR|\+|NOT|\!=?|<>|XOR')</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</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-04-02T17:09:12-04:00.<br></footer></div>
|
||
</div>
|
||
</body>
|
||
</html>
|