Query/src/QueryBuilder.php

650 lines
16 KiB
PHP
Raw Normal View History

2016-10-12 22:12:25 -04:00
<?php declare(strict_types=1);
2012-03-15 09:25:18 -04:00
/**
* Query
*
2016-09-07 13:17:17 -04:00
* SQL Query Builder / Database Abstraction Layer
2012-03-15 09:25:18 -04:00
*
2022-09-29 11:33:08 -04:00
* PHP version 8.1
2016-09-07 13:17:17 -04:00
*
* @package Query
* @author Timothy J. Warren <tim@timshomepage.net>
2022-09-29 11:33:08 -04:00
* @copyright 2012 - 2022 Timothy J. Warren
2016-09-07 13:17:17 -04:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2019-12-11 16:49:42 -05:00
* @link https://git.timshomepage.net/aviat/Query
2022-09-29 11:33:08 -04:00
* @version 4.0.0
2012-03-15 09:25:18 -04:00
*/
2014-04-02 17:08:50 -04:00
namespace Query;
2014-04-07 18:28:53 -04:00
use function is_array;
use function is_int;
2020-04-23 18:16:32 -04:00
use function mb_trim;
2019-12-10 12:17:40 -05:00
2016-10-12 22:12:25 -04:00
use PDOStatement;
2014-04-24 17:07:50 -04:00
2012-03-15 09:25:18 -04:00
/**
2016-10-13 21:55:23 -04:00
* Convenience class for creating sql queries
2012-03-15 09:25:18 -04:00
*/
class QueryBuilder extends QueryBuilderBase implements QueryBuilderInterface {
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! Select Queries
// --------------------------------------------------------------------------
/**
* Specifies rows to select in a query
*/
public function select(string $fields): self
2012-03-15 09:25:18 -04:00
{
// Split fields by comma
2016-10-13 21:55:23 -04:00
$fieldsArray = explode(',', $fields);
$fieldsArray = array_map('mb_trim', $fieldsArray);
2012-03-15 09:25:18 -04:00
// Split on 'As'
2016-10-13 21:55:23 -04:00
foreach ($fieldsArray as $key => $field)
2012-03-15 09:25:18 -04:00
{
if (stripos($field, 'as') !== FALSE)
{
$fieldsArray[$key] = preg_split('` as `i', (string) $field);
2016-10-13 21:55:23 -04:00
$fieldsArray[$key] = array_map('mb_trim', $fieldsArray[$key]);
2012-03-15 09:25:18 -04:00
}
}
// Quote the identifiers
2018-01-22 15:43:56 -05:00
$safeArray = $this->driver->quoteIdent($fieldsArray);
2016-10-13 21:55:23 -04:00
unset($fieldsArray);
2012-03-15 09:25:18 -04:00
// Join the strings back together
foreach ($safeArray as $i => $iValue)
2012-03-15 09:25:18 -04:00
{
if (is_array($iValue))
2012-03-15 09:25:18 -04:00
{
$safeArray[$i] = implode(' AS ', $iValue);
2012-03-15 09:25:18 -04:00
}
}
$this->state->appendSelectString(implode(', ', $safeArray));
2012-03-15 09:25:18 -04:00
return $this;
}
2012-08-09 12:15:36 -04:00
2012-04-30 15:29:45 -04:00
/**
* Selects the maximum value of a field from a query
*
2016-10-12 20:32:23 -04:00
* @param string|bool $as
2012-04-30 15:29:45 -04:00
*/
public function selectMax(string $field, $as=FALSE): self
2012-04-30 15:29:45 -04:00
{
// Create the select string
$this->state->appendSelectString(' MAX'.$this->_select($field, $as));
return $this;
}
2012-08-09 12:15:36 -04:00
/**
* Selects the minimum value of a field from a query
*
* @param string|bool $as
*/
public function selectMin(string $field, $as=FALSE): self
2012-08-09 12:15:36 -04:00
{
// Create the select string
$this->state->appendSelectString(' MIN'.$this->_select($field, $as));
return $this;
}
2012-08-09 12:15:36 -04:00
/**
* Selects the average value of a field from a query
*
* @param string|bool $as
*/
public function selectAvg(string $field, $as=FALSE): self
{
// Create the select string
$this->state->appendSelectString(' AVG'.$this->_select($field, $as));
return $this;
}
2012-08-09 12:15:36 -04:00
/**
* Selects the sum of a field from a query
*
* @param string|bool $as
*/
public function selectSum(string $field, $as=FALSE): self
{
// Create the select string
$this->state->appendSelectString(' SUM'.$this->_select($field, $as));
return $this;
}
2019-12-11 16:49:06 -05:00
/**
* Add a 'returning' clause to an insert,update, or delete query
*
2019-12-11 16:49:06 -05:00
* @return $this
*/
public function returning(string $fields = ''): self
2019-12-11 16:49:06 -05:00
{
$this->returning = TRUE;
// Re-use the string select field for generating the returning type clause
if ($fields !== '')
{
return $this->select($fields);
}
2019-12-11 16:49:06 -05:00
return $this;
}
/**
* Adds the 'distinct' keyword to a query
*/
public function distinct(): self
{
// Prepend the keyword to the select string
$this->state->setSelectString(' DISTINCT' . $this->state->getSelectString());
return $this;
}
2014-02-21 15:08:00 -05:00
2014-02-04 20:59:30 -05:00
/**
* Tell the database to give you the query plan instead of result set
*/
public function explain(): self
2014-02-04 20:59:30 -05:00
{
$this->explain = TRUE;
return $this;
}
2012-08-09 12:15:36 -04:00
2012-03-15 09:25:18 -04:00
/**
* Specify the database table to select from
*
2020-04-23 18:16:32 -04:00
* Alias of `from` method to better match CodeIgniter 4
*
* @param string $tableName
*/
public function table(string $tableName): self
{
return $this->from($tableName);
}
/**
* Specify the database table to select from
2012-03-15 09:25:18 -04:00
*/
2020-04-23 18:16:32 -04:00
public function from(string $tableName): self
2012-03-15 09:25:18 -04:00
{
// Split identifiers on spaces
2020-04-23 18:16:32 -04:00
$identArray = explode(' ', mb_trim($tableName));
$identArray = array_map('mb_trim', $identArray);
// Quote the identifiers
2018-01-22 15:43:56 -05:00
$identArray[0] = $this->driver->quoteTable($identArray[0]);
$identArray = $this->driver->quoteIdent($identArray);
2012-03-15 09:25:18 -04:00
// Paste it back together
$this->state->setFromString(implode(' ', $identArray));
2012-03-15 09:25:18 -04:00
return $this;
}
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! 'Like' methods
// --------------------------------------------------------------------------
/**
* Creates a Like clause in the sql statement
*/
2023-01-20 10:33:43 -05:00
public function like(string $field, mixed $values, LikeType|string $pos=LikeType::BOTH): self
2012-04-30 16:06:06 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_like($field, $values, LikeType::parse($pos));
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* Generates an OR Like clause
*/
2023-01-20 10:33:43 -05:00
public function orLike(string $field, mixed $values, LikeType|string $pos=LikeType::BOTH): self
2012-03-15 09:25:18 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_like($field, $values, LikeType::parse($pos), 'LIKE', 'OR');
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* Generates a NOT LIKE clause
*/
2023-01-20 10:33:43 -05:00
public function notLike(string $field, mixed $values, LikeType|string $pos=LikeType::BOTH): self
2012-03-15 09:25:18 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_like($field, $values, LikeType::parse($pos), 'NOT LIKE');
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* Generates a OR NOT LIKE clause
*/
2023-01-20 10:33:43 -05:00
public function orNotLike(string $field, mixed $values, LikeType|string $pos=LikeType::BOTH): self
2012-03-15 09:25:18 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_like($field, $values, LikeType::parse($pos), 'NOT LIKE', 'OR');
2012-03-15 09:25:18 -04:00
}
2012-08-09 12:15:36 -04:00
2012-05-01 13:45:11 -04:00
// --------------------------------------------------------------------------
// ! Having methods
2012-04-16 13:43:41 -04:00
// --------------------------------------------------------------------------
/**
* Generates a 'Having' clause
*/
2023-01-20 10:33:43 -05:00
public function having(mixed $key, mixed $values=[]): self
2012-05-01 13:45:11 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_having($key, $values);
2012-05-01 13:45:11 -04:00
}
2012-08-09 12:15:36 -04:00
2012-04-16 13:43:41 -04:00
/**
* Generates a 'Having' clause prefixed with 'OR'
*/
2023-01-20 10:33:43 -05:00
public function orHaving(mixed $key, mixed $values=[]): self
2012-04-16 13:43:41 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_having($key, $values, 'OR');
2012-04-16 13:43:41 -04:00
}
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! 'Where' methods
// --------------------------------------------------------------------------
/**
* Specify condition(s) in the where clause of a query
* Note: this function works with key / value, or a
2012-03-15 09:25:18 -04:00
* passed array with key / value pairs
*/
2023-01-20 10:33:43 -05:00
public function where(mixed $key, mixed $values=[]): self
2012-03-15 09:25:18 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_whereString($key, $values);
2012-03-15 09:25:18 -04:00
}
/**
* Where clause prefixed with "OR"
*/
2023-01-20 10:33:43 -05:00
public function orWhere(mixed $key, mixed $values=[]): self
2012-03-15 09:25:18 -04:00
{
2023-01-20 10:33:43 -05:00
return $this->_whereString($key, $values, 'OR');
2012-03-15 09:25:18 -04:00
}
/**
* Where clause with 'IN' statement
*/
2023-01-13 13:14:28 -05:00
public function whereIn(string $field, mixed $val=[]): self
2012-03-15 09:25:18 -04:00
{
2016-10-13 21:55:23 -04:00
return $this->_whereIn($field, $val);
2012-03-15 09:25:18 -04:00
}
/**
* Where in statement prefixed with "or"
*/
2023-01-13 13:14:28 -05:00
public function orWhereIn(string $field, mixed $val=[]): self
2012-03-15 09:25:18 -04:00
{
2016-10-13 21:55:23 -04:00
return $this->_whereIn($field, $val, 'IN', 'OR');
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* WHERE NOT IN (FOO) clause
*/
2023-01-13 13:14:28 -05:00
public function whereNotIn(string $field, mixed $val=[]): self
2012-03-15 09:25:18 -04:00
{
return $this->_whereIn($field, $val, 'NOT IN');
2012-03-15 09:25:18 -04:00
}
/**
* OR WHERE NOT IN (FOO) clause
*/
2023-01-13 13:14:28 -05:00
public function orWhereNotIn(string $field, mixed $val=[]): self
2012-03-15 09:25:18 -04:00
{
2016-10-13 21:55:23 -04:00
return $this->_whereIn($field, $val, 'NOT IN', 'OR');
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! Other Query Modifier methods
// --------------------------------------------------------------------------
2012-04-16 13:43:41 -04:00
/**
* Sets values for inserts / updates / deletes
*/
2023-01-13 13:14:28 -05:00
public function set(mixed $key, mixed $val = NULL): self
2012-04-16 13:43:41 -04:00
{
$pairs = is_scalar($key) ? [$key => $val] : $key;
$keys = array_keys($pairs);
$values = array_values($pairs);
$this->state->appendSetArrayKeys($keys);
$this->state->appendValues($values);
2012-04-16 13:43:41 -04:00
// Use the keys of the array to make the insert/update string
// Escape the field names
$this->state->setSetArrayKeys(
array_map([$this->driver, '_quote'], $this->state->getSetArrayKeys())
);
2012-04-16 13:43:41 -04:00
// Generate the "set" string
$setString = implode('=?,', $this->state->getSetArrayKeys());
$setString .= '=?';
$this->state->setSetString($setString);
2012-04-16 13:43:41 -04:00
return $this;
}
2012-08-09 12:15:36 -04:00
2012-03-15 09:25:18 -04:00
/**
* Creates a join phrase in a compiled query
*/
2023-01-20 10:33:43 -05:00
public function join(string $table, string $condition, JoinType|string $type=JoinType::INNER): self
{
2012-11-07 08:42:34 -05:00
// Prefix and quote table name
$tableArr = explode(' ', mb_trim($table));
$tableArr[0] = $this->driver->quoteTable($tableArr[0]);
$tableArr = $this->driver->quoteIdent($tableArr);
$table = implode(' ', $tableArr);
2012-08-09 12:15:36 -04:00
// Parse out the join condition
2016-10-13 21:55:23 -04:00
$parsedCondition = $this->parser->compileJoin($condition);
$condition = $table . ' ON ' . $parsedCondition;
2023-01-20 10:33:43 -05:00
$this->state->appendMap("\n" . strtoupper(JoinType::parse($type)->value) . ' JOIN ', $condition, MapType::JOIN);
2012-03-15 09:25:18 -04:00
return $this;
}
2012-03-15 09:25:18 -04:00
/**
* Group the results by the selected field(s)
*/
2023-01-13 13:14:28 -05:00
public function groupBy(mixed $field): self
2012-03-15 09:25:18 -04:00
{
if ( ! is_scalar($field))
{
$newGroupArray = array_merge(
$this->state->getGroupArray(),
array_map([$this->driver, 'quoteIdent'], $field)
);
$this->state->setGroupArray($newGroupArray);
2012-03-15 09:25:18 -04:00
}
else
{
$this->state->appendGroupArray($this->driver->quoteIdent($field));
2012-03-15 09:25:18 -04:00
}
$this->state->setGroupString(' GROUP BY ' . implode(',', $this->state->getGroupArray()));
2012-03-15 09:25:18 -04:00
return $this;
}
2012-03-15 09:25:18 -04:00
/**
* Order the results by the selected field(s)
*/
public function orderBy(string $field, string $type=''): self
2012-03-15 09:25:18 -04:00
{
// When ordering by random, do an ascending order if the driver
// doesn't support random ordering
2012-03-15 09:25:18 -04:00
if (stripos($type, 'rand') !== FALSE)
{
$rand = $this->driver->getSql()->random();
2016-10-12 22:12:25 -04:00
$type = $rand ?? 'ASC';
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
// Set fields for later manipulation
2018-01-22 15:43:56 -05:00
$field = $this->driver->quoteIdent($field);
$this->state->setOrderArray($field, $type);
2016-10-13 21:55:23 -04:00
$orderClauses = [];
2012-03-15 09:25:18 -04:00
// Flatten key/val pairs into an array of space-separated pairs
foreach($this->state->getOrderArray() as $k => $v)
2012-03-15 09:25:18 -04:00
{
2016-10-13 21:55:23 -04:00
$orderClauses[] = $k . ' ' . strtoupper($v);
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
// Set the final string
$orderString = isset($rand)
? "\nORDER BY".$rand
: "\nORDER BY ".implode(', ', $orderClauses);
$this->state->setOrderString($orderString);
2012-03-15 09:25:18 -04:00
return $this;
}
2012-03-15 09:25:18 -04:00
/**
* Set a limit on the current sql statement
*/
public function limit(int $limit, ?int $offset=NULL): self
2012-03-15 09:25:18 -04:00
{
$this->state->setLimit($limit);
$this->state->setOffset($offset);
2012-03-15 09:25:18 -04:00
return $this;
}
// --------------------------------------------------------------------------
// ! Query Grouping Methods
// --------------------------------------------------------------------------
/**
* Adds a paren to the current query for query grouping
*/
public function groupStart(): self
{
$conj = empty($this->state->getQueryMap()) ? ' WHERE ' : ' ';
$this->state->appendMap($conj, '(', MapType::GROUP_START);
return $this;
}
2016-09-07 17:39:19 -04:00
/**
* Adds a paren to the current query for query grouping,
* prefixed with 'NOT'
*/
public function notGroupStart(): self
2016-09-07 17:39:19 -04:00
{
$conj = empty($this->state->getQueryMap()) ? ' WHERE ' : ' AND ';
2016-10-12 20:32:23 -04:00
$this->state->appendMap($conj, ' NOT (', MapType::GROUP_START);
2016-09-07 17:39:19 -04:00
return $this;
}
/**
* Adds a paren to the current query for query grouping,
* prefixed with 'OR'
*/
public function orGroupStart(): self
{
$this->state->appendMap('', ' OR (', MapType::GROUP_START);
return $this;
}
/**
* Adds a paren to the current query for query grouping,
* prefixed with 'OR NOT'
*/
public function orNotGroupStart(): self
{
$this->state->appendMap('', ' OR NOT (', MapType::GROUP_START);
return $this;
}
/**
* Ends a query group
*/
public function groupEnd(): self
{
$this->state->appendMap('', ')', MapType::GROUP_END);
return $this;
}
2012-08-09 12:15:36 -04:00
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! Query execution methods
// --------------------------------------------------------------------------
/**
* Select and retrieve all records from the current table, and/or
* execute current compiled query
*/
public function get(string $table='', ?int $limit=NULL, ?int $offset=NULL): PDOStatement
2012-03-15 09:25:18 -04:00
{
// Set the table
2015-11-11 09:25:21 -05:00
if ( ! empty($table))
{
$this->from($table);
}
2012-03-15 09:25:18 -04:00
// Set the limit, if it exists
if (is_int($limit))
2015-11-11 09:25:21 -05:00
{
$this->limit($limit, $offset);
}
2023-01-20 10:33:43 -05:00
return $this->_run(QueryType::SELECT, $table);
2012-03-15 09:25:18 -04:00
}
/**
* Convenience method for get() with a where clause
*
* @param mixed $where
*/
public function getWhere(string $table, $where=[], ?int $limit=NULL, ?int $offset=NULL): PDOStatement
{
// Create the where clause
$this->where($where);
2012-08-09 12:15:36 -04:00
// Return the result
return $this->get($table, $limit, $offset);
}
2012-08-09 12:15:36 -04:00
2012-04-16 13:43:41 -04:00
/**
2016-10-12 20:32:23 -04:00
* Retrieve the number of rows in the selected table
2012-04-16 13:43:41 -04:00
*/
public function countAll(string $table): int
2012-04-16 13:43:41 -04:00
{
2018-01-22 15:43:56 -05:00
$sql = 'SELECT * FROM '.$this->driver->quoteTable($table);
$res = $this->driver->query($sql);
return (int) (is_countable($res->fetchAll()) ? count($res->fetchAll()) : 0);
2012-04-16 13:43:41 -04:00
}
2012-08-09 12:15:36 -04:00
2012-04-16 13:43:41 -04:00
/**
* Retrieve the number of results for the generated query - used
* in place of the get() method
*/
2016-10-13 21:55:23 -04:00
public function countAllResults(string $table='', bool $reset = TRUE): int
2012-04-16 13:43:41 -04:00
{
// Set the table
2015-11-11 09:25:21 -05:00
if ( ! empty($table))
{
$this->from($table);
}
2012-08-09 12:15:36 -04:00
$result = $this->_run(QueryType::SELECT, $table, NULL, NULL, $reset);
$rows = $result->fetchAll();
2012-08-09 12:15:36 -04:00
2012-04-17 11:43:06 -04:00
return (int) count($rows);
2012-04-16 13:43:41 -04:00
}
2012-08-09 12:15:36 -04:00
2012-03-15 09:25:18 -04:00
/**
* Creates an insert clause, and executes it
*/
2023-01-13 13:14:28 -05:00
public function insert(string $table, mixed $data=[]): PDOStatement
2012-03-15 09:25:18 -04:00
{
2015-11-11 09:25:21 -05:00
if ( ! empty($data))
{
$this->set($data);
}
return $this->_run(QueryType::INSERT, $table);
2012-03-15 09:25:18 -04:00
}
2014-02-21 15:08:00 -05:00
/**
2014-03-31 16:01:58 -04:00
* Creates and executes a batch insertion query
*/
public function insertBatch(string $table, $data=[]): ?PDOStatement
{
// Get the generated values and sql string
[$sql, $data] = $this->driver->insertBatch($table, $data);
2014-02-21 15:08:00 -05:00
return $sql !== NULL
2023-01-13 13:14:28 -05:00
? $this->_run(QueryType::INSERT_BATCH, $table, $sql, $data)
: NULL;
}
2012-03-15 09:25:18 -04:00
/**
* Creates an update clause, and executes it
*/
2023-01-13 13:14:28 -05:00
public function update(string $table, mixed $data=[]): PDOStatement
2012-03-15 09:25:18 -04:00
{
2015-11-11 09:25:21 -05:00
if ( ! empty($data))
{
$this->set($data);
}
return $this->_run(QueryType::UPDATE, $table);
2012-03-15 09:25:18 -04:00
}
2016-09-07 17:39:19 -04:00
/**
* Creates a batch update, and executes it.
* Returns the number of affected rows
*/
2018-01-26 08:39:30 -05:00
public function updateBatch(string $table, array $data, string $where): ?int
2016-09-07 17:39:19 -04:00
{
2018-01-26 08:39:30 -05:00
if (empty($table) || empty($data) || empty($where))
{
return NULL;
}
2016-09-07 17:39:19 -04:00
// Get the generated values and sql string
2018-01-26 08:39:30 -05:00
[$sql, $data, $affectedRows] = $this->driver->updateBatch($table, $data, $where);
2016-09-07 17:39:19 -04:00
2023-01-13 13:14:28 -05:00
$this->_run(QueryType::UPDATE_BATCH, $table, $sql, $data);
2018-01-26 08:39:30 -05:00
return $affectedRows;
2016-09-07 17:39:19 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* Deletes data from a table
*/
2023-01-13 13:14:28 -05:00
public function delete(string $table, mixed $where=''): PDOStatement
2012-03-15 09:25:18 -04:00
{
// Set the where clause
2015-11-11 09:25:21 -05:00
if ( ! empty($where))
{
$this->where($where);
}
2012-03-15 09:25:18 -04:00
return $this->_run(QueryType::DELETE, $table);
2012-03-15 09:25:18 -04:00
}
// --------------------------------------------------------------------------
2012-12-18 16:19:52 -05:00
// ! SQL Returning Methods
// --------------------------------------------------------------------------
/**
* Returns the generated 'select' sql query
*/
2016-10-13 21:55:23 -04:00
public function getCompiledSelect(string $table='', bool $reset=TRUE): string
{
// Set the table
2015-11-11 09:25:21 -05:00
if ( ! empty($table))
{
$this->from($table);
}
return $this->_getCompile(QueryType::SELECT, $table, $reset);
}
/**
* Returns the generated 'insert' sql query
*/
2016-10-13 21:55:23 -04:00
public function getCompiledInsert(string $table, bool $reset=TRUE): string
{
return $this->_getCompile(QueryType::INSERT, $table, $reset);
}
/**
2012-12-18 16:19:52 -05:00
* Returns the generated 'update' sql query
*/
2016-10-13 21:55:23 -04:00
public function getCompiledUpdate(string $table='', bool $reset=TRUE): string
{
return $this->_getCompile(QueryType::UPDATE, $table, $reset);
}
/**
2012-12-18 16:19:52 -05:00
* Returns the generated 'delete' sql query
*/
2016-10-13 21:55:23 -04:00
public function getCompiledDelete(string $table='', bool $reset=TRUE): string
{
return $this->_getCompile(QueryType::DELETE, $table, $reset);
}
2012-03-15 09:25:18 -04:00
}