2018-01-24 15:31:27 -05:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en" >
< head >
< title > phpDox - Query\QueryBuilder< / title >
< link rel = "stylesheet" type = "text/css" href = "../css/style.css" media = "screen" / >
< meta http-equiv = "content-type" content = "text/html; charset=utf-8" / >
< / head >
< body >
< nav class = "topnav" >
< ul >
< li >
< div class = "logo" > < span > /**< / span > phpDox< / div >
< / li >
< li class = "separator" >
< a href = "../index.html" > Overview< / a >
< / li >
< li class = "separator" >
< a href = "../namespaces.html" > Namespaces< / a >
< / li >
< li >
< a href = "../interfaces.html" > Interfaces< / a >
< / li >
< li >
< a href = "../classes.html" > Classes< / a >
< / li >
< li class = "separator" >
< a href = "../source/index.html" > Source< / a >
< / li >
< / ul >
< / nav >
< div id = "mainstage" >
< div class = "box" >
< ul class = "breadcrumb" >
< li >
< a href = "../index.html" > Overview< / a >
< / li >
< li class = "separator" >
< a href = "../classes.html" > Classes< / a >
< / li >
< li class = "separator" >
< a href = "../classes.html#Query" > Query< / a >
< / li >
< li class = "separator" > QueryBuilder< / li >
< / ul >
< / div >
< nav class = "box" >
< ul >
< li >
< a href = "#introduction" > Introduction< / a >
< / li >
< li >
< a href = "#synopsis" > Synopsis< / a >
< / li >
< li >
< a href = "#hierarchy" > Hierarchy< / a >
< / li >
< li >
< a href = "#members" > Members< / a >
< / li >
< li >
< a href = "#methods" > Methods< / a >
< / li >
< li >
2020-04-17 15:05:37 -04:00
< a href = "../source/QueryBuilder.php.html#line26" > Source< / a >
2018-01-24 15:31:27 -05:00
< / li >
< / ul >
< / nav >
< section >
< h1 id = "introduction" > < small > Query\< / small > QueryBuilder< / h1 >
< h4 > Convenience class for creating sql queries< / h4 >
< p / >
< ul / >
< h2 id = "synopsis" > Synopsis< / h2 >
< div class = "synopsis" > class
2020-04-17 15:05:37 -04:00
extends < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase.html" > QueryBuilderBase< / a >
2018-01-24 15:31:27 -05:00
implements
< a title = "Query\QueryBuilderInterface" href = "../interfaces/Query_QueryBuilderInterface.html" > QueryBuilderInterface< / a >
2020-04-17 15:05:37 -04:00
{< br / > < ul class = "none" > < li > // Inherited members from < span title = "Query\QueryBuilderBase" > QueryBuilderBase< / span > < / li > < li > public < a href = "#members" > $connName< / a > ;
< / li > < li > public < a href = "#members" > $queries< / a > ;
< / li > < / ul > < ul class = "none" > < li > // methods< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/select.html" > select< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectMax.html" > selectMax< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectMin.html" > selectMin< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectAvg.html" > selectAvg< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectSum.html" > selectSum< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/returning.html" > returning< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/distinct.html" > distinct< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/explain.html" > explain< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/from.html" > from< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/like.html" > like< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orLike.html" > orLike< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/notLike.html" > notLike< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orNotLike.html" > orNotLike< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/having.html" > having< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orHaving.html" > orHaving< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/where.html" > where< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orWhere.html" > orWhere< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/whereIn.html" > whereIn< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orWhereIn.html" > orWhereIn< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/whereNotIn.html" > whereNotIn< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orWhereNotIn.html" > orWhereNotIn< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/set.html" > set< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/join.html" > join< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/groupBy.html" > groupBy< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orderBy.html" > orderBy< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/limit.html" > limit< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/groupStart.html" > groupStart< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/notGroupStart.html" > notGroupStart< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orGroupStart.html" > orGroupStart< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orNotGroupStart.html" > orNotGroupStart< / a > ()
< / li > < li > public < span title = "QueryBuilder" > QueryBuilder< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/groupEnd.html" > groupEnd< / a > ()
2018-01-26 16:27:34 -05:00
< / li > < li > public < span title = "PDOStatement" > PDOStatement< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/get.html" > get< / a > ()
< / li > < li > public < span title = "PDOStatement" > PDOStatement< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getWhere.html" > getWhere< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < li > public < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/countAll.html" > countAll< / a > ()
< / li > < li > public < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/countAllResults.html" > countAllResults< / a > ()
2018-01-26 16:27:34 -05:00
< / li > < li > public < span title = "PDOStatement" > PDOStatement< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/insert.html" > insert< / a > ()
2020-04-17 15:05:37 -04:00
< / li > < li > public < span title = "PDOStatement" > PDOStatement< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/insertBatch.html" > insertBatch< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < li > public < span title = "PDOStatement" > PDOStatement< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/update.html" > update< / a > ()
2018-01-26 09:16:13 -05:00
< / li > < li > public < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/updateBatch.html" > updateBatch< / a > ()
2018-01-26 16:27:34 -05:00
< / li > < li > public < span title = "PDOStatement" > PDOStatement< / span > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/delete.html" > delete< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < li > public < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledSelect.html" > getCompiledSelect< / a > ()
< / li > < li > public < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledInsert.html" > getCompiledInsert< / a > ()
< / li > < li > public < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledUpdate.html" > getCompiledUpdate< / a > ()
< / li > < li > public < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledDelete.html" > getCompiledDelete< / a > ()
2020-04-17 15:05:37 -04:00
< / li > < / ul > < ul class = "none" > < li > // Inherited methods from < span title = "Query\QueryBuilderBase" > QueryBuilderBase< / span > < / li > < li > public < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase/__construct.html" > __construct< / a > ()
< / li > < li > public < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase/__destruct.html" > __destruct< / a > ()
< / li > < li > public < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase/__call.html" > __call< / a > ()
< / li > < li > public < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase/resetQuery.html" > resetQuery< / a > ()
< / li > < / ul >
2018-01-24 15:31:27 -05:00
}< br / > < / div >
< h2 id = "hierarchy" > Hierarchy< / h2 >
< div class = "styled" >
2020-04-17 15:05:37 -04:00
< h4 > Extends< / h4 >
< ul >
< li >
< a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase.html" > Query\QueryBuilderBase< / a >
< / li >
< / ul >
2018-01-24 15:31:27 -05:00
< h4 > Implements< / h4 >
< ul >
< li >
< a title = "Query\QueryBuilderInterface" href = "../interfaces/Query_QueryBuilderInterface.html" > Query\QueryBuilderInterface< / a >
< / li >
< / ul >
< / div >
< h2 id = "members" > Members< / h2 >
< div class = "styled members" >
< h4 > public< / h4 >
< ul class = "members" >
< li id = "connName" > < strong > $connName< / strong >
—
string< br / > < span class = "indent" > Convenience property for connection management< / span > < / li >
< li id = "queries" > < strong > $queries< / strong >
—
array< br / > < span class = "indent" > List of queries executed< / span > < / li >
< / ul >
< / div >
< h2 id = "methods" > Methods< / h2 >
< div class = "styled" >
< h4 > public< / h4 >
< ul >
< li id = "countAll" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/countAll.html" > countAll()< / a >
— Retrieve the number of rows in the selected table< / li >
< li id = "countAllResults" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/countAllResults.html" > countAllResults()< / a >
— Retrieve the number of results for the generated query - used in place of the get() method< / li >
< li id = "delete" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/delete.html" > delete()< / a >
— Deletes data from a table< / li >
< li id = "distinct" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/distinct.html" > distinct()< / a >
— Adds the 'distinct' keyword to a query< / li >
< li id = "explain" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/explain.html" > explain()< / a >
— Tell the database to give you the query plan instead of result set< / li >
< li id = "from" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/from.html" > from()< / a >
— Specify the database table to select from< / li >
< li id = "get" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/get.html" > get()< / a >
— Select and retrieve all records from the current table, and/or execute current compiled query< / li >
< li id = "getCompiledDelete" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledDelete.html" > getCompiledDelete()< / a >
— Returns the generated 'delete' sql query< / li >
< li id = "getCompiledInsert" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledInsert.html" > getCompiledInsert()< / a >
— Returns the generated 'insert' sql query< / li >
< li id = "getCompiledSelect" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledSelect.html" > getCompiledSelect()< / a >
— Returns the generated 'select' sql query< / li >
< li id = "getCompiledUpdate" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getCompiledUpdate.html" > getCompiledUpdate()< / a >
— Returns the generated 'update' sql query< / li >
< li id = "getWhere" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/getWhere.html" > getWhere()< / a >
— Convenience method for get() with a where clause< / li >
< li id = "groupBy" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/groupBy.html" > groupBy()< / a >
— Group the results by the selected field(s)< / li >
< li id = "groupEnd" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/groupEnd.html" > groupEnd()< / a >
— Ends a query group< / li >
< li id = "groupStart" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/groupStart.html" > groupStart()< / a >
— Adds a paren to the current query for query grouping< / li >
< li id = "having" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/having.html" > having()< / a >
— Generates a 'Having' clause< / li >
< li id = "insert" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/insert.html" > insert()< / a >
— Creates an insert clause, and executes it< / li >
< li id = "insertBatch" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/insertBatch.html" > insertBatch()< / a >
— Creates and executes a batch insertion query< / li >
< li id = "join" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/join.html" > join()< / a >
— Creates a join phrase in a compiled query< / li >
< li id = "like" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/like.html" > like()< / a >
— Creates a Like clause in the sql statement< / li >
< li id = "limit" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/limit.html" > limit()< / a >
— Set a limit on the current sql statement< / li >
< li id = "notGroupStart" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/notGroupStart.html" > notGroupStart()< / a >
— Adds a paren to the current query for query grouping, prefixed with 'NOT'< / li >
< li id = "notLike" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/notLike.html" > notLike()< / a >
— Generates a NOT LIKE clause< / li >
< li id = "orGroupStart" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orGroupStart.html" > orGroupStart()< / a >
— Adds a paren to the current query for query grouping, prefixed with 'OR'< / li >
< li id = "orHaving" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orHaving.html" > orHaving()< / a >
— Generates a 'Having' clause prefixed with 'OR'< / li >
< li id = "orLike" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orLike.html" > orLike()< / a >
— Generates an OR Like clause< / li >
< li id = "orNotGroupStart" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orNotGroupStart.html" > orNotGroupStart()< / a >
— Adds a paren to the current query for query grouping, prefixed with 'OR NOT'< / li >
< li id = "orNotLike" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orNotLike.html" > orNotLike()< / a >
— Generates a OR NOT LIKE clause< / li >
< li id = "orWhere" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orWhere.html" > orWhere()< / a >
— Where clause prefixed with "OR"< / li >
< li id = "orWhereIn" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orWhereIn.html" > orWhereIn()< / a >
— Where in statement prefixed with "or"< / li >
< li id = "orWhereNotIn" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orWhereNotIn.html" > orWhereNotIn()< / a >
— OR WHERE NOT IN (FOO) clause< / li >
< li id = "orderBy" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/orderBy.html" > orderBy()< / a >
— Order the results by the selected field(s)< / li >
2020-04-17 15:05:37 -04:00
< li id = "returning" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/returning.html" > returning()< / a >
— Add a 'returning' clause to an insert,update, or delete query< / li >
2018-01-24 15:31:27 -05:00
< li id = "select" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/select.html" > select()< / a >
— Specifies rows to select in a query< / li >
< li id = "selectAvg" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectAvg.html" > selectAvg()< / a >
— Selects the average value of a field from a query< / li >
< li id = "selectMax" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectMax.html" > selectMax()< / a >
— Selects the maximum value of a field from a query< / li >
< li id = "selectMin" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectMin.html" > selectMin()< / a >
— Selects the minimum value of a field from a query< / li >
< li id = "selectSum" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/selectSum.html" > selectSum()< / a >
— Selects the sum of a field from a query< / li >
< li id = "set" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/set.html" > set()< / a >
— Sets values for inserts / updates / deletes< / li >
< li id = "update" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/update.html" > update()< / a >
— Creates an update clause, and executes it< / li >
< li id = "updateBatch" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/updateBatch.html" > updateBatch()< / a >
— Creates a batch update, and executes it.< / li >
< li id = "where" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/where.html" > where()< / a >
— Specify condition(s) in the where clause of a query Note: this function works with key / value, or a passed array with key / value pairs< / li >
< li id = "whereIn" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/whereIn.html" > whereIn()< / a >
— Where clause with 'IN' statement< / li >
< li id = "whereNotIn" > < a title = "Query\QueryBuilder" href = "../classes/Query_QueryBuilder/whereNotIn.html" > whereNotIn()< / a >
— WHERE NOT IN (FOO) clause< / li >
< / ul >
2020-04-17 15:05:37 -04:00
< h3 > Inherited from < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase.html" > Query\QueryBuilderBase< / a > < / h3 >
< h4 > public< / h4 >
< ul >
< li id = "__call" > < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase/__call.html" > __call()< / a >
— Calls a function further down the inheritance chain.< / li >
< li id = "resetQuery" > < a title = "Query\QueryBuilderBase" href = "../classes/Query_QueryBuilderBase/resetQuery.html" > resetQuery()< / a >
— Clear out the class variables, so the next query can be run< / li >
< / ul >
2018-01-24 15:31:27 -05:00
< / div >
< / section >
< / div >
< footer >
2020-04-17 15:05:37 -04:00
< span > Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors< / span >
2018-01-24 15:31:27 -05:00
< / footer >
< / body >
< / html >
