Jingga/phpOMS
1
0
Fork 0
mirror of https://github.com/Karaka-Management/phpOMS.git synced 2026-01-11 17:58:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
b8561385f5
phpOMS/DataStorage/Database/Query/Builder.php
Dennis Eichhorn b8561385f5 Add docblocks
2017-02-22 20:29:24 +01:00

1154 lines
24 KiB
PHP
Raw Blame History

<?php
/**
* Orange Management
*
* PHP Version 7.1
*
* @category TBD
* @package TBD
* @author OMS Development Team <dev@oms.com>
* @author Dennis Eichhorn <d.eichhorn@oms.com>
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @link http://orange-management.com
*/
declare(strict_types=1);
namespace phpOMS\DataStorage\Database\Query;
use phpOMS\DataStorage\Database\BuilderAbstract;
use phpOMS\DataStorage\Database\Connection\ConnectionAbstract;
/**
* Database query builder.
*
* @category Framework
* @package phpOMS\DataStorage\Database
* @author OMS Development Team <dev@oms.com>
* @author Dennis Eichhorn <d.eichhorn@oms.com>
* @license OMS License 1.0
* @link http://orange-management.com
* @since 1.0.0
*/
class Builder extends BuilderAbstract
{
/**
* Is read only.
*
* @var bool
* @since 1.0.0
*/
private $isReadOnly = false;
/**
* Columns.
*
* @var array
* @since 1.0.0
*/
public $selects = [];
/**
* Into.
*
* @var array
* @since 1.0.0
*/
public $into = null;
/**
* Into columns.
*
* @var array
* @since 1.0.0
*/
public $inserts = [];
/**
* Into columns.
*
* @var array
* @since 1.0.0
*/
public $values = [];
/**
* Distinct.
*
* @var bool
* @since 1.0.0
*/
public $distinct = false;
/**
* From.
*
* @var array
* @since 1.0.0
*/
public $from = [];
/**
* Joins.
*
* @var array
* @since 1.0.0
*/
public $joins = [];
/**
* Where.
*
* @var array
* @since 1.0.0
*/
public $wheres = [];
/**
* Group.
*
* @var array
* @since 1.0.0
*/
public $groups = [];
/**
* Order.
*
* @var array
* @since 1.0.0
*/
public $orders = [];
/**
* Limit.
*
* @var int
* @since 1.0.0
*/
public $limit = null;
/**
* Offset.
*
* @var array
* @since 1.0.0
*/
public $offset = null;
/**
* Binds.
*
* @var array
* @since 1.0.0
*/
private $binds = [];
/**
* Union.
*
* @var array
* @since 1.0.0
*/
public $unions = [];
/**
* Lock.
*
* @var bool
* @since 1.0.0
*/
public $lock = false;
/**
* Raw query.
*
* @var bool
* @since 1.0.0
*/
public $raw = '';
protected $unionLimit = null;
protected $unionOffset = null;
protected $unionOrders = [];
/**
* Comparison operators.
*
* @var string[]
* @since 1.0.0
*/
/* public */ const operators = [
'=',
'<',
'>',
'<=',
'>=',
'<>',
'!=',
'like',
'like binary',
'not like',
'between',
'ilike',
'&',
'|',
'^',
'<<',
'>>',
'rlike',
'regexp',
'not regexp',
'~',
'~*',
'!~',
'!~*',
'similar to',
'not similar to',
'in',
];
/**
* Constructor.
*
* @param ConnectionAbstract $connection Database connection
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function __construct(ConnectionAbstract $connection, bool $readOnly = false)
{
$this->isReadOnly = $readOnly;
$this->setConnection($connection);
}
/**
* Set connection for grammar.
*
* @param ConnectionAbstract $connection Database connection
*
* @return void
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function setConnection(ConnectionAbstract $connection) /* : void */
{
$this->connection = $connection;
$this->grammar = $connection->getGrammar();
}
/**
* Select.
*
* @param array $columns Columns
*
* @return Builder
*
* @todo Closure is not working this way, needs to be evaluated befor assigning
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function select(...$columns) : Builder
{
$this->type = QueryType::SELECT;
foreach ($columns as $key => $column) {
if (is_string($column) || $column instanceof \Closure) {
$this->selects[] = $column;
} else {
throw new \InvalidArgumentException();
}
}
return $this;
}
/**
* Select.
*
* @param array $columns Columns
*
* @return Builder
*
* @todo Closure is not working this way, needs to be evaluated befor assigning
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function random(...$columns) : Builder
{
$this->select(...$columns);
$this->type = QueryType::RANDOM;
return $this;
}
/**
* Bind parameter.
*
* @param string|array|\Closure $binds Binds
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function bind($binds) : Builder
{
if (is_array($binds)) {
$this->binds += $binds;
} elseif (is_string($binds) || $binds instanceof \Closure) {
$this->binds[] = $binds;
} else {
throw new \InvalidArgumentException();
}
return $this;
}
/**
* Creating new.
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function newQuery() : Builder
{
return new static($this->connection, $this->grammar);
}
/**
* Parsing to string.
*
* @return string
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function toSql() : string
{
return $this->grammar->compileQuery($this);
}
/**
* Set raw query.
*
* @param string $raw Raw query
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function raw(string $raw) : Builder
{
if($this->isReadOnly) {
$test = strtolower($raw);
if(strpos($test, 'insert') !== false
|| strpos($test, 'update') !== false
|| strpos($test, 'drop') !== false
|| strpos($test, 'delete') !== false
|| strpos($test, 'create') !== false
|| strpos($test, 'alter') !== false) {
throw new \Exception();
}
}
$this->type = QueryType::RAW;
$this->raw = $raw;
return $this;
}
/**
* Make raw column selection.
*
* @param string|\Closure $expression Raw expression
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function selectRaw($expression) : Builder
{
$this->selects[null][] = $expression;
return $this;
}
/**
* Is distinct.
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function distinct(...$columns) : Builder
{
$this->distinct = true;
return $this;
}
/**
* From.
*
* @param array $tables Tables
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function from(...$tables) : Builder
{
foreach ($tables as $key => $table) {
if (is_string($table) || $table instanceof \Closure) {
$this->from[] = $table;
} else {
throw new \InvalidArgumentException();
}
}
return $this;
}
/**
* Make raw from.
*
* @param string|array|\Closure $expression Expression
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function fromRaw($expression) : Builder
{
$this->from[null][] = $expression;
return $this;
}
/**
* Where.
*
* @param string|array|\Closure $columns Columns
* @param string|array $operator Operator
* @param mixed $values Values
* @param string|array $boolean Boolean condition
*
* @return Builder
*
* @throws \InvalidArgumentException
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function where($columns, $operator = null, $values = null, $boolean = 'and') : Builder
{
// TODO: handle $value is null -> operator NULL
if (isset($operator) && !is_array($operator) && !in_array($operator, self::operators)) {
throw new \InvalidArgumentException('Unknown operator.');
}
if (is_array($columns)) {
$i = 0;
foreach ($columns as $key => $column) {
if (isset($operator[$i]) && !in_array($operator[$i], self::operators)) {
throw new \InvalidArgumentException('Unknown operator.');
}
$this->wheres[self::getPublicColumnName($column)][] = [
'column' => $column,
'operator' => $operator[$i],
'value' => $values[$i],
'boolean' => $boolean[$i],
];
$i++;
}
} elseif (is_string($columns)) {
if (isset($operator) && !in_array($operator, self::operators)) {
throw new \InvalidArgumentException('Unknown operator.');
}
$this->wheres[self::getPublicColumnName($columns)][] = ['column' => $columns, 'operator' => $operator, 'value' => $values,
'boolean' => $boolean,];
} else {
throw new \InvalidArgumentException();
}
return $this;
}
/**
* Get column of where condition
*
* One column can have multiple where conditions.
* TODO: maybe think about a case where there is a where condition but no column but some other identifier?
*
* @param mixed $column Column
*
* @return array|null
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getWhereByColumn($column) /* : ?array */
{
return $this->wheres[self::getPublicColumnName($column)] ?? null;
}
/**
* Get table name of system
*
* @param mixed $expression System expression
* @param string $systemIdentifier System identifier
*
* @return string|null
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getTableOfSystem($expression, string $systemIdentifier) /* : ?string */
{
if(($pos = strpos($expression, $systemIdentifier . '.' . $systemIdentifier)) === false) {
return null;
}
return explode('.', $expression)[0];
}
/**
* Where and sub condition.
*
* @param Where $where Where sub condition
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function andWhere(Where $where) : Builder
{
$this->wheres[][] = [
'column' => $where,
'boolean' => 'and',
];
return $this;
}
/**
* Where or sub condition.
*
* @param Where $where Where sub condition
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function orWhere(Where $where) : Builder
{
$this->wheres[][] = [
'column' => $where,
'boolean' => 'or',
];
return $this;
}
/**
* Where in.
*
* @param string|array|\Closure $column Column
* @param mixed $values Values
* @param string $boolean Boolean condition
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function whereIn($column, $values = null, string $boolean = 'and') : Builder
{
$this->where($column, 'in', $values, $boolean);
return $this;
}
/**
* Where null.
*
* @param string|array|\Closure $column Column
* @param string $boolean Boolean condition
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function whereNull($column, string $boolean = 'and') : Builder
{
$this->where($column, '=', null, $boolean);
return $this;
}
/**
* Where not null.
*
* @param string|array|\Closure $column Column
* @param string $boolean Boolean condition
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function whereNotNull($column, string $boolean = 'and') : Builder
{
$this->where($column, '!=', null, $boolean);
return $this;
}
/**
* Group by.
*
* @param string|array|\Closure $columns Grouping result
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function groupBy(...$columns) : Builder
{
foreach ($columns as $key => $column) {
if (is_string($column) || $column instanceof \Closure) {
$this->groups[] = $column;
} else {
throw new \InvalidArgumentException();
}
}
return $this;
}
/**
* Order by newest.
*
* @param string|\Closure $column Column
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function newest($column) : Builder
{
$this->orderBy($column, 'DESC');
return $this;
}
/**
* Order by oldest.
*
* @param string|\Closure $column Column
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function oldest($column) : Builder
{
$this->orderBy($column, 'ASC');
return $this;
}
/**
* Order by oldest.
*
* @param string|array|\Closure $columns Columns
* @param string|string[] $order Orders
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function orderBy($columns, $order = 'DESC') : Builder
{
if (is_string($columns) || $columns instanceof \Closure) {
$this->orders[] = ['column' => $columns, 'order' => $order];
} elseif (is_array($columns)) {
foreach ($columns as $key => $column) {
$this->orders[] = ['column' => $column, 'order' => $order[$key]];
}
} else {
throw new \InvalidArgumentException();
}
return $this;
}
/**
* Offset.
*
* @param int|\Closure $offset Offset
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function offset($offset) : Builder
{
$this->offset = $offset;
return $this;
}
/**
* Limit.
*
* @param int|\Closure $limit Limit
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function limit($limit) : Builder
{
$this->limit = $limit;
return $this;
}
/**
* Limit.
*
* @param string|\phpOMS\DataStorage\Database\Query\Builder $query Query
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function union($query) : Builder
{
if (!is_array($query)) {
$this->unions[] = $query;
} else {
$this->unions += $query;
}
return $this;
}
/**
* Lock query.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function lock()
{
}
/**
* Lock for update query.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function lockUpdate()
{
}
/**
* Create query string.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function __toString()
{
return $this->grammar->compileQuery($this);
}
/**
* Find query.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function find()
{
}
/**
* Count results.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function count(string $table = '*')
{
// todo: don't do this as string, create new object new Count(); this can get handled by the grammar parser WAY better
return $this->select('COUNT(' . $table . ')');
}
/**
* Check if exists.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function exists()
{
}
/**
* Select minimum.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function min()
{
}
/**
* Select maximum.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function max()
{
}
/**
* Select sum.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function sum()
{
}
/**
* Select average.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function avg()
{
}
/**
* Insert into columns.
*
* @param array $columns Columns
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function insert(...$columns) : Builder
{
if($this->isReadOnly) {
throw new \Exception();
}
$this->type = QueryType::INSERT;
foreach ($columns as $key => $column) {
$this->inserts[] = $column;
}
return $this;
}
/**
* Table to insert into.
*
* @param string|\Closure $table Table
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function into($table) : Builder
{
$this->into = $table;
return $this;
}
/**
* Values to insert.
*
* @param array $values Values
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function values(...$values) : Builder
{
$this->values[] = $values;
return $this;
}
/**
* Values to insert.
*
* @param mixed $value Values
* @param string $type Data type to insert
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function value($value, string $type = 'string') : Builder
{
end($this->values);
$key = key($this->values);
$this->values[$key][] = $value;
reset($this->values);
return $this;
}
/**
* Update columns.
*
* @param array $columns Column names to update
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function update(...$columns) : Builder
{
if($this->isReadOnly) {
throw new \Exception();
}
$this->type = QueryType::UPDATE;
foreach ($columns as $key => $column) {
$this->inserts[] = $column;
}
return $this;
}
/**
* Increment value.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function increment()
{
}
/**
* Decrement value.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function decrement()
{
}
/**
* Join.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function join($table1, $table2, $column1, $opperator, $column2)
{
return $this;
}
/**
* Join where.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function joinWhere()
{
}
/**
* Left join.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function leftJoin()
{
}
/**
* Left join where.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function leftJoinWhere()
{
}
/**
* Right join.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function rightJoin()
{
}
/**
* Right join where.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function rightJoinWhere()
{
}
/**
* Rollback.
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function rollback()
{
return $this;
}
/**
* On.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function on()
{
}
/**
* Merging query.
*
* Merging query in order to remove database query volume
*
* @param Builder $query Query
*
* @return Builder
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function merge(Builder $query) : Builder
{
return clone($this);
}
/**
* Execute query.
*
* @return mixed
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function execute()
{
$sth = $this->connection->con->prepare($this->toSql());
foreach($this->binds as $key => $bind) {
$type = self::getBindParamType($bind);
$sth->bindParam($key, $bind, $type);
}
$sth->execute();
return $sth;
}
/**
* Get bind parameter type.
*
* @return mixed
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function getBindParamType($value)
{
if(is_int($value)) {
return PDO::PARAM_INT;
} elseif(is_string($value) || is_float($value)) {
return PDO::PARAM_STR;
}
throw new \Exception();
}
public static function getPublicColumnName($column) : string
{
if(is_string($column)) {
return $column;
} elseif($column instanceof Column) {
return $column->getPublicName();
} elseif($column instanceof \Closure) {
return $column();
} elseif($column instanceof \Serializable) {
return $column;
}
throw new \Exception();
}
}
Reference in New Issue View Git Blame Copy Permalink