Query/src/QueryBuilder.php

1338 lines
30 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
*
2019-12-11 16:49:42 -05:00
* PHP version 7.2
2016-09-07 13:17:17 -04:00
*
* @package Query
* @author Timothy J. Warren <tim@timshomepage.net>
2019-12-11 16:49:42 -05:00
* @copyright 2012 - 2019 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
* @version 3.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
2019-12-10 12:17:40 -05:00
use function regexInArray;
2016-10-12 20:32:23 -04:00
use BadMethodCallException;
2019-12-11 16:49:06 -05:00
use PDO;
2016-10-12 22:12:25 -04:00
use PDOStatement;
use Query\Drivers\DriverInterface;
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
2019-12-11 16:49:06 -05:00
*
* @method affectedRows(): int
* @method beginTransaction(): bool
* @method commit(): bool
* @method errorCode(): string
* @method errorInfo(): array
* @method exec(string $statement): int
* @method getAttribute(int $attribute)
* @method getColumns(string $table): array | null
* @method getDbs(): array | null
* @method getFks(string $table): array | null
* @method getFunctions(): array | null
* @method getIndexes(string $table): array | null
* @method getLastQuery(): string
* @method getProcedures(): array | null
* @method getSchemas(): array | null
* @method getSequences(): array | null
* @method getSystemTables(): array | null
* @method getTables(): array
* @method getTriggers(): array | null
* @method getTypes(): array | null
* @method getUtil(): \Query\Drivers\AbstractUtil
* @method getViews(): array | null
* @method inTransaction(): bool
* @method lastInsertId(string $name = NULL): string
* @method numRows(): int | null
* @method prepare(string $statement, array $driver_options = []): PDOStatement
* @method prepareExecute(string $sql, array $params): PDOStatement
* @method prepareQuery(string $sql, array $data): PDOStatement
* @method query(string $statement): PDOStatement
* @method quote(string $string, int $parameter_type = PDO::PARAM_STR): string
* @method rollback(): bool
* @method setAttribute(int $attribute, $value): bool
* @method setTablePrefix(string $prefix): void
* @method truncate(string $table): PDOStatement
2012-03-15 09:25:18 -04:00
*/
2018-01-22 15:43:56 -05:00
class QueryBuilder implements QueryBuilderInterface {
/**
* Convenience property for connection management
* @var string
*/
public $connName = '';
/**
* List of queries executed
* @var array
*/
public $queries = [
'total_time' => 0
];
2018-01-22 15:43:56 -05:00
/**
* Whether to do only an explain on the query
* @var boolean
*/
protected $explain = FALSE;
2018-01-22 15:43:56 -05:00
/**
* The current database driver
* @var DriverInterface
*/
2019-12-11 16:49:06 -05:00
protected $driver;
2018-01-22 15:43:56 -05:00
/**
* Query parser class instance
* @var QueryParser
*/
protected $parser;
2014-04-24 21:29:40 -04:00
/**
* Query Builder state
* @var State
2014-04-24 21:29:40 -04:00
*/
protected $state;
2014-04-24 21:29:40 -04:00
// --------------------------------------------------------------------------
// ! Methods
// --------------------------------------------------------------------------
2012-03-15 09:25:18 -04:00
/**
* Constructor
*
2018-01-22 15:43:56 -05:00
* @param DriverInterface $driver
2015-11-10 11:18:11 -05:00
* @param QueryParser $parser
2012-03-15 09:25:18 -04:00
*/
2018-01-22 15:43:56 -05:00
public function __construct(DriverInterface $driver, QueryParser $parser)
2012-03-15 09:25:18 -04:00
{
// Inject driver and parser
2018-01-22 15:43:56 -05:00
$this->driver = $driver;
$this->parser = $parser;
2012-10-31 16:21:15 -04:00
// Create new State object
$this->state = new State();
2012-10-31 16:21:15 -04:00
}
2014-02-21 15:08:00 -05:00
2014-02-17 20:10:47 -05:00
/**
* Destructor
* @codeCoverageIgnore
2014-02-17 20:10:47 -05:00
*/
public function __destruct()
{
2018-01-22 15:43:56 -05:00
$this->driver = NULL;
2014-02-17 20:10:47 -05:00
}
/**
2019-12-11 16:49:06 -05:00
* Calls a function further down the inheritance chain.
* 'Implements' methods on the driver object
*
* @param string $name
* @param array $params
* @return mixed
2016-10-12 20:32:23 -04:00
* @throws BadMethodCallException
*/
2016-10-12 22:12:25 -04:00
public function __call(string $name, array $params)
{
2018-01-24 13:25:42 -05:00
if (method_exists($this->driver, $name))
{
2018-01-24 13:25:42 -05:00
return \call_user_func_array([$this->driver, $name], $params);
}
2016-10-12 22:12:25 -04:00
throw new BadMethodCallException('Method does not exist');
}
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! Select Queries
// --------------------------------------------------------------------------
2012-03-15 09:25:18 -04:00
/**
* Specifies rows to select in a query
*
* @param string $fields
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-12 22:12:25 -04:00
public function select(string $fields): QueryBuilderInterface
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)
{
2016-10-13 21:55:23 -04:00
$fieldsArray[$key] = preg_split('` as `i', $field);
$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
2016-10-13 21:55:23 -04:00
for($i = 0, $c = count($safeArray); $i < $c; $i++)
2012-03-15 09:25:18 -04:00
{
2018-01-22 15:43:56 -05:00
if (\is_array($safeArray[$i]))
2012-03-15 09:25:18 -04:00
{
2016-10-13 21:55:23 -04:00
$safeArray[$i] = implode(' AS ', $safeArray[$i]);
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
*
* @param string $field
2016-10-12 20:32:23 -04:00
* @param string|bool $as
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-04-30 15:29:45 -04:00
*/
2016-10-13 21:55:23 -04:00
public function selectMax(string $field, $as=FALSE): QueryBuilderInterface
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 $field
* @param string|bool $as
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function selectMin(string $field, $as=FALSE): QueryBuilderInterface
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 $field
* @param string|bool $as
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function selectAvg(string $field, $as=FALSE): QueryBuilderInterface
{
// 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 $field
* @param string|bool $as
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function selectSum(string $field, $as=FALSE): QueryBuilderInterface
{
// Create the select string
$this->state->appendSelectString(' SUM'.$this->_select($field, $as));
return $this;
}
2019-12-11 16:49:06 -05:00
/**
* @todo implement
* @param string $fields
* @return $this
*/
public function returning(string $fields = '*'): QueryBuilderInterface
{
return $this;
}
/**
* Adds the 'distinct' keyword to a query
*
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-12 22:12:25 -04:00
public function distinct(): QueryBuilderInterface
{
// 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
*
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2014-02-04 20:59:30 -05:00
*/
2016-10-12 22:12:25 -04:00
public function explain(): QueryBuilderInterface
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
*
2012-11-07 08:42:34 -05:00
* @param string $tblname
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
public function from(string $tblname): QueryBuilderInterface
2012-03-15 09:25:18 -04:00
{
// Split identifiers on spaces
2016-10-13 21:55:23 -04:00
$identArray = explode(' ', \mb_trim($tblname));
$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
// --------------------------------------------------------------------------
2012-08-09 12:15:36 -04:00
/**
* Creates a Like clause in the sql statement
*
* @param string $field
* @param mixed $val
* @param string $pos
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
public function like(string $field, $val, string $pos='both'): QueryBuilderInterface
2012-04-30 16:06:06 -04:00
{
return $this->_like($field, $val, $pos);
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* Generates an OR Like clause
*
* @param string $field
* @param mixed $val
* @param string $pos
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
public function orLike(string $field, $val, string $pos='both'): QueryBuilderInterface
2012-03-15 09:25:18 -04:00
{
2012-05-01 13:45:11 -04:00
return $this->_like($field, $val, $pos, 'LIKE', 'OR');
2012-03-15 09:25:18 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* Generates a NOT LIKE clause
*
* @param string $field
* @param mixed $val
* @param string $pos
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
public function notLike(string $field, $val, string $pos='both'): QueryBuilderInterface
2012-03-15 09:25:18 -04:00
{
return $this->_like($field, $val, $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
*
* @param string $field
* @param mixed $val
* @param string $pos
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
public function orNotLike(string $field, $val, string $pos='both'): QueryBuilderInterface
2012-03-15 09:25:18 -04:00
{
2012-05-01 13:45:11 -04:00
return $this->_like($field, $val, $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
// --------------------------------------------------------------------------
2012-08-09 12:15:36 -04:00
/**
* Generates a 'Having' clause
*
* @param mixed $key
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-12 22:12:25 -04:00
public function having($key, $val=[]): QueryBuilderInterface
2012-05-01 13:45:11 -04:00
{
return $this->_having($key, $val);
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'
*
* @param mixed $key
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-04-16 13:43:41 -04:00
*/
2016-10-13 21:55:23 -04:00
public function orHaving($key, $val=[]): QueryBuilderInterface
2012-04-16 13:43:41 -04:00
{
2012-05-01 13:45:11 -04:00
return $this->_having($key, $val, 'OR');
2012-04-16 13:43:41 -04:00
}
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! 'Where' methods
// --------------------------------------------------------------------------
2012-03-15 09:25:18 -04:00
/**
* 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
*
* @param mixed $key
2012-03-15 09:25:18 -04:00
* @param mixed $val
2014-02-04 20:59:30 -05:00
* @param mixed $escape
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-12 22:12:25 -04:00
public function where($key, $val=[], $escape=NULL): QueryBuilderInterface
2012-03-15 09:25:18 -04:00
{
return $this->_whereString($key, $val);
2012-03-15 09:25:18 -04:00
}
/**
* Where clause prefixed with "OR"
*
2012-05-01 13:45:11 -04:00
* @param string $key
2012-03-15 09:25:18 -04:00
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-13 21:55:23 -04:00
public function orWhere($key, $val=[]): QueryBuilderInterface
2012-03-15 09:25:18 -04:00
{
2016-10-13 21:55:23 -04:00
return $this->_whereString($key, $val, 'OR');
2012-03-15 09:25:18 -04:00
}
/**
* Where clause with 'IN' statement
*
* @param mixed $field
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-13 21:55:23 -04:00
public function whereIn($field, $val=[]): QueryBuilderInterface
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"
*
* @param string $field
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-13 21:55:23 -04:00
public function orWhereIn($field, $val=[]): QueryBuilderInterface
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
*
* @param string $field
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-13 21:55:23 -04:00
public function whereNotIn($field, $val=[]): QueryBuilderInterface
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
*
2012-03-15 09:25:18 -04:00
* @param string $field
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-13 21:55:23 -04:00
public function orWhereNotIn($field, $val=[]): QueryBuilderInterface
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-08-09 12:15:36 -04:00
2012-04-16 13:43:41 -04:00
/**
* Sets values for inserts / updates / deletes
*
* @param mixed $key
* @param mixed $val
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-04-16 13:43:41 -04:00
*/
2016-10-12 22:12:25 -04:00
public function set($key, $val = NULL): QueryBuilderInterface
2012-04-16 13:43:41 -04:00
{
if (is_scalar($key))
{
$pairs = [$key => $val];
}
else
{
$pairs = $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
*
* @param string $table
* @param string $condition
* @param string $type
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
public function join(string $table, string $condition, string $type=''): QueryBuilderInterface
{
2012-11-07 08:42:34 -05:00
// Prefix and quote table name
$table = explode(' ', mb_trim($table));
2018-01-22 15:43:56 -05:00
$table[0] = $this->driver->quoteTable($table[0]);
$table = $this->driver->quoteIdent($table);
2012-11-07 08:42:34 -05:00
$table = implode(' ', $table);
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;
$this->state->appendMap("\n" . strtoupper($type) . ' JOIN ', $condition, '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)
*
* @param mixed $field
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
2016-10-13 21:55:23 -04:00
public function groupBy($field): QueryBuilderInterface
2012-03-15 09:25:18 -04:00
{
if ( ! is_scalar($field))
{
2018-01-22 15:43:56 -05:00
$newGroupArray = array_map([$this->driver, 'quoteIdent'], $field);
$this->state->setGroupArray(
array_merge($this->state->getGroupArray(), $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)
*
* @param string $field
* @param string $type
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
public function orderBy(string $field, string $type=''): QueryBuilderInterface
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)
2016-10-13 21:55:23 -04:00
? "\nORDER BY ".implode(', ', $orderClauses)
2014-02-14 10:38:25 -05:00
: "\nORDER BY".$rand;
$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
*
* @param int $limit
2014-04-22 14:02:54 -04:00
* @param int|bool $offset
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
2012-03-15 09:25:18 -04:00
*/
public function limit(int $limit, $offset=FALSE): QueryBuilderInterface
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
*
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function groupStart(): QueryBuilderInterface
{
$conj = empty($this->state->getQueryMap()) ? ' WHERE ' : ' ';
$this->state->appendMap($conj, '(', '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'
*
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function notGroupStart(): QueryBuilderInterface
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 (', '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'
*
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function orGroupStart(): QueryBuilderInterface
{
$this->state->appendMap('', ' OR (', 'group_start');
return $this;
}
/**
* Adds a paren to the current query for query grouping,
* prefixed with 'OR NOT'
*
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function orNotGroupStart(): QueryBuilderInterface
{
$this->state->appendMap('', ' OR NOT (', 'group_start');
return $this;
}
/**
* Ends a query group
*
2016-09-07 17:39:19 -04:00
* @return QueryBuilderInterface
*/
2016-10-13 21:55:23 -04:00
public function groupEnd(): QueryBuilderInterface
{
$this->state->appendMap('', ')', 'group_end');
return $this;
}
2012-08-09 12:15:36 -04:00
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! Query execution methods
// --------------------------------------------------------------------------
2012-03-15 09:25:18 -04:00
/**
* Select and retrieve all records from the current table, and/or
* execute current compiled query
*
2016-09-07 14:22:52 -04:00
* @param string $table
2014-04-22 14:02:54 -04:00
* @param int|bool $limit
* @param int|bool $offset
2016-10-12 22:12:25 -04:00
* @return PDOStatement
2012-03-15 09:25:18 -04:00
*/
public function get(string $table='', $limit=FALSE, $offset=FALSE): 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);
}
return $this->_run('get', $table);
2012-03-15 09:25:18 -04:00
}
/**
* Convenience method for get() with a where clause
*
* @param string $table
* @param mixed $where
* @param int|bool $limit
* @param int|bool $offset
2016-10-12 22:12:25 -04:00
* @return PDOStatement
*/
public function getWhere(string $table, $where=[], $limit=FALSE, $offset=FALSE): 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
*
* @param string $table
* @return int
*/
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) count($res->fetchAll());
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
*
* @param string $table
2016-09-07 17:39:19 -04:00
* @param boolean $reset
2012-04-16 13:43:41 -04:00
* @return int
*/
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
2016-09-07 17:39:19 -04:00
$result = $this->_run('get', $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
*
* @param string $table
* @param mixed $data
2016-10-12 22:12:25 -04:00
* @return PDOStatement
2012-03-15 09:25:18 -04:00
*/
public function insert(string $table, $data=[]): PDOStatement
2012-03-15 09:25:18 -04:00
{
2015-11-11 09:25:21 -05:00
if ( ! empty($data))
{
$this->set($data);
}
2018-01-22 15:43:56 -05:00
return $this->_run('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
*
* @param string $table
* @param array $data
2016-10-12 22:12:25 -04:00
* @return PDOStatement
*/
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
? $this->_run('', $table, $sql, $data)
: NULL;
}
2012-03-15 09:25:18 -04:00
/**
* Creates an update clause, and executes it
*
* @param string $table
* @param mixed $data
2016-10-12 22:12:25 -04:00
* @return PDOStatement
2012-03-15 09:25:18 -04:00
*/
public function update(string $table, $data=[]): PDOStatement
2012-03-15 09:25:18 -04:00
{
2015-11-11 09:25:21 -05:00
if ( ! empty($data))
{
$this->set($data);
}
2018-01-22 15:43:56 -05:00
return $this->_run('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
*
* @param string $table
2018-01-26 08:39:30 -05:00
* @param array $data
2016-09-07 17:39:19 -04:00
* @param string $where
2018-01-26 08:39:30 -05:00
* @return int|null
2016-09-07 17:39:19 -04:00
*/
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
2018-01-26 08:39:30 -05:00
$this->_run('', $table, $sql, $data);
return $affectedRows;
2016-09-07 17:39:19 -04:00
}
2012-03-15 09:25:18 -04:00
/**
* Deletes data from a table
*
* @param string $table
* @param mixed $where
2016-10-12 22:12:25 -04:00
* @return PDOStatement
2012-03-15 09:25:18 -04:00
*/
public function delete(string $table, $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
2018-01-22 15:43:56 -05:00
return $this->_run('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
*
* @param string $table
* @param bool $reset
* @return string
*/
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);
}
2016-10-13 21:55:23 -04:00
return $this->_getCompile('select', $table, $reset);
}
/**
* Returns the generated 'insert' sql query
*
* @param string $table
* @param bool $reset
* @return string
*/
2016-10-13 21:55:23 -04:00
public function getCompiledInsert(string $table, bool $reset=TRUE): string
{
2016-10-13 21:55:23 -04:00
return $this->_getCompile('insert', $table, $reset);
}
/**
2012-12-18 16:19:52 -05:00
* Returns the generated 'update' sql query
*
* @param string $table
* @param bool $reset
* @return string
*/
2016-10-13 21:55:23 -04:00
public function getCompiledUpdate(string $table='', bool $reset=TRUE): string
{
2016-10-13 21:55:23 -04:00
return $this->_getCompile('update', $table, $reset);
}
/**
2012-12-18 16:19:52 -05:00
* Returns the generated 'delete' sql query
*
* @param string $table
* @param bool $reset
* @return string
*/
2016-10-13 21:55:23 -04:00
public function getCompiledDelete(string $table='', bool $reset=TRUE): string
{
2016-10-13 21:55:23 -04:00
return $this->_getCompile('delete', $table, $reset);
}
2012-03-15 09:25:18 -04:00
// --------------------------------------------------------------------------
// ! Miscellaneous Methods
// --------------------------------------------------------------------------
/**
* Clear out the class variables, so the next query can be run
*
* @return void
2012-03-15 09:25:18 -04:00
*/
2018-01-22 15:43:56 -05:00
public function resetQuery(): void
2012-03-15 09:25:18 -04:00
{
$this->state = new State();
$this->explain = FALSE;
2012-03-15 09:25:18 -04:00
}
2018-01-22 15:43:56 -05:00
/**
* Method to simplify select_ methods
*
* @param string $field
* @param string|bool $as
* @return string
*/
protected function _select(string $field, $as = FALSE): string
{
// Escape the identifiers
$field = $this->driver->quoteIdent($field);
if ( ! \is_string($as))
{
2018-02-12 16:17:22 -05:00
// @codeCoverageIgnoreStart
2018-01-22 15:43:56 -05:00
return $field;
2018-02-12 16:17:22 -05:00
// @codeCoverageIgnoreEnd
2018-01-22 15:43:56 -05:00
}
$as = $this->driver->quoteIdent($as);
return "({$field}) AS {$as} ";
}
/**
* Helper function for returning sql strings
*
* @param string $type
* @param string $table
* @param bool $reset
* @return string
*/
protected function _getCompile(string $type, string $table, bool $reset): string
{
$sql = $this->_compile($type, $table);
// Reset the query builder for the next query
if ($reset)
{
$this->resetQuery();
}
return $sql;
}
/**
* Simplify 'like' methods
*
* @param string $field
* @param mixed $val
* @param string $pos
* @param string $like
* @param string $conj
2019-12-11 16:49:06 -05:00
* @return QueryBuilderInterface
2018-01-22 15:43:56 -05:00
*/
2019-12-11 16:49:06 -05:00
protected function _like(string $field, $val, string $pos, string $like='LIKE', string $conj='AND'): QueryBuilderInterface
2018-01-22 15:43:56 -05:00
{
$field = $this->driver->quoteIdent($field);
// Add the like string into the order map
$like = $field. " {$like} ?";
if ($pos === 'before')
{
$val = "%{$val}";
}
elseif ($pos === 'after')
{
$val = "{$val}%";
}
else
{
$val = "%{$val}%";
}
$conj = empty($this->state->getQueryMap()) ? ' WHERE ' : " {$conj} ";
$this->state->appendMap($conj, $like, 'like');
2018-01-22 15:43:56 -05:00
// Add to the values array
$this->state->appendWhereValues($val);
2018-01-22 15:43:56 -05:00
return $this;
}
/**
* Simplify building having clauses
*
* @param mixed $key
* @param mixed $values
* @param string $conj
2019-12-11 16:49:06 -05:00
* @return QueryBuilderInterface
2018-01-22 15:43:56 -05:00
*/
2019-12-11 16:49:06 -05:00
protected function _having($key, $values=[], string $conj='AND'): QueryBuilderInterface
2018-01-22 15:43:56 -05:00
{
$where = $this->_where($key, $values);
// Create key/value placeholders
foreach($where as $f => $val)
{
// Split each key by spaces, in case there
// is an operator such as >, <, !=, etc.
$fArray = explode(' ', trim($f));
$item = $this->driver->quoteIdent($fArray[0]);
// Simple key value, or an operator
$item .= (count($fArray) === 1) ? '=?' : " {$fArray[1]} ?";
// Put in the having map
$this->state->appendHavingMap([
'conjunction' => empty($this->state->getHavingMap())
? ' HAVING '
: " {$conj} ",
2018-01-22 15:43:56 -05:00
'string' => $item
]);
2018-01-22 15:43:56 -05:00
}
return $this;
}
/**
* Do all the redundant stuff for where/having type methods
*
* @param mixed $key
* @param mixed $val
* @return array
*/
protected function _where($key, $val=[]): array
{
$where = [];
$pairs = [];
if (is_scalar($key))
{
$pairs[$key] = $val;
}
else
{
$pairs = $key;
}
foreach($pairs as $k => $v)
{
$where[$k] = $v;
$this->state->appendWhereValues($v);
}
2018-01-22 15:43:56 -05:00
return $where;
}
/**
* Simplify generating where string
*
* @param mixed $key
* @param mixed $values
* @param string $defaultConj
2019-12-11 16:49:06 -05:00
* @return QueryBuilderInterface
2018-01-22 15:43:56 -05:00
*/
2019-12-11 16:49:06 -05:00
protected function _whereString($key, $values=[], string $defaultConj='AND'): QueryBuilderInterface
2018-01-22 15:43:56 -05:00
{
// Create key/value placeholders
foreach($this->_where($key, $values) as $f => $val)
{
$queryMap = $this->state->getQueryMap();
2018-01-22 15:43:56 -05:00
// Split each key by spaces, in case there
// is an operator such as >, <, !=, etc.
$fArray = explode(' ', trim($f));
$item = $this->driver->quoteIdent($fArray[0]);
// Simple key value, or an operator
$item .= (count($fArray) === 1) ? '=?' : " {$fArray[1]} ?";
$lastItem = end($queryMap);
2018-01-22 15:43:56 -05:00
// Determine the correct conjunction
$conjunctionList = array_column($queryMap, 'conjunction');
2019-12-10 12:17:40 -05:00
if (empty($queryMap) || ( ! regexInArray($conjunctionList, "/^ ?\n?WHERE/i")))
2018-01-22 15:43:56 -05:00
{
$conj = "\nWHERE ";
}
elseif ($lastItem['type'] === 'group_start')
{
$conj = '';
}
else
{
$conj = " {$defaultConj} ";
}
$this->state->appendMap($conj, $item, 'where');
2018-01-22 15:43:56 -05:00
}
return $this;
}
/**
* Simplify where_in methods
*
* @param mixed $key
* @param mixed $val
* @param string $in - The (not) in fragment
* @param string $conj - The where in conjunction
2019-12-11 16:49:06 -05:00
* @return QueryBuilderInterface
2018-01-22 15:43:56 -05:00
*/
2019-12-11 16:49:06 -05:00
protected function _whereIn($key, $val=[], string $in='IN', string $conj='AND'): QueryBuilderInterface
2018-01-22 15:43:56 -05:00
{
$key = $this->driver->quoteIdent($key);
$params = array_fill(0, count($val), '?');
$this->state->appendWhereValues($val);
2018-01-22 15:43:56 -05:00
$conjunction = empty($this->state->getQueryMap()) ? ' WHERE ' : " {$conj} ";
2018-01-22 15:43:56 -05:00
$str = $key . " {$in} (".implode(',', $params).') ';
$this->state->appendMap($conjunction, $str, 'where_in');
2018-01-22 15:43:56 -05:00
return $this;
}
/**
* Executes the compiled query
*
* @param string $type
* @param string $table
* @param string $sql
* @param array|null $vals
* @param boolean $reset
* @return PDOStatement
*/
protected function _run(string $type, string $table, string $sql=NULL, array $vals=NULL, bool $reset=TRUE): PDOStatement
2018-01-22 15:43:56 -05:00
{
if ($sql === NULL)
{
$sql = $this->_compile($type, $table);
}
if ($vals === NULL)
{
$vals = array_merge($this->state->getValues(), $this->state->getWhereValues());
2018-01-22 15:43:56 -05:00
}
$startTime = microtime(TRUE);
$res = empty($vals)
? $this->driver->query($sql)
: $this->driver->prepareExecute($sql, $vals);
$endTime = microtime(TRUE);
$totalTime = number_format($endTime - $startTime, 5);
// Add this query to the list of executed queries
$this->_appendQuery($vals, $sql, (int) $totalTime);
// Reset class state for next query
if ($reset)
{
$this->resetQuery();
}
return $res;
}
/**
* Convert the prepared statement into readable sql
*
2018-01-26 08:39:30 -05:00
* @param array $values
2018-01-22 15:43:56 -05:00
* @param string $sql
* @param int $totalTime
* @return void
*/
2019-12-10 12:17:40 -05:00
protected function _appendQuery(array $values, string $sql, int $totalTime): void
2018-01-22 15:43:56 -05:00
{
2018-01-26 08:39:30 -05:00
$evals = \is_array($values) ? $values : [];
2019-12-10 12:17:40 -05:00
$esql = str_replace('?', '%s', $sql);
2018-01-22 15:43:56 -05:00
// Quote string values
foreach($evals as &$v)
{
$v = ( ! is_numeric($v))
? htmlentities($this->driver->quote($v), ENT_NOQUOTES, 'utf-8')
: $v;
}
2019-12-11 16:49:06 -05:00
unset($v);
2018-01-22 15:43:56 -05:00
// Add the query onto the array of values to pass
// as arguments to sprintf
array_unshift($evals, $esql);
// Add the interpreted query to the list of executed queries
$this->queries[] = [
'time' => $totalTime,
'sql' => sprintf(...$evals)
];
$this->queries['total_time'] += $totalTime;
// Set the last query to get rowcounts properly
$this->driver->setLastQuery($sql);
}
/**
* Sub-method for generating sql strings
*
2018-02-12 16:17:22 -05:00
* @codeCoverageIgnore
2018-01-22 15:43:56 -05:00
* @param string $type
* @param string $table
* @return string
*/
protected function _compileType(string $type='', string $table=''): string
{
$setArrayKeys = $this->state->getSetArrayKeys();
2018-01-22 15:43:56 -05:00
switch($type)
{
case 'insert':
$paramCount = count($setArrayKeys);
2018-01-22 15:43:56 -05:00
$params = array_fill(0, $paramCount, '?');
$sql = "INSERT INTO {$table} ("
. implode(',', $setArrayKeys)
2018-01-22 15:43:56 -05:00
. ")\nVALUES (".implode(',', $params).')';
break;
case 'update':
$setString = $this->state->getSetString();
$sql = "UPDATE {$table}\nSET {$setString}";
2018-01-22 15:43:56 -05:00
break;
case 'delete':
$sql = "DELETE FROM {$table}";
break;
// Get queries
default:
$fromString = $this->state->getFromString();
$selectString = $this->state->getSelectString();
$sql = "SELECT * \nFROM {$fromString}";
2018-01-22 15:43:56 -05:00
// Set the select string
if ( ! empty($selectString))
2018-01-22 15:43:56 -05:00
{
// Replace the star with the selected fields
$sql = str_replace('*', $selectString, $sql);
2018-01-22 15:43:56 -05:00
}
break;
}
return $sql;
}
/**
* String together the sql statements for sending to the db
*
* @param string $type
* @param string $table
* @return string
*/
protected function _compile(string $type='', string $table=''): string
{
// Get the base clause for the query
$sql = $this->_compileType($type, $this->driver->quoteTable($table));
$clauses = [
'queryMap',
'groupString',
'orderString',
'havingMap',
];
// Set each type of subclause
foreach($clauses as $clause)
{
$func = 'get' . ucFirst($clause);
$param = $this->state->$func();
2018-01-22 15:43:56 -05:00
if (\is_array($param))
{
foreach($param as $q)
{
$sql .= $q['conjunction'] . $q['string'];
}
}
else
{
$sql .= $param;
}
}
// Set the limit via the class variables
$limit = $this->state->getLimit();
if (is_numeric($limit))
2018-01-22 15:43:56 -05:00
{
$sql = $this->driver->getSql()->limit($sql, $limit, $this->state->getOffset());
2018-01-22 15:43:56 -05:00
}
// See if the query plan, rather than the
// query data should be returned
if ($this->explain === TRUE)
{
$sql = $this->driver->getSql()->explain($sql);
2018-01-22 15:43:56 -05:00
}
return $sql;
}
2012-03-15 09:25:18 -04:00
}