Location: PHPKode > projects > Miner > jstayton-Miner-09b7280/docs/classes/Miner.html
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" 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>phpDocumentor » \Miner</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">phpDocumentor</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/Miner.html"><i class="icon-folder-open"></i> Miner</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">1</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">
<span 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></span><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-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Constructor."><span class="description">Constructor.</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__toString" title="__toString :: Get the full SQL statement without value placeholders."><span class="description">Get the full SQL statement without value placeholders.</span><pre>__toString()</pre></a></li>
<li class="method public "><a href="#andHaving" title="andHaving :: Add an AND HAVING condition."><span class="description">Add an AND HAVING condition.</span><pre>andHaving()</pre></a></li>
<li class="method public "><a href="#andWhere" title="andWhere :: Add an AND WHERE condition."><span class="description">Add an AND WHERE condition.</span><pre>andWhere()</pre></a></li>
<li class="method public "><a href="#autoQuote" title="autoQuote :: Safely escape a value if auto-quoting is enabled, or do nothing if
disabled."><span class="description">Safely escape a value if auto-quoting is enabled, or do nothing if
disabled.</span><pre>autoQuote()</pre></a></li>
<li class="method public "><a href="#calcFoundRows" title="calcFoundRows :: Add SQL_CALC_FOUND_ROWS execution option."><span class="description">Add SQL_CALC_FOUND_ROWS execution option.</span><pre>calcFoundRows()</pre></a></li>
<li class="method public "><a href="#closeHaving" title="closeHaving :: Add a closing bracket for nesting HAVING conditions."><span class="description">Add a closing bracket for nesting HAVING conditions.</span><pre>closeHaving()</pre></a></li>
<li class="method public "><a href="#closeWhere" title="closeWhere :: Add a closing bracket for nesting WHERE conditions."><span class="description">Add a closing bracket for nesting WHERE conditions.</span><pre>closeWhere()</pre></a></li>
<li class="method public "><a href="#delete" title="delete :: Add a table to DELETE from, or false if deleting from the FROM table."><span class="description">Add a table to DELETE from, or false if deleting from the FROM table.</span><pre>delete()</pre></a></li>
<li class="method public "><a href="#distinct" title="distinct :: Add DISTINCT execution option."><span class="description">Add DISTINCT execution option.</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#execute" title="execute :: Execute the statement using the PDO database connection."><span class="description">Execute the statement using the PDO database connection.</span><pre>execute()</pre></a></li>
<li class="method public "><a href="#from" title="from :: Set the FROM table with optional alias."><span class="description">Set the FROM table with optional alias.</span><pre>from()</pre></a></li>
<li class="method public "><a href="#getAutoQuote" title="getAutoQuote :: Get whether values will be automatically escaped."><span class="description">Get whether values will be automatically escaped.</span><pre>getAutoQuote()</pre></a></li>
<li class="method public "><a href="#getDeleteString" title="getDeleteString :: Get the DELETE portion of the statement as a string."><span class="description">Get the DELETE portion of the statement as a string.</span><pre>getDeleteString()</pre></a></li>
<li class="method public "><a href="#getFrom" title="getFrom :: Get the FROM table."><span class="description">Get the FROM table.</span><pre>getFrom()</pre></a></li>
<li class="method public "><a href="#getFromAlias" title="getFromAlias :: Get the FROM table alias."><span class="description">Get the FROM table alias.</span><pre>getFromAlias()</pre></a></li>
<li class="method public "><a href="#getFromString" title="getFromString :: Get the FROM portion of the statement, including all JOINs, as a string."><span class="description">Get the FROM portion of the statement, including all JOINs, as a string.</span><pre>getFromString()</pre></a></li>
<li class="method public "><a href="#getGroupByString" title="getGroupByString :: Get the GROUP BY portion of the statement as a string."><span class="description">Get the GROUP BY portion of the statement as a string.</span><pre>getGroupByString()</pre></a></li>
<li class="method public "><a href="#getHavingPlaceholderValues" title="getHavingPlaceholderValues :: Get the HAVING placeholder values."><span class="description">Get the HAVING placeholder values.</span><pre>getHavingPlaceholderValues()</pre></a></li>
<li class="method public "><a href="#getHavingString" title="getHavingString :: Get the HAVING portion of the statement as a string."><span class="description">Get the HAVING portion of the statement as a string.</span><pre>getHavingString()</pre></a></li>
<li class="method public "><a href="#getInsert" title="getInsert :: Get the INSERT table."><span class="description">Get the INSERT table.</span><pre>getInsert()</pre></a></li>
<li class="method public "><a href="#getInsertString" title="getInsertString :: Get the INSERT portion of the statement as a string."><span class="description">Get the INSERT portion of the statement as a string.</span><pre>getInsertString()</pre></a></li>
<li class="method public "><a href="#getJoinString" title="getJoinString :: Get the JOIN portion of the statement as a string."><span class="description">Get the JOIN portion of the statement as a string.</span><pre>getJoinString()</pre></a></li>
<li class="method public "><a href="#getLimit" title="getLimit :: Get the LIMIT on number of rows to return."><span class="description">Get the LIMIT on number of rows to return.</span><pre>getLimit()</pre></a></li>
<li class="method public "><a href="#getLimitOffset" title="getLimitOffset :: Get the LIMIT row number to start at."><span class="description">Get the LIMIT row number to start at.</span><pre>getLimitOffset()</pre></a></li>
<li class="method public "><a href="#getLimitString" title="getLimitString :: Get the LIMIT portion of the statement as a string."><span class="description">Get the LIMIT portion of the statement as a string.</span><pre>getLimitString()</pre></a></li>
<li class="method public "><a href="#getOptionsString" title="getOptionsString :: Get the execution options portion of the statement as a string."><span class="description">Get the execution options portion of the statement as a string.</span><pre>getOptionsString()</pre></a></li>
<li class="method public "><a href="#getOrderByString" title="getOrderByString :: Get the ORDER BY portion of the statement as a string."><span class="description">Get the ORDER BY portion of the statement as a string.</span><pre>getOrderByString()</pre></a></li>
<li class="method public "><a href="#getPdoConnection" title="getPdoConnection :: Get the PDO database connection to use in executing this statement."><span class="description">Get the PDO database connection to use in executing this statement.</span><pre>getPdoConnection()</pre></a></li>
<li class="method public "><a href="#getPlaceholderValues" title="getPlaceholderValues :: Get all placeholder values (SET, WHERE, and HAVING)."><span class="description">Get all placeholder values (SET, WHERE, and HAVING).</span><pre>getPlaceholderValues()</pre></a></li>
<li class="method public "><a href="#getReplace" title="getReplace :: Get the REPLACE table."><span class="description">Get the REPLACE table.</span><pre>getReplace()</pre></a></li>
<li class="method public "><a href="#getReplaceString" title="getReplaceString :: Get the REPLACE portion of the statement as a string."><span class="description">Get the REPLACE portion of the statement as a string.</span><pre>getReplaceString()</pre></a></li>
<li class="method public "><a href="#getSelectString" title="getSelectString :: Get the SELECT portion of the statement as a string."><span class="description">Get the SELECT portion of the statement as a string.</span><pre>getSelectString()</pre></a></li>
<li class="method public "><a href="#getSetPlaceholderValues" title="getSetPlaceholderValues :: Get the SET placeholder values."><span class="description">Get the SET placeholder values.</span><pre>getSetPlaceholderValues()</pre></a></li>
<li class="method public "><a href="#getSetString" title="getSetString :: Get the SET portion of the statement as a string."><span class="description">Get the SET portion of the statement as a string.</span><pre>getSetString()</pre></a></li>
<li class="method public "><a href="#getStatement" title="getStatement :: Get the full SQL statement."><span class="description">Get the full SQL statement.</span><pre>getStatement()</pre></a></li>
<li class="method public "><a href="#getUpdate" title="getUpdate :: Get the UPDATE table."><span class="description">Get the UPDATE table.</span><pre>getUpdate()</pre></a></li>
<li class="method public "><a href="#getUpdateString" title="getUpdateString :: Get the UPDATE portion of the statement as a string."><span class="description">Get the UPDATE portion of the statement as a string.</span><pre>getUpdateString()</pre></a></li>
<li class="method public "><a href="#getWherePlaceholderValues" title="getWherePlaceholderValues :: Get the WHERE placeholder values."><span class="description">Get the WHERE placeholder values.</span><pre>getWherePlaceholderValues()</pre></a></li>
<li class="method public "><a href="#getWhereString" title="getWhereString :: Get the WHERE portion of the statement as a string."><span class="description">Get the WHERE portion of the statement as a string.</span><pre>getWhereString()</pre></a></li>
<li class="method public "><a href="#groupBy" title="groupBy :: Add a GROUP BY column."><span class="description">Add a GROUP BY column.</span><pre>groupBy()</pre></a></li>
<li class="method public "><a href="#having" title="having :: Add a HAVING condition."><span class="description">Add a HAVING condition.</span><pre>having()</pre></a></li>
<li class="method public "><a href="#havingBetween" title="havingBetween :: Add a BETWEEN HAVING condition."><span class="description">Add a BETWEEN HAVING condition.</span><pre>havingBetween()</pre></a></li>
<li class="method public "><a href="#havingIn" title="havingIn :: Add an IN WHERE condition."><span class="description">Add an IN WHERE condition.</span><pre>havingIn()</pre></a></li>
<li class="method public "><a href="#havingNotBetween" title="havingNotBetween :: Add a NOT BETWEEN HAVING condition."><span class="description">Add a NOT BETWEEN HAVING condition.</span><pre>havingNotBetween()</pre></a></li>
<li class="method public "><a href="#havingNotIn" title="havingNotIn :: Add a NOT IN HAVING condition."><span class="description">Add a NOT IN HAVING condition.</span><pre>havingNotIn()</pre></a></li>
<li class="method public "><a href="#innerJoin" title="innerJoin :: Add an INNER JOIN table with optional ON criteria."><span class="description">Add an INNER JOIN table with optional ON criteria.</span><pre>innerJoin()</pre></a></li>
<li class="method public "><a href="#insert" title="insert :: Set the INSERT table."><span class="description">Set the INSERT table.</span><pre>insert()</pre></a></li>
<li class="method public "><a href="#isDelete" title="isDelete :: Whether this is a DELETE statement."><span class="description">Whether this is a DELETE statement.</span><pre>isDelete()</pre></a></li>
<li class="method public "><a href="#isInsert" title="isInsert :: Whether this is an INSERT statement."><span class="description">Whether this is an INSERT statement.</span><pre>isInsert()</pre></a></li>
<li class="method public "><a href="#isReplace" title="isReplace :: Whether this is a REPLACE statement."><span class="description">Whether this is a REPLACE statement.</span><pre>isReplace()</pre></a></li>
<li class="method public "><a href="#isSelect" title="isSelect :: Whether this is a SELECT statement."><span class="description">Whether this is a SELECT statement.</span><pre>isSelect()</pre></a></li>
<li class="method public "><a href="#isUpdate" title="isUpdate :: Whether this is an UPDATE statement."><span class="description">Whether this is an UPDATE statement.</span><pre>isUpdate()</pre></a></li>
<li class="method public "><a href="#join" title="join :: Add a JOIN table with optional ON criteria."><span class="description">Add a JOIN table with optional ON criteria.</span><pre>join()</pre></a></li>
<li class="method public "><a href="#leftJoin" title="leftJoin :: Add a LEFT JOIN table with optional ON criteria."><span class="description">Add a LEFT JOIN table with optional ON criteria.</span><pre>leftJoin()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Set the LIMIT on number of rows to return with optional offset."><span class="description">Set the LIMIT on number of rows to return with optional offset.</span><pre>limit()</pre></a></li>
<li class="method public "><a href="#mergeDeleteInto" title="mergeDeleteInto :: Merge this Miner's DELETE into the given Miner."><span class="description">Merge this Miner's DELETE into the given Miner.</span><pre>mergeDeleteInto()</pre></a></li>
<li class="method public "><a href="#mergeFromInto" title="mergeFromInto :: Merge this Miner's FROM into the given Miner."><span class="description">Merge this Miner's FROM into the given Miner.</span><pre>mergeFromInto()</pre></a></li>
<li class="method public "><a href="#mergeGroupByInto" title="mergeGroupByInto :: Merge this Miner's GROUP BY into the given Miner."><span class="description">Merge this Miner's GROUP BY into the given Miner.</span><pre>mergeGroupByInto()</pre></a></li>
<li class="method public "><a href="#mergeHavingInto" title="mergeHavingInto :: Merge this Miner's HAVING into the given Miner."><span class="description">Merge this Miner's HAVING into the given Miner.</span><pre>mergeHavingInto()</pre></a></li>
<li class="method public "><a href="#mergeInsertInto" title="mergeInsertInto :: Merge this Miner's INSERT into the given Miner."><span class="description">Merge this Miner's INSERT into the given Miner.</span><pre>mergeInsertInto()</pre></a></li>
<li class="method public "><a href="#mergeInto" title="mergeInto :: Merge this Miner into the given Miner."><span class="description">Merge this Miner into the given Miner.</span><pre>mergeInto()</pre></a></li>
<li class="method public "><a href="#mergeJoinInto" title="mergeJoinInto :: Merge this Miner's JOINs into the given Miner."><span class="description">Merge this Miner's JOINs into the given Miner.</span><pre>mergeJoinInto()</pre></a></li>
<li class="method public "><a href="#mergeLimitInto" title="mergeLimitInto :: Merge this Miner's LIMIT into the given Miner."><span class="description">Merge this Miner's LIMIT into the given Miner.</span><pre>mergeLimitInto()</pre></a></li>
<li class="method public "><a href="#mergeOptionsInto" title="mergeOptionsInto :: Merge this Miner's execution options into the given Miner."><span class="description">Merge this Miner's execution options into the given Miner.</span><pre>mergeOptionsInto()</pre></a></li>
<li class="method public "><a href="#mergeOrderByInto" title="mergeOrderByInto :: Merge this Miner's ORDER BY into the given Miner."><span class="description">Merge this Miner's ORDER BY into the given Miner.</span><pre>mergeOrderByInto()</pre></a></li>
<li class="method public "><a href="#mergeReplaceInto" title="mergeReplaceInto :: Merge this Miner's REPLACE into the given Miner."><span class="description">Merge this Miner's REPLACE into the given Miner.</span><pre>mergeReplaceInto()</pre></a></li>
<li class="method public "><a href="#mergeSelectInto" title="mergeSelectInto :: Merge this Miner's SELECT into the given Miner."><span class="description">Merge this Miner's SELECT into the given Miner.</span><pre>mergeSelectInto()</pre></a></li>
<li class="method public "><a href="#mergeSetInto" title="mergeSetInto :: Merge this Miner's SET into the given Miner."><span class="description">Merge this Miner's SET into the given Miner.</span><pre>mergeSetInto()</pre></a></li>
<li class="method public "><a href="#mergeUpdateInto" title="mergeUpdateInto :: Merge this Miner's UPDATE into the given Miner."><span class="description">Merge this Miner's UPDATE into the given Miner.</span><pre>mergeUpdateInto()</pre></a></li>
<li class="method public "><a href="#mergeWhereInto" title="mergeWhereInto :: Merge this Miner's WHERE into the given Miner."><span class="description">Merge this Miner's WHERE into the given Miner.</span><pre>mergeWhereInto()</pre></a></li>
<li class="method public "><a href="#openHaving" title="openHaving :: Add an open bracket for nesting HAVING conditions."><span class="description">Add an open bracket for nesting HAVING conditions.</span><pre>openHaving()</pre></a></li>
<li class="method public "><a href="#openWhere" title="openWhere :: Add an open bracket for nesting WHERE conditions."><span class="description">Add an open bracket for nesting WHERE conditions.</span><pre>openWhere()</pre></a></li>
<li class="method public "><a href="#option" title="option :: Add an execution option like DISTINCT or SQL_CALC_FOUND_ROWS."><span class="description">Add an execution option like DISTINCT or SQL_CALC_FOUND_ROWS.</span><pre>option()</pre></a></li>
<li class="method public "><a href="#orHaving" title="orHaving :: Add an OR HAVING condition."><span class="description">Add an OR HAVING condition.</span><pre>orHaving()</pre></a></li>
<li class="method public "><a href="#orWhere" title="orWhere :: Add an OR WHERE condition."><span class="description">Add an OR WHERE condition.</span><pre>orWhere()</pre></a></li>
<li class="method public "><a href="#orderBy" title="orderBy :: Add a column to ORDER BY."><span class="description">Add a column to ORDER BY.</span><pre>orderBy()</pre></a></li>
<li class="method public "><a href="#quote" title="quote :: Safely escape a value for use in a statement."><span class="description">Safely escape a value for use in a statement.</span><pre>quote()</pre></a></li>
<li class="method public "><a href="#replace" title="replace :: Set the REPLACE table."><span class="description">Set the REPLACE table.</span><pre>replace()</pre></a></li>
<li class="method public "><a href="#rightJoin" title="rightJoin :: Add a RIGHT JOIN table with optional ON criteria."><span class="description">Add a RIGHT JOIN table with optional ON criteria.</span><pre>rightJoin()</pre></a></li>
<li class="method public "><a href="#select" title="select :: Add a SELECT column, table, or expression with optional alias."><span class="description">Add a SELECT column, table, or expression with optional alias.</span><pre>select()</pre></a></li>
<li class="method public "><a href="#set" title="set :: Add a column value to INSERT or UPDATE."><span class="description">Add a column value to INSERT or UPDATE.</span><pre>set()</pre></a></li>
<li class="method public "><a href="#setAutoQuote" title="setAutoQuote :: Set whether to automatically escape values."><span class="description">Set whether to automatically escape values.</span><pre>setAutoQuote()</pre></a></li>
<li class="method public "><a href="#setPdoConnection" title="setPdoConnection :: Set the PDO database connection to use in executing this statement."><span class="description">Set the PDO database connection to use in executing this statement.</span><pre>setPdoConnection()</pre></a></li>
<li class="method public "><a href="#update" title="update :: Set the UPDATE table."><span class="description">Set the UPDATE table.</span><pre>update()</pre></a></li>
<li class="method public "><a href="#where" title="where :: Add a WHERE condition."><span class="description">Add a WHERE condition.</span><pre>where()</pre></a></li>
<li class="method public "><a href="#whereBetween" title="whereBetween :: Add a BETWEEN WHERE condition."><span class="description">Add a BETWEEN WHERE condition.</span><pre>whereBetween()</pre></a></li>
<li class="method public "><a href="#whereIn" title="whereIn :: Add an IN WHERE condition."><span class="description">Add an IN WHERE condition.</span><pre>whereIn()</pre></a></li>
<li class="method public "><a href="#whereNotBetween" title="whereNotBetween :: Add a NOT BETWEEN WHERE condition."><span class="description">Add a NOT BETWEEN WHERE condition.</span><pre>whereNotBetween()</pre></a></li>
<li class="method public "><a href="#whereNotIn" title="whereNotIn :: Add a NOT IN WHERE condition."><span class="description">Add a NOT IN WHERE condition.</span><pre>whereNotIn()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#closeCriteria" title="closeCriteria :: Add a closing bracket for nesting conditions to the specified WHERE or
HAVING criteria."><span class="description">Add a closing bracket for nesting conditions to the specified WHERE or
HAVING criteria.</span><pre>closeCriteria()</pre></a></li>
<li class="method private "><a href="#criteria" title="criteria :: Add a condition to the specified WHERE or HAVING criteria."><span class="description">Add a condition to the specified WHERE or HAVING criteria.</span><pre>criteria()</pre></a></li>
<li class="method private "><a href="#criteriaBetween" title="criteriaBetween :: Add a BETWEEN condition to the specified WHERE or HAVING criteria."><span class="description">Add a BETWEEN condition to the specified WHERE or HAVING criteria.</span><pre>criteriaBetween()</pre></a></li>
<li class="method private "><a href="#criteriaIn" title="criteriaIn :: Add an IN condition to the specified WHERE or HAVING criteria."><span class="description">Add an IN condition to the specified WHERE or HAVING criteria.</span><pre>criteriaIn()</pre></a></li>
<li class="method private "><a href="#criteriaNotBetween" title="criteriaNotBetween :: Add a NOT BETWEEN condition to the specified WHERE or HAVING criteria."><span class="description">Add a NOT BETWEEN condition to the specified WHERE or HAVING criteria.</span><pre>criteriaNotBetween()</pre></a></li>
<li class="method private "><a href="#criteriaNotIn" title="criteriaNotIn :: Add a NOT IN condition to the specified WHERE or HAVING criteria."><span class="description">Add a NOT IN condition to the specified WHERE or HAVING criteria.</span><pre>criteriaNotIn()</pre></a></li>
<li class="method private "><a href="#getCriteriaString" title="getCriteriaString :: Get the WHERE or HAVING portion of the statement as a string."><span class="description">Get the WHERE or HAVING portion of the statement as a string.</span><pre>getCriteriaString()</pre></a></li>
<li class="method private "><a href="#getDeleteStatement" title="getDeleteStatement :: Get the full DELETE statement."><span class="description">Get the full DELETE statement.</span><pre>getDeleteStatement()</pre></a></li>
<li class="method private "><a href="#getInsertStatement" title="getInsertStatement :: Get the full INSERT statement."><span class="description">Get the full INSERT statement.</span><pre>getInsertStatement()</pre></a></li>
<li class="method private "><a href="#getJoinCriteriaUsingPreviousTable" title="getJoinCriteriaUsingPreviousTable :: Get an ON criteria string joining the specified table and column to the
same column of the previous JOIN or FROM table."><span class="description">Get an ON criteria string joining the specified table and column to the
same column of the previous JOIN or FROM table.</span><pre>getJoinCriteriaUsingPreviousTable()</pre></a></li>
<li class="method private "><a href="#getReplaceStatement" title="getReplaceStatement :: Get the full REPLACE statement."><span class="description">Get the full REPLACE statement.</span><pre>getReplaceStatement()</pre></a></li>
<li class="method private "><a href="#getSelectStatement" title="getSelectStatement :: Get the full SELECT statement."><span class="description">Get the full SELECT statement.</span><pre>getSelectStatement()</pre></a></li>
<li class="method private "><a href="#getUpdateStatement" title="getUpdateStatement :: Get the full UPDATE statement."><span class="description">Get the full UPDATE statement.</span><pre>getUpdateStatement()</pre></a></li>
<li class="method private "><a href="#isDeleteTableFrom" title="isDeleteTableFrom :: Whether the FROM table is the single table to delete from."><span class="description">Whether the FROM table is the single table to delete from.</span><pre>isDeleteTableFrom()</pre></a></li>
<li class="method private "><a href="#openCriteria" title="openCriteria :: Add an open bracket for nesting conditions to the specified WHERE or
HAVING criteria."><span class="description">Add an open bracket for nesting conditions to the specified WHERE or
HAVING criteria.</span><pre>openCriteria()</pre></a></li>
<li class="method private "><a href="#orCriteria" title="orCriteria :: Add an OR condition to the specified WHERE or HAVING criteria."><span class="description">Add an OR condition to the specified WHERE or HAVING criteria.</span><pre>orCriteria()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24PdoConnection" title="$PdoConnection :: PDO database connection to use in executing the statement."><span class="description">PDO database connection to use in executing the statement.</span><pre>$PdoConnection</pre></a></li>
<li class="property private "><a href="#%24autoQuote" title="$autoQuote :: Whether to automatically escape values."><span class="description">Whether to automatically escape values.</span><pre>$autoQuote</pre></a></li>
<li class="property private "><a href="#%24delete" title="$delete :: Tables to DELETE from, or true if deleting from the FROM table."><span class="description">Tables to DELETE from, or true if deleting from the FROM table.</span><pre>$delete</pre></a></li>
<li class="property private "><a href="#%24from" title="$from :: Table to select FROM."><span class="description">Table to select FROM.</span><pre>$from</pre></a></li>
<li class="property private "><a href="#%24groupBy" title="$groupBy :: Columns to GROUP BY."><span class="description">Columns to GROUP BY.</span><pre>$groupBy</pre></a></li>
<li class="property private "><a href="#%24having" title="$having :: HAVING criteria."><span class="description">HAVING criteria.</span><pre>$having</pre></a></li>
<li class="property private "><a href="#%24havingPlaceholderValues" title="$havingPlaceholderValues :: HAVING placeholder values."><span class="description">HAVING placeholder values.</span><pre>$havingPlaceholderValues</pre></a></li>
<li class="property private "><a href="#%24insert" title="$insert :: Table to INSERT into."><span class="description">Table to INSERT into.</span><pre>$insert</pre></a></li>
<li class="property private "><a href="#%24join" title="$join :: JOIN tables and ON criteria."><span class="description">JOIN tables and ON criteria.</span><pre>$join</pre></a></li>
<li class="property private "><a href="#%24limit" title="$limit :: Number of rows to return from offset."><span class="description">Number of rows to return from offset.</span><pre>$limit</pre></a></li>
<li class="property private "><a href="#%24option" title="$option :: Execution options like DISTINCT and SQL_CALC_FOUND_ROWS."><span class="description">Execution options like DISTINCT and SQL_CALC_FOUND_ROWS.</span><pre>$option</pre></a></li>
<li class="property private "><a href="#%24orderBy" title="$orderBy :: Columns to ORDER BY."><span class="description">Columns to ORDER BY.</span><pre>$orderBy</pre></a></li>
<li class="property private "><a href="#%24replace" title="$replace :: Table to REPLACE into."><span class="description">Table to REPLACE into.</span><pre>$replace</pre></a></li>
<li class="property private "><a href="#%24select" title="$select :: Columns, tables, and expressions to SELECT from."><span class="description">Columns, tables, and expressions to SELECT from.</span><pre>$select</pre></a></li>
<li class="property private "><a href="#%24set" title="$set :: Column values to INSERT or UPDATE."><span class="description">Column values to INSERT or UPDATE.</span><pre>$set</pre></a></li>
<li class="property private "><a href="#%24setPlaceholderValues" title="$setPlaceholderValues :: SET placeholder values."><span class="description">SET placeholder values.</span><pre>$setPlaceholderValues</pre></a></li>
<li class="property private "><a href="#%24update" title="$update :: Table to UPDATE."><span class="description">Table to UPDATE.</span><pre>$update</pre></a></li>
<li class="property private "><a href="#%24where" title="$where :: WHERE criteria."><span class="description">WHERE criteria.</span><pre>$where</pre></a></li>
<li class="property private "><a href="#%24wherePlaceholderValues" title="$wherePlaceholderValues :: WHERE placeholder values."><span class="description">WHERE placeholder values.</span><pre>$wherePlaceholderValues</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant  "><a href="#BETWEEN" title="BETWEEN :: BETWEEN comparison operator."><span class="description">BETWEEN comparison operator.</span><pre>BETWEEN</pre></a></li>
<li class="constant  "><a href="#BRACKET_CLOSE" title="BRACKET_CLOSE :: Closing bracket for grouping criteria."><span class="description">Closing bracket for grouping criteria.</span><pre>BRACKET_CLOSE</pre></a></li>
<li class="constant  "><a href="#BRACKET_OPEN" title="BRACKET_OPEN :: Open bracket for grouping criteria."><span class="description">Open bracket for grouping criteria.</span><pre>BRACKET_OPEN</pre></a></li>
<li class="constant  "><a href="#EQUALS" title="EQUALS :: Equals comparison operator."><span class="description">Equals comparison operator.</span><pre>EQUALS</pre></a></li>
<li class="constant  "><a href="#GREATER_THAN" title="GREATER_THAN :: Greater than comparison operator."><span class="description">Greater than comparison operator.</span><pre>GREATER_THAN</pre></a></li>
<li class="constant  "><a href="#GREATER_THAN_OR_EQUAL" title="GREATER_THAN_OR_EQUAL :: Greater than or equal to comparison operator."><span class="description">Greater than or equal to comparison operator.</span><pre>GREATER_THAN_OR_EQUAL</pre></a></li>
<li class="constant  "><a href="#ILIKE" title="ILIKE :: ILIKE comparison operator."><span class="description">ILIKE comparison operator.</span><pre>ILIKE</pre></a></li>
<li class="constant  "><a href="#IN" title="IN :: IN comparison operator."><span class="description">IN comparison operator.</span><pre>IN</pre></a></li>
<li class="constant  "><a href="#INNER_JOIN" title="INNER_JOIN :: INNER JOIN type."><span class="description">INNER JOIN type.</span><pre>INNER_JOIN</pre></a></li>
<li class="constant  "><a href="#IS" title="IS :: IS comparison operator."><span class="description">IS comparison operator.</span><pre>IS</pre></a></li>
<li class="constant  "><a href="#IS_NOT" title="IS_NOT :: IS NOT comparison operator."><span class="description">IS NOT comparison operator.</span><pre>IS_NOT</pre></a></li>
<li class="constant  "><a href="#LEFT_JOIN" title="LEFT_JOIN :: LEFT JOIN type."><span class="description">LEFT JOIN type.</span><pre>LEFT_JOIN</pre></a></li>
<li class="constant  "><a href="#LESS_THAN" title="LESS_THAN :: Less than comparison operator."><span class="description">Less than comparison operator.</span><pre>LESS_THAN</pre></a></li>
<li class="constant  "><a href="#LESS_THAN_OR_EQUAL" title="LESS_THAN_OR_EQUAL :: Less than or equal to comparison operator."><span class="description">Less than or equal to comparison operator.</span><pre>LESS_THAN_OR_EQUAL</pre></a></li>
<li class="constant  "><a href="#LIKE" title="LIKE :: LIKE comparison operator."><span class="description">LIKE comparison operator.</span><pre>LIKE</pre></a></li>
<li class="constant  "><a href="#LOGICAL_AND" title="LOGICAL_AND :: AND logical operator."><span class="description">AND logical operator.</span><pre>LOGICAL_AND</pre></a></li>
<li class="constant  "><a href="#LOGICAL_OR" title="LOGICAL_OR :: OR logical operator."><span class="description">OR logical operator.</span><pre>LOGICAL_OR</pre></a></li>
<li class="constant  "><a href="#NOT_BETWEEN" title="NOT_BETWEEN :: NOT BETWEEN comparison operator."><span class="description">NOT BETWEEN comparison operator.</span><pre>NOT_BETWEEN</pre></a></li>
<li class="constant  "><a href="#NOT_EQUALS" title="NOT_EQUALS :: Not equals comparison operator."><span class="description">Not equals comparison operator.</span><pre>NOT_EQUALS</pre></a></li>
<li class="constant  "><a href="#NOT_IN" title="NOT_IN :: NOT IN comparison operator."><span class="description">NOT IN comparison operator.</span><pre>NOT_IN</pre></a></li>
<li class="constant  "><a href="#NOT_LIKE" title="NOT_LIKE :: NOT LIKE comparison operator."><span class="description">NOT LIKE comparison operator.</span><pre>NOT_LIKE</pre></a></li>
<li class="constant  "><a href="#NOT_REGEX" title="NOT_REGEX :: NOT REGEXP comparison operator."><span class="description">NOT REGEXP comparison operator.</span><pre>NOT_REGEX</pre></a></li>
<li class="constant  "><a href="#ORDER_BY_ASC" title="ORDER_BY_ASC :: Ascending ORDER BY direction."><span class="description">Ascending ORDER BY direction.</span><pre>ORDER_BY_ASC</pre></a></li>
<li class="constant  "><a href="#ORDER_BY_DESC" title="ORDER_BY_DESC :: Descending ORDER BY direction."><span class="description">Descending ORDER BY direction.</span><pre>ORDER_BY_DESC</pre></a></li>
<li class="constant  "><a href="#REGEX" title="REGEX :: REGEXP comparison operator."><span class="description">REGEXP comparison operator.</span><pre>REGEX</pre></a></li>
<li class="constant  "><a href="#RIGHT_JOIN" title="RIGHT_JOIN :: RIGHT JOIN type."><span class="description">RIGHT JOIN type.</span><pre>RIGHT_JOIN</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CMiner" id="\Miner"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/Miner.html">Miner</a>
</li>
</ul>
<div href="../classes/Miner.html" class="element class">
<p class="short_description">A dead simple PHP class for building SQL statements.</p>
<div class="details">
<p class="long_description"><p>No manual string
concatenation necessary.</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:hide@address.com">Justin Stayton</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright 2011-2012 by Justin Stayton</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://en.wikipedia.org/wiki/MIT_License">MIT License</a></td>
</tr>
<tr>
<th>package</th>
<td><a href="../packages/Miner.html">Miner</a></td>
</tr>
<tr>
<th>version</th>
<td>0.9.0</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Constructor.</h2>
<pre>__construct(\PDO $PdoConnection, bool $autoQuote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$PdoConnection</h4>
<code><a href="http://php.net/manual/en/class.pdo.php">\PDO</a></code><code>null</code><p>optional PDO database connection</p></div>
<div class="subelement argument">
<h4>$autoQuote</h4>
<code>bool</code><p>optional auto-escape values, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="__toString" id="__toString"></a><div class="element clickable method public __toString" data-toggle="collapse" data-target=".__toString .collapse">
<h2>Get the full SQL statement without value placeholders.</h2>
<pre>__toString() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>full SQL statement</div>
</div></div>
</div>
<a name="andHaving" id="andHaving"></a><div class="element clickable method public andHaving" data-toggle="collapse" data-target=".andHaving .collapse">
<h2>Add an AND HAVING condition.</h2>
<pre>andHaving(string $column, mixed $value, string $operator, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>colum name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="andWhere" id="andWhere"></a><div class="element clickable method public andWhere" data-toggle="collapse" data-target=".andWhere .collapse">
<h2>Add an AND WHERE condition.</h2>
<pre>andWhere(string $column, mixed $value, string $operator, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>colum name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="autoQuote" id="autoQuote"></a><div class="element clickable method public autoQuote" data-toggle="collapse" data-target=".autoQuote .collapse">
<h2>Safely escape a value if auto-quoting is enabled, or do nothing if
disabled.</h2>
<pre>autoQuote(mixed $value, bool | null $override) : mixed | false</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The $override parameter is for convenience in checking if a specific
value should be quoted differently than the rest. 'null' defers to the
global setting.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value to escape (or not)</p>
</div>
<div class="subelement argument">
<h4>$override</h4>
<code>bool</code><code>null</code><p>value-specific override for convenience</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code><code>false</code>value (escaped or original) or false if failed</div>
</div></div>
</div>
<a name="calcFoundRows" id="calcFoundRows"></a><div class="element clickable method public calcFoundRows" data-toggle="collapse" data-target=".calcFoundRows .collapse">
<h2>Add SQL_CALC_FOUND_ROWS execution option.</h2>
<pre>calcFoundRows() : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="closeHaving" id="closeHaving"></a><div class="element clickable method public closeHaving" data-toggle="collapse" data-target=".closeHaving .collapse">
<h2>Add a closing bracket for nesting HAVING conditions.</h2>
<pre>closeHaving() : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="closeWhere" id="closeWhere"></a><div class="element clickable method public closeWhere" data-toggle="collapse" data-target=".closeWhere .collapse">
<h2>Add a closing bracket for nesting WHERE conditions.</h2>
<pre>closeWhere() : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="delete" id="delete"></a><div class="element clickable method public delete" data-toggle="collapse" data-target=".delete .collapse">
<h2>Add a table to DELETE from, or false if deleting from the FROM table.</h2>
<pre>delete(string | false $table) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><code>false</code><p>optional table name, default false</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Add DISTINCT execution option.</h2>
<pre>distinct() : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="execute" id="execute"></a><div class="element clickable method public execute" data-toggle="collapse" data-target=".execute .collapse">
<h2>Execute the statement using the PDO database connection.</h2>
<pre>execute() : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> | false</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code><code>false</code>executed statement or false if failed</div>
</div></div>
</div>
<a name="from" id="from"></a><div class="element clickable method public from" data-toggle="collapse" data-target=".from .collapse">
<h2>Set the FROM table with optional alias.</h2>
<pre>from(string $table, string $alias) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>table name</p></div>
<div class="subelement argument">
<h4>$alias</h4>
<code>string</code><p>optional alias</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="getAutoQuote" id="getAutoQuote"></a><div class="element clickable method public getAutoQuote" data-toggle="collapse" data-target=".getAutoQuote .collapse">
<h2>Get whether values will be automatically escaped.</h2>
<pre>getAutoQuote(bool | null $override) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The $override parameter is for convenience in checking if a specific
value should be quoted differently than the rest. 'null' defers to the
global setting.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$override</h4>
<code>bool</code><code>null</code><p>value-specific override for convenience</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a name="getDeleteString" id="getDeleteString"></a><div class="element clickable method public getDeleteString" data-toggle="collapse" data-target=".getDeleteString .collapse">
<h2>Get the DELETE portion of the statement as a string.</h2>
<pre>getDeleteString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'DELETE' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>DELETE portion of the statement</div>
</div></div>
</div>
<a name="getFrom" id="getFrom"></a><div class="element clickable method public getFrom" data-toggle="collapse" data-target=".getFrom .collapse">
<h2>Get the FROM table.</h2>
<pre>getFrom() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>FROM table</div>
</div></div>
</div>
<a name="getFromAlias" id="getFromAlias"></a><div class="element clickable method public getFromAlias" data-toggle="collapse" data-target=".getFromAlias .collapse">
<h2>Get the FROM table alias.</h2>
<pre>getFromAlias() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>FROM table alias</div>
</div></div>
</div>
<a name="getFromString" id="getFromString"></a><div class="element clickable method public getFromString" data-toggle="collapse" data-target=".getFromString .collapse">
<h2>Get the FROM portion of the statement, including all JOINs, as a string.</h2>
<pre>getFromString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'FROM' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>FROM portion of the statement</div>
</div></div>
</div>
<a name="getGroupByString" id="getGroupByString"></a><div class="element clickable method public getGroupByString" data-toggle="collapse" data-target=".getGroupByString .collapse">
<h2>Get the GROUP BY portion of the statement as a string.</h2>
<pre>getGroupByString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'GROUP BY' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>GROUP BY portion of the statement</div>
</div></div>
</div>
<a name="getHavingPlaceholderValues" id="getHavingPlaceholderValues"></a><div class="element clickable method public getHavingPlaceholderValues" data-toggle="collapse" data-target=".getHavingPlaceholderValues .collapse">
<h2>Get the HAVING placeholder values.</h2>
<pre>getHavingPlaceholderValues() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>HAVING placeholder values</div>
</div></div>
</div>
<a name="getHavingString" id="getHavingString"></a><div class="element clickable method public getHavingString" data-toggle="collapse" data-target=".getHavingString .collapse">
<h2>Get the HAVING portion of the statement as a string.</h2>
<pre>getHavingString(bool $usePlaceholders, bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'HAVING' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>HAVING portion of the statement</div>
</div></div>
</div>
<a name="getInsert" id="getInsert"></a><div class="element clickable method public getInsert" data-toggle="collapse" data-target=".getInsert .collapse">
<h2>Get the INSERT table.</h2>
<pre>getInsert() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>INSERT table</div>
</div></div>
</div>
<a name="getInsertString" id="getInsertString"></a><div class="element clickable method public getInsertString" data-toggle="collapse" data-target=".getInsertString .collapse">
<h2>Get the INSERT portion of the statement as a string.</h2>
<pre>getInsertString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'INSERT' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>INSERT portion of the statement</div>
</div></div>
</div>
<a name="getJoinString" id="getJoinString"></a><div class="element clickable method public getJoinString" data-toggle="collapse" data-target=".getJoinString .collapse">
<h2>Get the JOIN portion of the statement as a string.</h2>
<pre>getJoinString() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>JOIN portion of the statement</div>
</div></div>
</div>
<a name="getLimit" id="getLimit"></a><div class="element clickable method public getLimit" data-toggle="collapse" data-target=".getLimit .collapse">
<h2>Get the LIMIT on number of rows to return.</h2>
<pre>getLimit() : int | string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code><code>string</code>LIMIT on number of rows to return</div>
</div></div>
</div>
<a name="getLimitOffset" id="getLimitOffset"></a><div class="element clickable method public getLimitOffset" data-toggle="collapse" data-target=".getLimitOffset .collapse">
<h2>Get the LIMIT row number to start at.</h2>
<pre>getLimitOffset() : int | string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code><code>string</code>LIMIT row number to start at</div>
</div></div>
</div>
<a name="getLimitString" id="getLimitString"></a><div class="element clickable method public getLimitString" data-toggle="collapse" data-target=".getLimitString .collapse">
<h2>Get the LIMIT portion of the statement as a string.</h2>
<pre>getLimitString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'LIMIT' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>LIMIT portion of the statement</div>
</div></div>
</div>
<a name="getOptionsString" id="getOptionsString"></a><div class="element clickable method public getOptionsString" data-toggle="collapse" data-target=".getOptionsString .collapse">
<h2>Get the execution options portion of the statement as a string.</h2>
<pre>getOptionsString(bool $includeTrailingSpace) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeTrailingSpace</h4>
<code>bool</code><p>optional include space after options</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>execution options portion of the statement</div>
</div></div>
</div>
<a name="getOrderByString" id="getOrderByString"></a><div class="element clickable method public getOrderByString" data-toggle="collapse" data-target=".getOrderByString .collapse">
<h2>Get the ORDER BY portion of the statement as a string.</h2>
<pre>getOrderByString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'ORDER BY' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>ORDER BY portion of the statement</div>
</div></div>
</div>
<a name="getPdoConnection" id="getPdoConnection"></a><div class="element clickable method public getPdoConnection" data-toggle="collapse" data-target=".getPdoConnection .collapse">
<h2>Get the PDO database connection to use in executing this statement.</h2>
<pre>getPdoConnection() : <a href="http://php.net/manual/en/class.pdo.php">\PDO</a> | null</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="http://php.net/manual/en/class.pdo.php">\PDO</a></code><code>null</code>
</div>
</div></div>
</div>
<a name="getPlaceholderValues" id="getPlaceholderValues"></a><div class="element clickable method public getPlaceholderValues" data-toggle="collapse" data-target=".getPlaceholderValues .collapse">
<h2>Get all placeholder values (SET, WHERE, and HAVING).</h2>
<pre>getPlaceholderValues() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>all placeholder values</div>
</div></div>
</div>
<a name="getReplace" id="getReplace"></a><div class="element clickable method public getReplace" data-toggle="collapse" data-target=".getReplace .collapse">
<h2>Get the REPLACE table.</h2>
<pre>getReplace() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>REPLACE table</div>
</div></div>
</div>
<a name="getReplaceString" id="getReplaceString"></a><div class="element clickable method public getReplaceString" data-toggle="collapse" data-target=".getReplaceString .collapse">
<h2>Get the REPLACE portion of the statement as a string.</h2>
<pre>getReplaceString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'REPLACE' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>REPLACE portion of the statement</div>
</div></div>
</div>
<a name="getSelectString" id="getSelectString"></a><div class="element clickable method public getSelectString" data-toggle="collapse" data-target=".getSelectString .collapse">
<h2>Get the SELECT portion of the statement as a string.</h2>
<pre>getSelectString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'SELECT' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>SELECT portion of the statement</div>
</div></div>
</div>
<a name="getSetPlaceholderValues" id="getSetPlaceholderValues"></a><div class="element clickable method public getSetPlaceholderValues" data-toggle="collapse" data-target=".getSetPlaceholderValues .collapse">
<h2>Get the SET placeholder values.</h2>
<pre>getSetPlaceholderValues() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>SET placeholder values</div>
</div></div>
</div>
<a name="getSetString" id="getSetString"></a><div class="element clickable method public getSetString" data-toggle="collapse" data-target=".getSetString .collapse">
<h2>Get the SET portion of the statement as a string.</h2>
<pre>getSetString(bool $usePlaceholders, bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'SET' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>SET portion of the statement</div>
</div></div>
</div>
<a name="getStatement" id="getStatement"></a><div class="element clickable method public getStatement" data-toggle="collapse" data-target=".getStatement .collapse">
<h2>Get the full SQL statement.</h2>
<pre>getStatement(bool $usePlaceholders) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>full SQL statement</div>
</div></div>
</div>
<a name="getUpdate" id="getUpdate"></a><div class="element clickable method public getUpdate" data-toggle="collapse" data-target=".getUpdate .collapse">
<h2>Get the UPDATE table.</h2>
<pre>getUpdate() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>UPDATE table</div>
</div></div>
</div>
<a name="getUpdateString" id="getUpdateString"></a><div class="element clickable method public getUpdateString" data-toggle="collapse" data-target=".getUpdateString .collapse">
<h2>Get the UPDATE portion of the statement as a string.</h2>
<pre>getUpdateString(bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'UPDATE' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>UPDATE portion of the statement</div>
</div></div>
</div>
<a name="getWherePlaceholderValues" id="getWherePlaceholderValues"></a><div class="element clickable method public getWherePlaceholderValues" data-toggle="collapse" data-target=".getWherePlaceholderValues .collapse">
<h2>Get the WHERE placeholder values.</h2>
<pre>getWherePlaceholderValues() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>WHERE placeholder values</div>
</div></div>
</div>
<a name="getWhereString" id="getWhereString"></a><div class="element clickable method public getWhereString" data-toggle="collapse" data-target=".getWhereString .collapse">
<h2>Get the WHERE portion of the statement as a string.</h2>
<pre>getWhereString(bool $usePlaceholders, bool $includeText) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<div class="subelement argument">
<h4>$includeText</h4>
<code>bool</code><p>optional include 'WHERE' text, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>WHERE portion of the statement</div>
</div></div>
</div>
<a name="groupBy" id="groupBy"></a><div class="element clickable method public groupBy" data-toggle="collapse" data-target=".groupBy .collapse">
<h2>Add a GROUP BY column.</h2>
<pre>groupBy(string $column, string | null $order) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$order</h4>
<code>string</code><code>null</code><p>optional order direction, default none</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="having" id="having"></a><div class="element clickable method public having" data-toggle="collapse" data-target=".having .collapse">
<h2>Add a HAVING condition.</h2>
<pre>having(string $column, mixed $value, string $operator, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>colum name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="havingBetween" id="havingBetween"></a><div class="element clickable method public havingBetween" data-toggle="collapse" data-target=".havingBetween .collapse">
<h2>Add a BETWEEN HAVING condition.</h2>
<pre>havingBetween(string $column, mixed $min, mixed $max, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$min</h4>
<code>mixed</code><p>minimum value</p></div>
<div class="subelement argument">
<h4>$max</h4>
<code>mixed</code><p>maximum value</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="havingIn" id="havingIn"></a><div class="element clickable method public havingIn" data-toggle="collapse" data-target=".havingIn .collapse">
<h2>Add an IN WHERE condition.</h2>
<pre>havingIn(string $column, array $values, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$values</h4>
<code>array</code><p>values</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="havingNotBetween" id="havingNotBetween"></a><div class="element clickable method public havingNotBetween" data-toggle="collapse" data-target=".havingNotBetween .collapse">
<h2>Add a NOT BETWEEN HAVING condition.</h2>
<pre>havingNotBetween(string $column, mixed $min, mixed $max, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$min</h4>
<code>mixed</code><p>minimum value</p></div>
<div class="subelement argument">
<h4>$max</h4>
<code>mixed</code><p>maximum value</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="havingNotIn" id="havingNotIn"></a><div class="element clickable method public havingNotIn" data-toggle="collapse" data-target=".havingNotIn .collapse">
<h2>Add a NOT IN HAVING condition.</h2>
<pre>havingNotIn(string $column, array $values, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$values</h4>
<code>array</code><p>values</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="innerJoin" id="innerJoin"></a><div class="element clickable method public innerJoin" data-toggle="collapse" data-target=".innerJoin .collapse">
<h2>Add an INNER JOIN table with optional ON criteria.</h2>
<pre>innerJoin(string $table, string | array $criteria, string $alias) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>table name</p></div>
<div class="subelement argument">
<h4>$criteria</h4>
<code>string</code><code>array</code><p>optional ON criteria</p></div>
<div class="subelement argument">
<h4>$alias</h4>
<code>string</code><p>optional alias</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="insert" id="insert"></a><div class="element clickable method public insert" data-toggle="collapse" data-target=".insert .collapse">
<h2>Set the INSERT table.</h2>
<pre>insert(string $table) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>INSERT table</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="isDelete" id="isDelete"></a><div class="element clickable method public isDelete" data-toggle="collapse" data-target=".isDelete .collapse">
<h2>Whether this is a DELETE statement.</h2>
<pre>isDelete() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>whether this is a DELETE statement</div>
</div></div>
</div>
<a name="isInsert" id="isInsert"></a><div class="element clickable method public isInsert" data-toggle="collapse" data-target=".isInsert .collapse">
<h2>Whether this is an INSERT statement.</h2>
<pre>isInsert() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>whether this is an INSERT statement</div>
</div></div>
</div>
<a name="isReplace" id="isReplace"></a><div class="element clickable method public isReplace" data-toggle="collapse" data-target=".isReplace .collapse">
<h2>Whether this is a REPLACE statement.</h2>
<pre>isReplace() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>whether this is a REPLACE statement</div>
</div></div>
</div>
<a name="isSelect" id="isSelect"></a><div class="element clickable method public isSelect" data-toggle="collapse" data-target=".isSelect .collapse">
<h2>Whether this is a SELECT statement.</h2>
<pre>isSelect() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>whether this is a SELECT statement</div>
</div></div>
</div>
<a name="isUpdate" id="isUpdate"></a><div class="element clickable method public isUpdate" data-toggle="collapse" data-target=".isUpdate .collapse">
<h2>Whether this is an UPDATE statement.</h2>
<pre>isUpdate() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>whether this is an UPDATE statement</div>
</div></div>
</div>
<a name="join" id="join"></a><div class="element clickable method public join" data-toggle="collapse" data-target=".join .collapse">
<h2>Add a JOIN table with optional ON criteria.</h2>
<pre>join(string $table, string | array $criteria, string $type, string $alias) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>table name</p></div>
<div class="subelement argument">
<h4>$criteria</h4>
<code>string</code><code>array</code><p>optional ON criteria</p></div>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code><p>optional type of join, default INNER JOIN</p></div>
<div class="subelement argument">
<h4>$alias</h4>
<code>string</code><p>optional alias</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="leftJoin" id="leftJoin"></a><div class="element clickable method public leftJoin" data-toggle="collapse" data-target=".leftJoin .collapse">
<h2>Add a LEFT JOIN table with optional ON criteria.</h2>
<pre>leftJoin(string $table, string | array $criteria, string $alias) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>table name</p></div>
<div class="subelement argument">
<h4>$criteria</h4>
<code>string</code><code>array</code><p>optional ON criteria</p></div>
<div class="subelement argument">
<h4>$alias</h4>
<code>string</code><p>optional alias</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
<h2>Set the LIMIT on number of rows to return with optional offset.</h2>
<pre>limit(int | string $limit, int | string $offset) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$limit</h4>
<code>int</code><code>string</code><p>number of rows to return</p></div>
<div class="subelement argument">
<h4>$offset</h4>
<code>int</code><code>string</code><p>optional row number to start at, default 0</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeDeleteInto" id="mergeDeleteInto"></a><div class="element clickable method public mergeDeleteInto" data-toggle="collapse" data-target=".mergeDeleteInto .collapse">
<h2>Merge this Miner's DELETE into the given Miner.</h2>
<pre>mergeDeleteInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeFromInto" id="mergeFromInto"></a><div class="element clickable method public mergeFromInto" data-toggle="collapse" data-target=".mergeFromInto .collapse">
<h2>Merge this Miner's FROM into the given Miner.</h2>
<pre>mergeFromInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeGroupByInto" id="mergeGroupByInto"></a><div class="element clickable method public mergeGroupByInto" data-toggle="collapse" data-target=".mergeGroupByInto .collapse">
<h2>Merge this Miner's GROUP BY into the given Miner.</h2>
<pre>mergeGroupByInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeHavingInto" id="mergeHavingInto"></a><div class="element clickable method public mergeHavingInto" data-toggle="collapse" data-target=".mergeHavingInto .collapse">
<h2>Merge this Miner's HAVING into the given Miner.</h2>
<pre>mergeHavingInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeInsertInto" id="mergeInsertInto"></a><div class="element clickable method public mergeInsertInto" data-toggle="collapse" data-target=".mergeInsertInto .collapse">
<h2>Merge this Miner's INSERT into the given Miner.</h2>
<pre>mergeInsertInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeInto" id="mergeInto"></a><div class="element clickable method public mergeInto" data-toggle="collapse" data-target=".mergeInto .collapse">
<h2>Merge this Miner into the given Miner.</h2>
<pre>mergeInto(\Miner $Miner, bool $overrideLimit) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<div class="subelement argument">
<h4>$overrideLimit</h4>
<code>bool</code><p>optional override limit, default true</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeJoinInto" id="mergeJoinInto"></a><div class="element clickable method public mergeJoinInto" data-toggle="collapse" data-target=".mergeJoinInto .collapse">
<h2>Merge this Miner's JOINs into the given Miner.</h2>
<pre>mergeJoinInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeLimitInto" id="mergeLimitInto"></a><div class="element clickable method public mergeLimitInto" data-toggle="collapse" data-target=".mergeLimitInto .collapse">
<h2>Merge this Miner's LIMIT into the given Miner.</h2>
<pre>mergeLimitInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeOptionsInto" id="mergeOptionsInto"></a><div class="element clickable method public mergeOptionsInto" data-toggle="collapse" data-target=".mergeOptionsInto .collapse">
<h2>Merge this Miner's execution options into the given Miner.</h2>
<pre>mergeOptionsInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeOrderByInto" id="mergeOrderByInto"></a><div class="element clickable method public mergeOrderByInto" data-toggle="collapse" data-target=".mergeOrderByInto .collapse">
<h2>Merge this Miner's ORDER BY into the given Miner.</h2>
<pre>mergeOrderByInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeReplaceInto" id="mergeReplaceInto"></a><div class="element clickable method public mergeReplaceInto" data-toggle="collapse" data-target=".mergeReplaceInto .collapse">
<h2>Merge this Miner's REPLACE into the given Miner.</h2>
<pre>mergeReplaceInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeSelectInto" id="mergeSelectInto"></a><div class="element clickable method public mergeSelectInto" data-toggle="collapse" data-target=".mergeSelectInto .collapse">
<h2>Merge this Miner's SELECT into the given Miner.</h2>
<pre>mergeSelectInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeSetInto" id="mergeSetInto"></a><div class="element clickable method public mergeSetInto" data-toggle="collapse" data-target=".mergeSetInto .collapse">
<h2>Merge this Miner's SET into the given Miner.</h2>
<pre>mergeSetInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeUpdateInto" id="mergeUpdateInto"></a><div class="element clickable method public mergeUpdateInto" data-toggle="collapse" data-target=".mergeUpdateInto .collapse">
<h2>Merge this Miner's UPDATE into the given Miner.</h2>
<pre>mergeUpdateInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="mergeWhereInto" id="mergeWhereInto"></a><div class="element clickable method public mergeWhereInto" data-toggle="collapse" data-target=".mergeWhereInto .collapse">
<h2>Merge this Miner's WHERE into the given Miner.</h2>
<pre>mergeWhereInto(\Miner $Miner) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$Miner</h4>
<code><a href="../classes/Miner.html">\Miner</a></code><p>to merge into</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="openHaving" id="openHaving"></a><div class="element clickable method public openHaving" data-toggle="collapse" data-target=".openHaving .collapse">
<h2>Add an open bracket for nesting HAVING conditions.</h2>
<pre>openHaving(string $connector) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="openWhere" id="openWhere"></a><div class="element clickable method public openWhere" data-toggle="collapse" data-target=".openWhere .collapse">
<h2>Add an open bracket for nesting WHERE conditions.</h2>
<pre>openWhere(string $connector) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="option" id="option"></a><div class="element clickable method public option" data-toggle="collapse" data-target=".option .collapse">
<h2>Add an execution option like DISTINCT or SQL_CALC_FOUND_ROWS.</h2>
<pre>option(string $option) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$option</h4>
<code>string</code><p>execution option to add</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="orHaving" id="orHaving"></a><div class="element clickable method public orHaving" data-toggle="collapse" data-target=".orHaving .collapse">
<h2>Add an OR HAVING condition.</h2>
<pre>orHaving(string $column, mixed $value, string $operator, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>colum name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="orWhere" id="orWhere"></a><div class="element clickable method public orWhere" data-toggle="collapse" data-target=".orWhere .collapse">
<h2>Add an OR WHERE condition.</h2>
<pre>orWhere(string $column, mixed $value, string $operator, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>colum name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="orderBy" id="orderBy"></a><div class="element clickable method public orderBy" data-toggle="collapse" data-target=".orderBy .collapse">
<h2>Add a column to ORDER BY.</h2>
<pre>orderBy(string $column, string $order) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$order</h4>
<code>string</code><p>optional order direction, default ASC</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
<h2>Safely escape a value for use in a statement.</h2>
<pre>quote(mixed $value) : mixed | false</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value to escape</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code><code>false</code>escaped value or false if failed</div>
</div></div>
</div>
<a name="replace" id="replace"></a><div class="element clickable method public replace" data-toggle="collapse" data-target=".replace .collapse">
<h2>Set the REPLACE table.</h2>
<pre>replace(string $table) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>REPLACE table</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="rightJoin" id="rightJoin"></a><div class="element clickable method public rightJoin" data-toggle="collapse" data-target=".rightJoin .collapse">
<h2>Add a RIGHT JOIN table with optional ON criteria.</h2>
<pre>rightJoin(string $table, string | array $criteria, string $alias) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>table name</p></div>
<div class="subelement argument">
<h4>$criteria</h4>
<code>string</code><code>array</code><p>optional ON criteria</p></div>
<div class="subelement argument">
<h4>$alias</h4>
<code>string</code><p>optional alias</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="select" id="select"></a><div class="element clickable method public select" data-toggle="collapse" data-target=".select .collapse">
<h2>Add a SELECT column, table, or expression with optional alias.</h2>
<pre>select(string $column, string $alias) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name, table name, or expression</p></div>
<div class="subelement argument">
<h4>$alias</h4>
<code>string</code><p>optional alias</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse">
<h2>Add a column value to INSERT or UPDATE.</h2>
<pre>set(string $column, mixed $value, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="setAutoQuote" id="setAutoQuote"></a><div class="element clickable method public setAutoQuote" data-toggle="collapse" data-target=".setAutoQuote .collapse">
<h2>Set whether to automatically escape values.</h2>
<pre>setAutoQuote(bool | null $autoQuote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$autoQuote</h4>
<code>bool</code><code>null</code><p>whether to automatically escape values</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="setPdoConnection" id="setPdoConnection"></a><div class="element clickable method public setPdoConnection" data-toggle="collapse" data-target=".setPdoConnection .collapse">
<h2>Set the PDO database connection to use in executing this statement.</h2>
<pre>setPdoConnection(\PDO $PdoConnection) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$PdoConnection</h4>
<code><a href="http://php.net/manual/en/class.pdo.php">\PDO</a></code><code>null</code><p>optional PDO database connection</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="update" id="update"></a><div class="element clickable method public update" data-toggle="collapse" data-target=".update .collapse">
<h2>Set the UPDATE table.</h2>
<pre>update(string $table) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>UPDATE table</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="where" id="where"></a><div class="element clickable method public where" data-toggle="collapse" data-target=".where .collapse">
<h2>Add a WHERE condition.</h2>
<pre>where(string $column, mixed $value, string $operator, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="whereBetween" id="whereBetween"></a><div class="element clickable method public whereBetween" data-toggle="collapse" data-target=".whereBetween .collapse">
<h2>Add a BETWEEN WHERE condition.</h2>
<pre>whereBetween(string $column, mixed $min, mixed $max, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$min</h4>
<code>mixed</code><p>minimum value</p></div>
<div class="subelement argument">
<h4>$max</h4>
<code>mixed</code><p>maximum value</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="whereIn" id="whereIn"></a><div class="element clickable method public whereIn" data-toggle="collapse" data-target=".whereIn .collapse">
<h2>Add an IN WHERE condition.</h2>
<pre>whereIn(string $column, array $values, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$values</h4>
<code>array</code><p>values</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="whereNotBetween" id="whereNotBetween"></a><div class="element clickable method public whereNotBetween" data-toggle="collapse" data-target=".whereNotBetween .collapse">
<h2>Add a NOT BETWEEN WHERE condition.</h2>
<pre>whereNotBetween(string $column, mixed $min, mixed $max, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$min</h4>
<code>mixed</code><p>minimum value</p></div>
<div class="subelement argument">
<h4>$max</h4>
<code>mixed</code><p>maximum value</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="whereNotIn" id="whereNotIn"></a><div class="element clickable method public whereNotIn" data-toggle="collapse" data-target=".whereNotIn .collapse">
<h2>Add a NOT IN WHERE condition.</h2>
<pre>whereNotIn(string $column, array $values, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$values</h4>
<code>array</code><p>values</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="closeCriteria" id="closeCriteria"></a><div class="element clickable method private closeCriteria" data-toggle="collapse" data-target=".closeCriteria .collapse">
<h2>Add a closing bracket for nesting conditions to the specified WHERE or
HAVING criteria.</h2>
<pre>closeCriteria(array $criteria) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="criteria" id="criteria"></a><div class="element clickable method private criteria" data-toggle="collapse" data-target=".criteria .collapse">
<h2>Add a condition to the specified WHERE or HAVING criteria.</h2>
<pre>criteria(array $criteria, string $column, mixed $value, string $operator, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="criteriaBetween" id="criteriaBetween"></a><div class="element clickable method private criteriaBetween" data-toggle="collapse" data-target=".criteriaBetween .collapse">
<h2>Add a BETWEEN condition to the specified WHERE or HAVING criteria.</h2>
<pre>criteriaBetween(array $criteria, string $column, mixed $min, mixed $max, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$min</h4>
<code>mixed</code><p>minimum value</p></div>
<div class="subelement argument">
<h4>$max</h4>
<code>mixed</code><p>maximum value</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="criteriaIn" id="criteriaIn"></a><div class="element clickable method private criteriaIn" data-toggle="collapse" data-target=".criteriaIn .collapse">
<h2>Add an IN condition to the specified WHERE or HAVING criteria.</h2>
<pre>criteriaIn(array $criteria, string $column, array $values, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$values</h4>
<code>array</code><p>values</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="criteriaNotBetween" id="criteriaNotBetween"></a><div class="element clickable method private criteriaNotBetween" data-toggle="collapse" data-target=".criteriaNotBetween .collapse">
<h2>Add a NOT BETWEEN condition to the specified WHERE or HAVING criteria.</h2>
<pre>criteriaNotBetween(array $criteria, string $column, mixed $min, mixed $max, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$min</h4>
<code>mixed</code><p>minimum value</p></div>
<div class="subelement argument">
<h4>$max</h4>
<code>mixed</code><p>maximum value</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="criteriaNotIn" id="criteriaNotIn"></a><div class="element clickable method private criteriaNotIn" data-toggle="collapse" data-target=".criteriaNotIn .collapse">
<h2>Add a NOT IN condition to the specified WHERE or HAVING criteria.</h2>
<pre>criteriaNotIn(array $criteria, string $column, array $values, string $connector, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$values</h4>
<code>array</code><p>values</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="getCriteriaString" id="getCriteriaString"></a><div class="element clickable method private getCriteriaString" data-toggle="collapse" data-target=".getCriteriaString .collapse">
<h2>Get the WHERE or HAVING portion of the statement as a string.</h2>
<pre>getCriteriaString(array $criteria, bool $usePlaceholders, array $placeholderValues) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<div class="subelement argument">
<h4>$placeholderValues</h4>
<code>array</code><p>optional placeholder values array</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>WHERE or HAVING portion of the statement</div>
</div></div>
</div>
<a name="getDeleteStatement" id="getDeleteStatement"></a><div class="element clickable method private getDeleteStatement" data-toggle="collapse" data-target=".getDeleteStatement .collapse">
<h2>Get the full DELETE statement.</h2>
<pre>getDeleteStatement(bool $usePlaceholders) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>full DELETE statement</div>
</div></div>
</div>
<a name="getInsertStatement" id="getInsertStatement"></a><div class="element clickable method private getInsertStatement" data-toggle="collapse" data-target=".getInsertStatement .collapse">
<h2>Get the full INSERT statement.</h2>
<pre>getInsertStatement(bool $usePlaceholders) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>full INSERT statement</div>
</div></div>
</div>
<a name="getJoinCriteriaUsingPreviousTable" id="getJoinCriteriaUsingPreviousTable"></a><div class="element clickable method private getJoinCriteriaUsingPreviousTable" data-toggle="collapse" data-target=".getJoinCriteriaUsingPreviousTable .collapse">
<h2>Get an ON criteria string joining the specified table and column to the
same column of the previous JOIN or FROM table.</h2>
<pre>getJoinCriteriaUsingPreviousTable(int $joinIndex, string $table, string $column) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$joinIndex</h4>
<code>int</code><p>index of current join</p></div>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>current table name</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>current column name</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>ON join criteria</div>
</div></div>
</div>
<a name="getReplaceStatement" id="getReplaceStatement"></a><div class="element clickable method private getReplaceStatement" data-toggle="collapse" data-target=".getReplaceStatement .collapse">
<h2>Get the full REPLACE statement.</h2>
<pre>getReplaceStatement(bool $usePlaceholders) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>full REPLACE statement</div>
</div></div>
</div>
<a name="getSelectStatement" id="getSelectStatement"></a><div class="element clickable method private getSelectStatement" data-toggle="collapse" data-target=".getSelectStatement .collapse">
<h2>Get the full SELECT statement.</h2>
<pre>getSelectStatement(bool $usePlaceholders) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>full SELECT statement</div>
</div></div>
</div>
<a name="getUpdateStatement" id="getUpdateStatement"></a><div class="element clickable method private getUpdateStatement" data-toggle="collapse" data-target=".getUpdateStatement .collapse">
<h2>Get the full UPDATE statement.</h2>
<pre>getUpdateStatement(bool $usePlaceholders) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$usePlaceholders</h4>
<code>bool</code><p>optional use ? placeholders, default true</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>full UPDATE statement</div>
</div></div>
</div>
<a name="isDeleteTableFrom" id="isDeleteTableFrom"></a><div class="element clickable method private isDeleteTableFrom" data-toggle="collapse" data-target=".isDeleteTableFrom .collapse">
<h2>Whether the FROM table is the single table to delete from.</h2>
<pre>isDeleteTableFrom() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>whether the delete table is FROM</div>
</div></div>
</div>
<a name="openCriteria" id="openCriteria"></a><div class="element clickable method private openCriteria" data-toggle="collapse" data-target=".openCriteria .collapse">
<h2>Add an open bracket for nesting conditions to the specified WHERE or
HAVING criteria.</h2>
<pre>openCriteria(array $criteria, string $connector) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$connector</h4>
<code>string</code><p>optional logical connector, default AND</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<a name="orCriteria" id="orCriteria"></a><div class="element clickable method private orCriteria" data-toggle="collapse" data-target=".orCriteria .collapse">
<h2>Add an OR condition to the specified WHERE or HAVING criteria.</h2>
<pre>orCriteria(array $criteria, string $column, mixed $value, string $operator, bool | null $quote) : <a href="../classes/Miner.html">\Miner</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$criteria</h4>
<code>array</code><p>WHERE or HAVING criteria</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>column name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value</p></div>
<div class="subelement argument">
<h4>$operator</h4>
<code>string</code><p>optional comparison operator, default =</p>
</div>
<div class="subelement argument">
<h4>$quote</h4>
<code>bool</code><code>null</code><p>optional auto-escape value, default to global</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Miner.html">\Miner</a></code></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24PdoConnection" id="$PdoConnection"> </a><div class="element clickable property private $PdoConnection" data-toggle="collapse" data-target=".$PdoConnection .collapse">
<h2>PDO database connection to use in executing the statement.</h2>
<pre>$PdoConnection : <a href="http://php.net/manual/en/class.pdo.php">\PDO</a> | null</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24autoQuote" id="$autoQuote"> </a><div class="element clickable property private $autoQuote" data-toggle="collapse" data-target=".$autoQuote .collapse">
<h2>Whether to automatically escape values.</h2>
<pre>$autoQuote : bool | null</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24delete" id="$delete"> </a><div class="element clickable property private $delete" data-toggle="collapse" data-target=".$delete .collapse">
<h2>Tables to DELETE from, or true if deleting from the FROM table.</h2>
<pre>$delete : array | true</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24from" id="$from"> </a><div class="element clickable property private $from" data-toggle="collapse" data-target=".$from .collapse">
<h2>Table to select FROM.</h2>
<pre>$from : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24groupBy" id="$groupBy"> </a><div class="element clickable property private $groupBy" data-toggle="collapse" data-target=".$groupBy .collapse">
<h2>Columns to GROUP BY.</h2>
<pre>$groupBy : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24having" id="$having"> </a><div class="element clickable property private $having" data-toggle="collapse" data-target=".$having .collapse">
<h2>HAVING criteria.</h2>
<pre>$having : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24havingPlaceholderValues" id="$havingPlaceholderValues"> </a><div class="element clickable property private $havingPlaceholderValues" data-toggle="collapse" data-target=".$havingPlaceholderValues .collapse">
<h2>HAVING placeholder values.</h2>
<pre>$havingPlaceholderValues : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24insert" id="$insert"> </a><div class="element clickable property private $insert" data-toggle="collapse" data-target=".$insert .collapse">
<h2>Table to INSERT into.</h2>
<pre>$insert : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24join" id="$join"> </a><div class="element clickable property private $join" data-toggle="collapse" data-target=".$join .collapse">
<h2>JOIN tables and ON criteria.</h2>
<pre>$join : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24limit" id="$limit"> </a><div class="element clickable property private $limit" data-toggle="collapse" data-target=".$limit .collapse">
<h2>Number of rows to return from offset.</h2>
<pre>$limit : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24option" id="$option"> </a><div class="element clickable property private $option" data-toggle="collapse" data-target=".$option .collapse">
<h2>Execution options like DISTINCT and SQL_CALC_FOUND_ROWS.</h2>
<pre>$option : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24orderBy" id="$orderBy"> </a><div class="element clickable property private $orderBy" data-toggle="collapse" data-target=".$orderBy .collapse">
<h2>Columns to ORDER BY.</h2>
<pre>$orderBy : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24replace" id="$replace"> </a><div class="element clickable property private $replace" data-toggle="collapse" data-target=".$replace .collapse">
<h2>Table to REPLACE into.</h2>
<pre>$replace : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24select" id="$select"> </a><div class="element clickable property private $select" data-toggle="collapse" data-target=".$select .collapse">
<h2>Columns, tables, and expressions to SELECT from.</h2>
<pre>$select : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24set" id="$set"> </a><div class="element clickable property private $set" data-toggle="collapse" data-target=".$set .collapse">
<h2>Column values to INSERT or UPDATE.</h2>
<pre>$set : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24setPlaceholderValues" id="$setPlaceholderValues"> </a><div class="element clickable property private $setPlaceholderValues" data-toggle="collapse" data-target=".$setPlaceholderValues .collapse">
<h2>SET placeholder values.</h2>
<pre>$setPlaceholderValues : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24update" id="$update"> </a><div class="element clickable property private $update" data-toggle="collapse" data-target=".$update .collapse">
<h2>Table to UPDATE.</h2>
<pre>$update : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24where" id="$where"> </a><div class="element clickable property private $where" data-toggle="collapse" data-target=".$where .collapse">
<h2>WHERE criteria.</h2>
<pre>$where : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24wherePlaceholderValues" id="$wherePlaceholderValues"> </a><div class="element clickable property private $wherePlaceholderValues" data-toggle="collapse" data-target=".$wherePlaceholderValues .collapse">
<h2>WHERE placeholder values.</h2>
<pre>$wherePlaceholderValues : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="BETWEEN" id="BETWEEN"> </a><div class="element clickable constant  BETWEEN" data-toggle="collapse" data-target=".BETWEEN .collapse">
<h2>BETWEEN comparison operator.</h2>
<pre>BETWEEN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="BRACKET_CLOSE" id="BRACKET_CLOSE"> </a><div class="element clickable constant  BRACKET_CLOSE" data-toggle="collapse" data-target=".BRACKET_CLOSE .collapse">
<h2>Closing bracket for grouping criteria.</h2>
<pre>BRACKET_CLOSE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="BRACKET_OPEN" id="BRACKET_OPEN"> </a><div class="element clickable constant  BRACKET_OPEN" data-toggle="collapse" data-target=".BRACKET_OPEN .collapse">
<h2>Open bracket for grouping criteria.</h2>
<pre>BRACKET_OPEN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="EQUALS" id="EQUALS"> </a><div class="element clickable constant  EQUALS" data-toggle="collapse" data-target=".EQUALS .collapse">
<h2>Equals comparison operator.</h2>
<pre>EQUALS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="GREATER_THAN" id="GREATER_THAN"> </a><div class="element clickable constant  GREATER_THAN" data-toggle="collapse" data-target=".GREATER_THAN .collapse">
<h2>Greater than comparison operator.</h2>
<pre>GREATER_THAN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="GREATER_THAN_OR_EQUAL" id="GREATER_THAN_OR_EQUAL"> </a><div class="element clickable constant  GREATER_THAN_OR_EQUAL" data-toggle="collapse" data-target=".GREATER_THAN_OR_EQUAL .collapse">
<h2>Greater than or equal to comparison operator.</h2>
<pre>GREATER_THAN_OR_EQUAL </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="ILIKE" id="ILIKE"> </a><div class="element clickable constant  ILIKE" data-toggle="collapse" data-target=".ILIKE .collapse">
<h2>ILIKE comparison operator.</h2>
<pre>ILIKE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IN" id="IN"> </a><div class="element clickable constant  IN" data-toggle="collapse" data-target=".IN .collapse">
<h2>IN comparison operator.</h2>
<pre>IN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="INNER_JOIN" id="INNER_JOIN"> </a><div class="element clickable constant  INNER_JOIN" data-toggle="collapse" data-target=".INNER_JOIN .collapse">
<h2>INNER JOIN type.</h2>
<pre>INNER_JOIN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IS" id="IS"> </a><div class="element clickable constant  IS" data-toggle="collapse" data-target=".IS .collapse">
<h2>IS comparison operator.</h2>
<pre>IS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IS_NOT" id="IS_NOT"> </a><div class="element clickable constant  IS_NOT" data-toggle="collapse" data-target=".IS_NOT .collapse">
<h2>IS NOT comparison operator.</h2>
<pre>IS_NOT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="LEFT_JOIN" id="LEFT_JOIN"> </a><div class="element clickable constant  LEFT_JOIN" data-toggle="collapse" data-target=".LEFT_JOIN .collapse">
<h2>LEFT JOIN type.</h2>
<pre>LEFT_JOIN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="LESS_THAN" id="LESS_THAN"> </a><div class="element clickable constant  LESS_THAN" data-toggle="collapse" data-target=".LESS_THAN .collapse">
<h2>Less than comparison operator.</h2>
<pre>LESS_THAN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="LESS_THAN_OR_EQUAL" id="LESS_THAN_OR_EQUAL"> </a><div class="element clickable constant  LESS_THAN_OR_EQUAL" data-toggle="collapse" data-target=".LESS_THAN_OR_EQUAL .collapse">
<h2>Less than or equal to comparison operator.</h2>
<pre>LESS_THAN_OR_EQUAL </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="LIKE" id="LIKE"> </a><div class="element clickable constant  LIKE" data-toggle="collapse" data-target=".LIKE .collapse">
<h2>LIKE comparison operator.</h2>
<pre>LIKE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="LOGICAL_AND" id="LOGICAL_AND"> </a><div class="element clickable constant  LOGICAL_AND" data-toggle="collapse" data-target=".LOGICAL_AND .collapse">
<h2>AND logical operator.</h2>
<pre>LOGICAL_AND </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="LOGICAL_OR" id="LOGICAL_OR"> </a><div class="element clickable constant  LOGICAL_OR" data-toggle="collapse" data-target=".LOGICAL_OR .collapse">
<h2>OR logical operator.</h2>
<pre>LOGICAL_OR </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="NOT_BETWEEN" id="NOT_BETWEEN"> </a><div class="element clickable constant  NOT_BETWEEN" data-toggle="collapse" data-target=".NOT_BETWEEN .collapse">
<h2>NOT BETWEEN comparison operator.</h2>
<pre>NOT_BETWEEN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="NOT_EQUALS" id="NOT_EQUALS"> </a><div class="element clickable constant  NOT_EQUALS" data-toggle="collapse" data-target=".NOT_EQUALS .collapse">
<h2>Not equals comparison operator.</h2>
<pre>NOT_EQUALS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="NOT_IN" id="NOT_IN"> </a><div class="element clickable constant  NOT_IN" data-toggle="collapse" data-target=".NOT_IN .collapse">
<h2>NOT IN comparison operator.</h2>
<pre>NOT_IN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="NOT_LIKE" id="NOT_LIKE"> </a><div class="element clickable constant  NOT_LIKE" data-toggle="collapse" data-target=".NOT_LIKE .collapse">
<h2>NOT LIKE comparison operator.</h2>
<pre>NOT_LIKE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="NOT_REGEX" id="NOT_REGEX"> </a><div class="element clickable constant  NOT_REGEX" data-toggle="collapse" data-target=".NOT_REGEX .collapse">
<h2>NOT REGEXP comparison operator.</h2>
<pre>NOT_REGEX </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="ORDER_BY_ASC" id="ORDER_BY_ASC"> </a><div class="element clickable constant  ORDER_BY_ASC" data-toggle="collapse" data-target=".ORDER_BY_ASC .collapse">
<h2>Ascending ORDER BY direction.</h2>
<pre>ORDER_BY_ASC </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="ORDER_BY_DESC" id="ORDER_BY_DESC"> </a><div class="element clickable constant  ORDER_BY_DESC" data-toggle="collapse" data-target=".ORDER_BY_DESC .collapse">
<h2>Descending ORDER BY direction.</h2>
<pre>ORDER_BY_DESC </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="REGEX" id="REGEX"> </a><div class="element clickable constant  REGEX" data-toggle="collapse" data-target=".REGEX .collapse">
<h2>REGEXP comparison operator.</h2>
<pre>REGEX </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="RIGHT_JOIN" id="RIGHT_JOIN"> </a><div class="element clickable constant  RIGHT_JOIN" data-toggle="collapse" data-target=".RIGHT_JOIN .collapse">
<h2>RIGHT JOIN type.</h2>
<pre>RIGHT_JOIN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></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.0.0a10</a> and<br>
            generated on 2012-09-17T06:12:38-05:00.<br></footer></div>
</div>
</body>
</html>
Return current item: Miner