Source of file QueryBuilder.php

<?php declare(strict_types=1);

/**

 * Query

 *

 * SQL Query Builder / Database Abstraction Layer

 *

 * PHP version 7.1

 *

 * @package     Query

 * @author      Timothy J. Warren <tim@timshomepage.net>

 * @copyright   2012 - 2018 Timothy J. Warren

 * @license     http://www.opensource.org/licenses/mit-license.html  MIT License

 * @link        https://git.timshomepage.net/aviat4ion/Query

 */

namespace Query;

use function regexInArray;

use BadMethodCallException;

use PDOStatement;

use Query\Drivers\DriverInterface;

/**

 * Convenience class for creating sql queries

 */

class QueryBuilder implements QueryBuilderInterface {

	/**

	 * Convenience property for connection management

	 * @var string

	 */

	public $connName = '';

	/**

	 * List of queries executed

	 * @var array

	 */

	public $queries = [

		'total_time' => 0

	];

	/**

	 * Whether to do only an explain on the query

	 * @var boolean

	 */

	protected $explain = FALSE;

	/**

	 * The current database driver

	 * @var DriverInterface

	 */

	protected $driver;

	/**

	 * Query parser class instance

	 * @var QueryParser

	 */

	protected $parser;

	/**

	 * Query Builder state

	 * @var State

	 */

	protected $state;

	// --------------------------------------------------------------------------

	// ! Methods

	// --------------------------------------------------------------------------

	/**

	 * Constructor

	 *

	 * @param DriverInterface $driver

	 * @param QueryParser $parser

	 */

	public function __construct(DriverInterface $driver, QueryParser $parser)

	{

		// Inject driver and parser

		$this->driver = $driver;

		$this->parser = $parser;

		// Create new State object

		$this->state = new State();

	}

	/**

	 * Destructor

	 * @codeCoverageIgnore

	 */

	public function __destruct()

	{

		$this->driver = NULL;

	}

	/**

	 * Calls a function further down the inheritance chain

	 *

	 * @param string $name

	 * @param array $params

	 * @return mixed

	 * @throws BadMethodCallException

	 */

	public function __call(string $name, array $params)

	{

		if (method_exists($this->driver, $name))

		{

			return \call_user_func_array([$this->driver, $name], $params);

		}

		throw new BadMethodCallException('Method does not exist');

	}

	// --------------------------------------------------------------------------

	// ! Select Queries

	// --------------------------------------------------------------------------

	/**

	 * Specifies rows to select in a query

	 *

	 * @param string $fields

	 * @return self

	 */

	public function select(string $fields): self

	{

		// Split fields by comma

		$fieldsArray = explode(',', $fields);

		$fieldsArray = array_map('mb_trim', $fieldsArray);

		// Split on 'As'

		foreach ($fieldsArray as $key => $field)

		{

			if (stripos($field, 'as') !== FALSE)

			{

				$fieldsArray[$key] = preg_split('` as `i', $field);

				$fieldsArray[$key] = array_map('mb_trim', $fieldsArray[$key]);

			}

		}

		// Quote the identifiers

		$safeArray = $this->driver->quoteIdent($fieldsArray);

		unset($fieldsArray);

		// Join the strings back together

		for($i = 0, $c = count($safeArray); $i < $c; $i++)

		{

			if (\is_array($safeArray[$i]))

			{

				$safeArray[$i] = implode(' AS ', $safeArray[$i]);

			}

		}

		$this->state->appendSelectString(implode(', ', $safeArray));

		return $this;

	}

	/**

	 * Selects the maximum value of a field from a query

	 *

	 * @param string $field

	 * @param string|bool $as

	 * @return self

	 */

	public function selectMax(string $field, $as=FALSE): self

	{

		// Create the select string

		$this->state->appendSelectString(' MAX'.$this->_select($field, $as));

		return $this;

	}

	/**

	 * Selects the minimum value of a field from a query

	 *

	 * @param string $field

	 * @param string|bool $as

	 * @return self

	 */

	public function selectMin(string $field, $as=FALSE): self

	{

		// Create the select string

		$this->state->appendSelectString(' MIN'.$this->_select($field, $as));

		return $this;

	}

	/**

	 * Selects the average value of a field from a query

	 *

	 * @param string $field

	 * @param string|bool $as

	 * @return self

	 */

