Query/apiDocumentation/classes/Query_QueryParser.html

132 lines
4.7 KiB
HTML
Raw Normal View History

2018-01-24 15:31:27 -05:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Query\QueryParser</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.html">Namespaces</a>
</li>
<li>
<a href="../interfaces.html">Interfaces</a>
</li>
<li>
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../source/index.html">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../classes.html#Query">Query</a>
</li>
<li class="separator">QueryParser</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
2020-04-23 18:21:35 -04:00
<li>
<a href="#violations">Violations</a>
</li>
2018-01-24 15:31:27 -05:00
<li>
<a href="#members">Members</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
2020-04-17 15:05:37 -04:00
<a href="../source/QueryParser.php.html#line23">Source</a>
2018-01-24 15:31:27 -05:00
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>Query\</small>QueryParser</h1>
<h4>Utility Class to parse sql clauses for properly escaping identifiers</h4>
<p/>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class QueryParser
{<br/><ul class="none"><li>// members</li><li>public array <a href="#members">$matches</a> =
;
</li></ul><ul class="none"><li>// methods</li><li>public void <a title="Query\QueryParser" href="../classes/Query_QueryParser/__construct.html">__construct</a>()
</li><li>public array <a title="Query\QueryParser" href="../classes/Query_QueryParser/parseJoin.html">parseJoin</a>()
</li><li>public string <a title="Query\QueryParser" href="../classes/Query_QueryParser/compileJoin.html">compileJoin</a>()
</li></ul>
}<br/></div>
2020-04-23 18:21:35 -04:00
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">60</td>
<td>
<a href="https://phpmd.org/rules/naming.html#shortvariable" target="_blank" title="Naming Rules">ShortVariable</a>
</td>
<td>Avoid variables with short names like $db. Configured minimum length is 3.</td>
</tr>
</table>
</div>
2018-01-24 15:31:27 -05:00
<h2 id="members">Members</h2>
<div class="styled members">
<h4>public</h4>
<ul class="members">
<li id="matches"><strong>$matches</strong>
array<br/><span class="indent">Regex matches</span></li>
</ul>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>
<ul>
<li id="__construct"><a title="Query\QueryParser" href="../classes/Query_QueryParser/__construct.html">__construct()</a>
— Constructor/entry point into parser</li>
<li id="compileJoin"><a title="Query\QueryParser" href="../classes/Query_QueryParser/compileJoin.html">compileJoin()</a>
— Compiles a join condition after parsing</li>
<li id="parseJoin"><a title="Query\QueryParser" href="../classes/Query_QueryParser/parseJoin.html">parseJoin()</a>
— Parser method for setting the parse string</li>
</ul>
</div>
</section>
</div>
<footer>
2020-04-17 15:05:37 -04:00
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
2018-01-24 15:31:27 -05:00
</footer>
</body>
</html>