	public function selectAvg(string $field, $as=FALSE): self

	{

		// Create the select string

		$this->state->appendSelectString(' AVG'.$this->_select($field, $as));

		return $this;

	}

	/**

	 * Selects the sum of a field from a query

	 *

	 * @param string $field

	 * @param string|bool $as

	 * @return self

	 */

	public function selectSum(string $field, $as=FALSE): self

	{

		// Create the select string

		$this->state->appendSelectString(' SUM'.$this->_select($field, $as));

		return $this;

	}

	/**

	 * @param string $fields

	 * @return $this

	 */

	public function returning(string $fields = '*'): self

	{

		return $this;

	}

	/**

	 * Adds the 'distinct' keyword to a query

	 *

	 * @return self

	 */

	public function distinct(): self

	{

		// Prepend the keyword to the select string

		$this->state->setSelectString(' DISTINCT' . $this->state->getSelectString());

		return $this;

	}

	/**

	 * Tell the database to give you the query plan instead of result set

	 *

	 * @return self

	 */

	public function explain(): self

	{

		$this->explain = TRUE;

		return $this;

	}

	/**

	 * Specify the database table to select from

	 *

	 * @param string $tblname

	 * @return self

	 */

	public function from(string $tblname): self

	{

		// Split identifiers on spaces

		$identArray = explode(' ', \mb_trim($tblname));

		$identArray = array_map('\\mb_trim', $identArray);

		// Quote the identifiers

		$identArray[0] = $this->driver->quoteTable($identArray[0]);

		$identArray = $this->driver->quoteIdent($identArray);

		// Paste it back together

		$this->state->setFromString(implode(' ', $identArray));

		return $this;

	}

	// --------------------------------------------------------------------------

	// ! 'Like' methods

	// --------------------------------------------------------------------------

	/**

	 * Creates a Like clause in the sql statement

	 *

	 * @param string $field

	 * @param mixed $val

	 * @param string $pos

	 * @return self

	 */

	public function like(string $field, $val, string $pos='both'): self

	{

		return $this->_like($field, $val, $pos);

	}

	/**

	 * Generates an OR Like clause

	 *

	 * @param string $field

	 * @param mixed $val

	 * @param string $pos

	 * @return self

	 */

	public function orLike(string $field, $val, string $pos='both'): self

	{

		return $this->_like($field, $val, $pos, 'LIKE', 'OR');

	}

	/**

	 * Generates a NOT LIKE clause

	 *

	 * @param string $field

	 * @param mixed $val

	 * @param string $pos

	 * @return self

	 */

	public function notLike(string $field, $val, string $pos='both'): self

	{

		return $this->_like($field, $val, $pos, 'NOT LIKE');

	}

	/**

	 * Generates a OR NOT LIKE clause

	 *

	 * @param string $field

	 * @param mixed $val

	 * @param string $pos

	 * @return self

	 */

	public function orNotLike(string $field, $val, string $pos='both'): self

	{

		return $this->_like($field, $val, $pos, 'NOT LIKE', 'OR');

	}

	// --------------------------------------------------------------------------

	// ! Having methods

	// --------------------------------------------------------------------------

	/**

	 * Generates a 'Having' clause

	 *

	 * @param mixed $key

	 * @param mixed $val

	 * @return self

	 */

	public function having($key, $val=[]): self

	{

		return $this->_having($key, $val);

	}

	/**

	 * Generates a 'Having' clause prefixed with 'OR'

	 *

	 * @param mixed $key

	 * @param mixed $val

	 * @return self

	 */

	public function orHaving($key, $val=[]): self

	{

		return $this->_having($key, $val, 'OR');

	}

	// --------------------------------------------------------------------------

	// ! 'Where' methods

	// --------------------------------------------------------------------------

	/**

	 * 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

	 *

	 * @param mixed $key

	 * @param mixed $val

	 * @param mixed $escape

	 * @return self

	 */

	public function where($key, $val=[], $escape=NULL): self

	{

		return $this->_whereString($key, $val);

	}

	/**

	 * Where clause prefixed with "OR"

	 *

	 * @param string $key

	 * @param mixed $val

	 * @return self

	 */

	public function orWhere($key, $val=[]): self

	{

		return $this->_whereString($key, $val, 'OR');

	}

	/**

	 * Where clause with 'IN' statement

	 *

	 * @param mixed $field

	 * @param mixed $val

	 * @return self

	 */

	public function whereIn($field, $val=[]): self

	{

		return $this->_whereIn($field, $val);

	}

	/**

	 * Where in statement prefixed with "or"

	 *

	 * @param string $field

	 * @param mixed $val

	 * @return self

	 */

	public function orWhereIn($field, $val=[]): self

	{

		return $this->_whereIn($field, $val, 'IN', 'OR');

	}

	/**

	 * WHERE NOT IN (FOO) clause

	 *

	 * @param string $field

	 * @param mixed $val

	 * @return self

	 */

	public function whereNotIn($field, $val=[]): self

	{

		return $this->_whereIn($field, $val, 'NOT IN');

	}

	/**

	 * OR WHERE NOT IN (FOO) clause

	 *

	 * @param string $field

	 * @param mixed $val

	 * @return self

	 */

	public function orWhereNotIn($field, $val=[]): self

	{

		return $this->_whereIn($field, $val, 'NOT IN', 'OR');

	}

	// --------------------------------------------------------------------------

	// ! Other Query Modifier methods

	// --------------------------------------------------------------------------

	/**

	 * Sets values for inserts / updates / deletes

	 *

	 * @param mixed $key

	 * @param mixed $val

	 * @return self

	 */

	public function set($key, $val = NULL): self

	{

		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);

		// 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())

		);

		// Generate the "set" string

		$setString = implode('=?,', $this->state->getSetArrayKeys());

		$setString .= '=?';

		$this->state->setSetString($setString);

		return $this;

	}

	/**

	 * Creates a join phrase in a compiled query

	 *

	 * @param string $table

	 * @param string $condition

	 * @param string $type

	 * @return self

	 */

	public function join(string $table, string $condition, string $type=''): self

	{

		// Prefix and quote table name

		$table = explode(' ', mb_trim($table));

		$table[0] = $this->driver->quoteTable($table[0]);

		$table = $this->driver->quoteIdent($table);

		$table = implode(' ', $table);

		// Parse out the join condition

		$parsedCondition = $this->parser->compileJoin($condition);

		$condition = $table . ' ON ' . $parsedCondition;

		$this->state->appendMap("\n" . strtoupper($type) . ' JOIN ', $condition, 'join');

		return $this;

	}

	/**

	 * Group the results by the selected field(s)

	 *

	 * @param mixed $field

	 * @return self

	 */

	public function groupBy($field): self

	{

		if ( ! is_scalar($field))

		{

			$newGroupArray = array_map([$this->driver, 'quoteIdent'], $field);

			$this->state->setGroupArray(

				array_merge($this->state->getGroupArray(), $newGroupArray)

			);

		}

		else

		{

			$this->state->appendGroupArray($this->driver->quoteIdent($field));

		}

		$this->state->setGroupString(' GROUP BY ' . implode(',', $this->state->getGroupArray()));

		return $this;

	}

	/**

	 * Order the results by the selected field(s)

	 *

	 * @param string $field

	 * @param string $type

	 * @return self

	 */

	public function orderBy(string $field, string $type=''): self

	{

		// When ordering by random, do an ascending order if the driver

		// doesn't support random ordering

		if (stripos($type, 'rand') !== FALSE)

		{

			$rand = $this->driver->getSql()->random();

			$type = $rand ?? 'ASC';

		}

		// Set fields for later manipulation

		$field = $this->driver->quoteIdent($field);

		$this->state->setOrderArray($field, $type);

		$orderClauses = [];

		// Flatten key/val pairs into an array of space-separated pairs

		foreach($this->state->getOrderArray() as $k => $v)

		{

			$orderClauses[] = $k . ' ' . strtoupper($v);

		}

		// Set the final string

		$orderString =  ! isset($rand)

			? "\nORDER BY ".implode(', ', $orderClauses)

			: "\nORDER BY".$rand;

		$this->state->setOrderString($orderString);

		return $this;

	}

	/**

	 * Set a limit on the current sql statement

	 *

	 * @param int $limit

	 * @param int|bool $offset

	 * @return self

	 */

	public function limit(int $limit, $offset=FALSE): self

	{

		$this->state->setLimit($limit);

		$this->state->setOffset($offset);

		return $this;

	}

	// --------------------------------------------------------------------------

	// ! Query Grouping Methods

	// --------------------------------------------------------------------------

	/**

	 * Adds a paren to the current query for query grouping

	 *

	 * @return self

	 */

	public function groupStart(): self

	{

		$conj = empty($this->state->getQueryMap()) ? ' WHERE ' : ' ';

		$this->state->appendMap($conj, '(', 'group_start');

		return $this;

	}

	/**

	 * Adds a paren to the current query for query grouping,

	 * prefixed with 'NOT'

	 *

	 * @return self

	 */

	public function notGroupStart(): self

	{

		$conj = empty($this->state->getQueryMap()) ? ' WHERE ' : ' AND ';

		$this->state->appendMap($conj, ' NOT (', 'group_start');

		return $this;

	}

	/**

	 * Adds a paren to the current query for query grouping,

	 * prefixed with 'OR'

	 *

	 * @return self

	 */

	public function orGroupStart(): self

	{

		$this->state->appendMap('', ' OR (', 'group_start');

		return $this;

	}

	/**

	 * Adds a paren to the current query for query grouping,

	 * prefixed with 'OR NOT'

	 *

	 * @return self

	 */

	public function orNotGroupStart(): self

	{

		$this->state->appendMap('', ' OR NOT (', 'group_start');

		return $this;

	}

	/**

	 * Ends a query group

	 *

	 * @return self

	 */

	public function groupEnd(): self

	{

		$this->state->appendMap('', ')', 'group_end');

		return $this;

	}

	// --------------------------------------------------------------------------

	// ! Query execution methods

	// --------------------------------------------------------------------------

	/**

	 * Select and retrieve all records from the current table, and/or

	 * execute current compiled query

	 *

	 * @param string $table

	 * @param int|bool $limit

	 * @param int|bool $offset

	 * @return PDOStatement

	 */

	public function get(string $table='', $limit=FALSE, $offset=FALSE): PDOStatement

	{

		// Set the table

		if ( ! empty($table))

		{

			$this->from($table);

		}

		// Set the limit, if it exists

		if (\is_int($limit))

		{

			$this->limit($limit, $offset);

		}

		return $this->_run('get', $table);

	}

	/**

	 * Convenience method for get() with a where clause

	 *

	 * @param string $table

	 * @param mixed $where

	 * @param int|bool $limit

	 * @param int|bool $offset

	 * @return PDOStatement

	 */

	public function getWhere(string $table, $where=[], $limit=FALSE, $offset=FALSE): PDOStatement

	{

		// Create the where clause

		$this->where($where);

		// Return the result

		return $this->get($table, $limit, $offset);

	}

	/**

	 * Retrieve the number of rows in the selected table

	 *

	 * @param string $table

	 * @return int

	 */

	public function countAll(string $table): int

	{

		$sql = 'SELECT * FROM '.$this->driver->quoteTable($table);

		$res = $this->driver->query($sql);

		return (int) count($res->fetchAll());

	}

	/**

	 * Retrieve the number of results for the generated query - used

	 * in place of the get() method

	 *

	 * @param string $table

	 * @param boolean $reset

	 * @return int

	 */

	public function countAllResults(string $table='', bool $reset = TRUE): int

	{

		// Set the table

		if ( ! empty($table))

		{

			$this->from($table);

		}

		$result = $this->_run('get', $table, NULL, NULL, $reset);

		$rows = $result->fetchAll();

		return (int) count($rows);

	}

	/**

	 * Creates an insert clause, and executes it

	 *

	 * @param string $table

	 * @param mixed $data

	 * @return PDOStatement

	 */

	public function insert(string $table, $data=[]): PDOStatement

	{

		if ( ! empty($data))

		{

			$this->set($data);

		}

		return $this->_run('insert', $table);

	}

	/**

	 * Creates and executes a batch insertion query

	 *

	 * @param string $table

	 * @param array $data

	 * @return PDOStatement

	 */

	public function insertBatch(string $table, $data=[]): PDOStatement

	{

		// Get the generated values and sql string

		[$sql, $data] = $this->driver->insertBatch($table, $data);

		return $sql !== NULL

			? $this->_run('', $table, $sql, $data)

			: NULL;

	}

	/**

	 * Creates an update clause, and executes it

	 *

	 * @param string $table

	 * @param mixed $data

	 * @return PDOStatement

	 */

	public function update(string $table, $data=[]): PDOStatement

	{

		if ( ! empty($data))

		{

			$this->set($data);

		}

		return $this->_run('update', $table);

	}

	/**

	 * Creates a batch update, and executes it.

	 * Returns the number of affected rows

	 *

	 * @param string $table

	 * @param array $data

	 * @param string $where

	 * @return int|null

	 */

	public function updateBatch(string $table, array $data, string $where): ?int

	{

		if (empty($table) || empty($data) || empty($where))

		{

			return NULL;

		}

		// Get the generated values and sql string

		[$sql, $data, $affectedRows] = $this->driver->updateBatch($table, $data, $where);

		$this->_run('', $table, $sql, $data);

		return $affectedRows;

	}

	/**

	 * Deletes data from a table

	 *

	 * @param string $table

	 * @param mixed $where

	 * @return PDOStatement

	 */

	public function delete(string $table, $where=''): PDOStatement

	{

		// Set the where clause

		if ( ! empty($where))

		{

			$this->where($where);

		}

		return $this->_run('delete', $table);

	}

	// --------------------------------------------------------------------------

	// ! SQL Returning Methods

	// --------------------------------------------------------------------------

	/**

	 * Returns the generated 'select' sql query

	 *

	 * @param string $table

	 * @param bool $reset

	 * @return string

	 */

	public function getCompiledSelect(string $table='', bool $reset=TRUE): string

	{

		// Set the table

		if ( ! empty($table))

		{

			$this->from($table);

		}

		return $this->_getCompile('select', $table, $reset);

	}

	/**

	 * Returns the generated 'insert' sql query

	 *

	 * @param string $table

	 * @param bool $reset

	 * @return string

	 */

	public function getCompiledInsert(string $table, bool $reset=TRUE): string

	{

		return $this->_getCompile('insert', $table, $reset);

	}

	/**

	 * Returns the generated 'update' sql query

	 *

	 * @param string $table

	 * @param bool $reset

	 * @return string

	 */

	public function getCompiledUpdate(string $table='', bool $reset=TRUE): string

	{

		return $this->_getCompile('update', $table, $reset);

	}

	/**

	 * Returns the generated 'delete' sql query

	 *

	 * @param string $table

	 * @param bool $reset

	 * @return string

	 */

	public function getCompiledDelete(string $table='', bool $reset=TRUE): string

	{

		return $this->_getCompile('delete', $table, $reset);

	}

	// --------------------------------------------------------------------------

	// ! Miscellaneous Methods

	// --------------------------------------------------------------------------

	/**

	 * Clear out the class variables, so the next query can be run

	 *

	 * @return void

	 */

	public function resetQuery(): void

	{

		$this->state = new State();

		$this->explain = FALSE;

	}

	/**

	 * 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))

		{

			// @codeCoverageIgnoreStart

			return $field;

			// @codeCoverageIgnoreEnd

		}

		$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

	 * @return self

	 */

	protected function _like(string $field, $val, string $pos, string $like='LIKE', string $conj='AND'): self

	{

		$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');

		// Add to the values array

		$this->state->appendWhereValues($val);

		return $this;

	}

	/**

	 * Simplify building having clauses

	 *

	 * @param mixed $key

	 * @param mixed $values

	 * @param string $conj

	 * @return self

	 */

	protected function _having($key, $values=[], string $conj='AND'): self

	{

		$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} ",

				'string' => $item

			]);

		}

		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);

		}

		return $where;

	}

	/**

	 * Simplify generating where string

	 *

	 * @param mixed $key

	 * @param mixed $values

	 * @param string $defaultConj

	 * @return self

	 */

	protected function _whereString($key, $values=[], string $defaultConj='AND'): self

	{

		// Create key/value placeholders

		foreach($this->_where($key, $values) as $f => $val)

		{

			$queryMap = $this->state->getQueryMap();

			// Split each key by spaces, in case there

			// is an operator such as >, <, !=, etc.

			$fArray = explode(' ', trim($f));