762 lines
21 KiB
PHP
Executable File
762 lines
21 KiB
PHP
Executable File
<?php
|
|
|
|
namespace Illuminate\Database\Query\Grammars;
|
|
|
|
use Illuminate\Database\Query\Builder;
|
|
use Illuminate\Database\Grammar as BaseGrammar;
|
|
|
|
class Grammar extends BaseGrammar
|
|
{
|
|
/**
|
|
* The components that make up a select clause.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $selectComponents = [
|
|
'aggregate',
|
|
'columns',
|
|
'from',
|
|
'joins',
|
|
'wheres',
|
|
'groups',
|
|
'havings',
|
|
'orders',
|
|
'limit',
|
|
'offset',
|
|
'unions',
|
|
'lock',
|
|
];
|
|
|
|
/**
|
|
* Compile a select query into SQL.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @return string
|
|
*/
|
|
public function compileSelect(Builder $query)
|
|
{
|
|
if (is_null($query->columns)) {
|
|
$query->columns = ['*'];
|
|
}
|
|
|
|
return trim($this->concatenate($this->compileComponents($query)));
|
|
}
|
|
|
|
/**
|
|
* Compile the components necessary for a select clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @return array
|
|
*/
|
|
protected function compileComponents(Builder $query)
|
|
{
|
|
$sql = [];
|
|
|
|
foreach ($this->selectComponents as $component) {
|
|
// To compile the query, we'll spin through each component of the query and
|
|
// see if that component exists. If it does we'll just call the compiler
|
|
// function for the component which is responsible for making the SQL.
|
|
if (! is_null($query->$component)) {
|
|
$method = 'compile'.ucfirst($component);
|
|
|
|
$sql[$component] = $this->$method($query, $query->$component);
|
|
}
|
|
}
|
|
|
|
return $sql;
|
|
}
|
|
|
|
/**
|
|
* Compile an aggregated select clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $aggregate
|
|
* @return string
|
|
*/
|
|
protected function compileAggregate(Builder $query, $aggregate)
|
|
{
|
|
$column = $this->columnize($aggregate['columns']);
|
|
|
|
// If the query has a "distinct" constraint and we're not asking for all columns
|
|
// we need to prepend "distinct" onto the column name so that the query takes
|
|
// it into account when it performs the aggregating operations on the data.
|
|
if ($query->distinct && $column !== '*') {
|
|
$column = 'distinct '.$column;
|
|
}
|
|
|
|
return 'select '.$aggregate['function'].'('.$column.') as aggregate';
|
|
}
|
|
|
|
/**
|
|
* Compile the "select *" portion of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $columns
|
|
* @return string
|
|
*/
|
|
protected function compileColumns(Builder $query, $columns)
|
|
{
|
|
// If the query is actually performing an aggregating select, we will let that
|
|
// compiler handle the building of the select clauses, as it will need some
|
|
// more syntax that is best handled by that function to keep things neat.
|
|
if (! is_null($query->aggregate)) {
|
|
return;
|
|
}
|
|
|
|
$select = $query->distinct ? 'select distinct ' : 'select ';
|
|
|
|
return $select.$this->columnize($columns);
|
|
}
|
|
|
|
/**
|
|
* Compile the "from" portion of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param string $table
|
|
* @return string
|
|
*/
|
|
protected function compileFrom(Builder $query, $table)
|
|
{
|
|
return 'from '.$this->wrapTable($table);
|
|
}
|
|
|
|
/**
|
|
* Compile the "join" portions of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $joins
|
|
* @return string
|
|
*/
|
|
protected function compileJoins(Builder $query, $joins)
|
|
{
|
|
$sql = [];
|
|
|
|
$query->setBindings([], 'join');
|
|
|
|
foreach ($joins as $join) {
|
|
$table = $this->wrapTable($join->table);
|
|
|
|
// First we need to build all of the "on" clauses for the join. There may be many
|
|
// of these clauses so we will need to iterate through each one and build them
|
|
// separately, then we'll join them up into a single string when we're done.
|
|
$clauses = [];
|
|
|
|
foreach ($join->clauses as $clause) {
|
|
$clauses[] = $this->compileJoinConstraint($clause);
|
|
}
|
|
|
|
foreach ($join->bindings as $binding) {
|
|
$query->addBinding($binding, 'join');
|
|
}
|
|
|
|
// Once we have constructed the clauses, we'll need to take the boolean connector
|
|
// off of the first clause as it obviously will not be required on that clause
|
|
// because it leads the rest of the clauses, thus not requiring any boolean.
|
|
$clauses[0] = $this->removeLeadingBoolean($clauses[0]);
|
|
|
|
$clauses = implode(' ', $clauses);
|
|
|
|
$type = $join->type;
|
|
|
|
// Once we have everything ready to go, we will just concatenate all the parts to
|
|
// build the final join statement SQL for the query and we can then return the
|
|
// final clause back to the callers as a single, stringified join statement.
|
|
$sql[] = "$type join $table on $clauses";
|
|
}
|
|
|
|
return implode(' ', $sql);
|
|
}
|
|
|
|
/**
|
|
* Create a join clause constraint segment.
|
|
*
|
|
* @param array $clause
|
|
* @return string
|
|
*/
|
|
protected function compileJoinConstraint(array $clause)
|
|
{
|
|
$first = $this->wrap($clause['first']);
|
|
|
|
if ($clause['where']) {
|
|
if ($clause['operator'] === 'in' || $clause['operator'] === 'not in') {
|
|
$second = '('.implode(', ', array_fill(0, $clause['second'], '?')).')';
|
|
} else {
|
|
$second = '?';
|
|
}
|
|
} else {
|
|
$second = $this->wrap($clause['second']);
|
|
}
|
|
|
|
return "{$clause['boolean']} $first {$clause['operator']} $second";
|
|
}
|
|
|
|
/**
|
|
* Compile the "where" portions of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @return string
|
|
*/
|
|
protected function compileWheres(Builder $query)
|
|
{
|
|
$sql = [];
|
|
|
|
if (is_null($query->wheres)) {
|
|
return '';
|
|
}
|
|
|
|
// Each type of where clauses has its own compiler function which is responsible
|
|
// for actually creating the where clauses SQL. This helps keep the code nice
|
|
// and maintainable since each clause has a very small method that it uses.
|
|
foreach ($query->wheres as $where) {
|
|
$method = "where{$where['type']}";
|
|
|
|
$sql[] = $where['boolean'].' '.$this->$method($query, $where);
|
|
}
|
|
|
|
// If we actually have some where clauses, we will strip off the first boolean
|
|
// operator, which is added by the query builders for convenience so we can
|
|
// avoid checking for the first clauses in each of the compilers methods.
|
|
if (count($sql) > 0) {
|
|
$sql = implode(' ', $sql);
|
|
|
|
return 'where '.$this->removeLeadingBoolean($sql);
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Compile a nested where clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereNested(Builder $query, $where)
|
|
{
|
|
$nested = $where['query'];
|
|
|
|
return '('.substr($this->compileWheres($nested), 6).')';
|
|
}
|
|
|
|
/**
|
|
* Compile a where condition with a sub-select.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereSub(Builder $query, $where)
|
|
{
|
|
$select = $this->compileSelect($where['query']);
|
|
|
|
return $this->wrap($where['column']).' '.$where['operator']." ($select)";
|
|
}
|
|
|
|
/**
|
|
* Compile a basic where clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereBasic(Builder $query, $where)
|
|
{
|
|
$value = $this->parameter($where['value']);
|
|
|
|
return $this->wrap($where['column']).' '.$where['operator'].' '.$value;
|
|
}
|
|
|
|
/**
|
|
* Compile a "between" where clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereBetween(Builder $query, $where)
|
|
{
|
|
$between = $where['not'] ? 'not between' : 'between';
|
|
|
|
return $this->wrap($where['column']).' '.$between.' ? and ?';
|
|
}
|
|
|
|
/**
|
|
* Compile a where exists clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereExists(Builder $query, $where)
|
|
{
|
|
return 'exists ('.$this->compileSelect($where['query']).')';
|
|
}
|
|
|
|
/**
|
|
* Compile a where exists clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereNotExists(Builder $query, $where)
|
|
{
|
|
return 'not exists ('.$this->compileSelect($where['query']).')';
|
|
}
|
|
|
|
/**
|
|
* Compile a "where in" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereIn(Builder $query, $where)
|
|
{
|
|
if (empty($where['values'])) {
|
|
return '0 = 1';
|
|
}
|
|
|
|
$values = $this->parameterize($where['values']);
|
|
|
|
return $this->wrap($where['column']).' in ('.$values.')';
|
|
}
|
|
|
|
/**
|
|
* Compile a "where not in" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereNotIn(Builder $query, $where)
|
|
{
|
|
if (empty($where['values'])) {
|
|
return '1 = 1';
|
|
}
|
|
|
|
$values = $this->parameterize($where['values']);
|
|
|
|
return $this->wrap($where['column']).' not in ('.$values.')';
|
|
}
|
|
|
|
/**
|
|
* Compile a where in sub-select clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereInSub(Builder $query, $where)
|
|
{
|
|
$select = $this->compileSelect($where['query']);
|
|
|
|
return $this->wrap($where['column']).' in ('.$select.')';
|
|
}
|
|
|
|
/**
|
|
* Compile a where not in sub-select clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereNotInSub(Builder $query, $where)
|
|
{
|
|
$select = $this->compileSelect($where['query']);
|
|
|
|
return $this->wrap($where['column']).' not in ('.$select.')';
|
|
}
|
|
|
|
/**
|
|
* Compile a "where null" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereNull(Builder $query, $where)
|
|
{
|
|
return $this->wrap($where['column']).' is null';
|
|
}
|
|
|
|
/**
|
|
* Compile a "where not null" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereNotNull(Builder $query, $where)
|
|
{
|
|
return $this->wrap($where['column']).' is not null';
|
|
}
|
|
|
|
/**
|
|
* Compile a "where date" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereDate(Builder $query, $where)
|
|
{
|
|
return $this->dateBasedWhere('date', $query, $where);
|
|
}
|
|
|
|
/**
|
|
* Compile a "where day" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereDay(Builder $query, $where)
|
|
{
|
|
return $this->dateBasedWhere('day', $query, $where);
|
|
}
|
|
|
|
/**
|
|
* Compile a "where month" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereMonth(Builder $query, $where)
|
|
{
|
|
return $this->dateBasedWhere('month', $query, $where);
|
|
}
|
|
|
|
/**
|
|
* Compile a "where year" clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereYear(Builder $query, $where)
|
|
{
|
|
return $this->dateBasedWhere('year', $query, $where);
|
|
}
|
|
|
|
/**
|
|
* Compile a date based where clause.
|
|
*
|
|
* @param string $type
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function dateBasedWhere($type, Builder $query, $where)
|
|
{
|
|
$value = $this->parameter($where['value']);
|
|
|
|
return $type.'('.$this->wrap($where['column']).') '.$where['operator'].' '.$value;
|
|
}
|
|
|
|
/**
|
|
* Compile a raw where clause.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $where
|
|
* @return string
|
|
*/
|
|
protected function whereRaw(Builder $query, $where)
|
|
{
|
|
return $where['sql'];
|
|
}
|
|
|
|
/**
|
|
* Compile the "group by" portions of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $groups
|
|
* @return string
|
|
*/
|
|
protected function compileGroups(Builder $query, $groups)
|
|
{
|
|
return 'group by '.$this->columnize($groups);
|
|
}
|
|
|
|
/**
|
|
* Compile the "having" portions of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $havings
|
|
* @return string
|
|
*/
|
|
protected function compileHavings(Builder $query, $havings)
|
|
{
|
|
$sql = implode(' ', array_map([$this, 'compileHaving'], $havings));
|
|
|
|
return 'having '.$this->removeLeadingBoolean($sql);
|
|
}
|
|
|
|
/**
|
|
* Compile a single having clause.
|
|
*
|
|
* @param array $having
|
|
* @return string
|
|
*/
|
|
protected function compileHaving(array $having)
|
|
{
|
|
// If the having clause is "raw", we can just return the clause straight away
|
|
// without doing any more processing on it. Otherwise, we will compile the
|
|
// clause into SQL based on the components that make it up from builder.
|
|
if ($having['type'] === 'raw') {
|
|
return $having['boolean'].' '.$having['sql'];
|
|
}
|
|
|
|
return $this->compileBasicHaving($having);
|
|
}
|
|
|
|
/**
|
|
* Compile a basic having clause.
|
|
*
|
|
* @param array $having
|
|
* @return string
|
|
*/
|
|
protected function compileBasicHaving($having)
|
|
{
|
|
$column = $this->wrap($having['column']);
|
|
|
|
$parameter = $this->parameter($having['value']);
|
|
|
|
return $having['boolean'].' '.$column.' '.$having['operator'].' '.$parameter;
|
|
}
|
|
|
|
/**
|
|
* Compile the "order by" portions of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $orders
|
|
* @return string
|
|
*/
|
|
protected function compileOrders(Builder $query, $orders)
|
|
{
|
|
return 'order by '.implode(', ', array_map(function ($order) {
|
|
if (isset($order['sql'])) {
|
|
return $order['sql'];
|
|
}
|
|
|
|
return $this->wrap($order['column']).' '.$order['direction'];
|
|
}, $orders));
|
|
}
|
|
|
|
/**
|
|
* Compile the "limit" portions of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param int $limit
|
|
* @return string
|
|
*/
|
|
protected function compileLimit(Builder $query, $limit)
|
|
{
|
|
return 'limit '.(int) $limit;
|
|
}
|
|
|
|
/**
|
|
* Compile the "offset" portions of the query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param int $offset
|
|
* @return string
|
|
*/
|
|
protected function compileOffset(Builder $query, $offset)
|
|
{
|
|
return 'offset '.(int) $offset;
|
|
}
|
|
|
|
/**
|
|
* Compile the "union" queries attached to the main query.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @return string
|
|
*/
|
|
protected function compileUnions(Builder $query)
|
|
{
|
|
$sql = '';
|
|
|
|
foreach ($query->unions as $union) {
|
|
$sql .= $this->compileUnion($union);
|
|
}
|
|
|
|
if (isset($query->unionOrders)) {
|
|
$sql .= ' '.$this->compileOrders($query, $query->unionOrders);
|
|
}
|
|
|
|
if (isset($query->unionLimit)) {
|
|
$sql .= ' '.$this->compileLimit($query, $query->unionLimit);
|
|
}
|
|
|
|
if (isset($query->unionOffset)) {
|
|
$sql .= ' '.$this->compileOffset($query, $query->unionOffset);
|
|
}
|
|
|
|
return ltrim($sql);
|
|
}
|
|
|
|
/**
|
|
* Compile a single union statement.
|
|
*
|
|
* @param array $union
|
|
* @return string
|
|
*/
|
|
protected function compileUnion(array $union)
|
|
{
|
|
$joiner = $union['all'] ? ' union all ' : ' union ';
|
|
|
|
return $joiner.$union['query']->toSql();
|
|
}
|
|
|
|
/**
|
|
* Compile an insert statement into SQL.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $values
|
|
* @return string
|
|
*/
|
|
public function compileInsert(Builder $query, array $values)
|
|
{
|
|
// Essentially we will force every insert to be treated as a batch insert which
|
|
// simply makes creating the SQL easier for us since we can utilize the same
|
|
// basic routine regardless of an amount of records given to us to insert.
|
|
$table = $this->wrapTable($query->from);
|
|
|
|
if (! is_array(reset($values))) {
|
|
$values = [$values];
|
|
}
|
|
|
|
$columns = $this->columnize(array_keys(reset($values)));
|
|
|
|
// We need to build a list of parameter place-holders of values that are bound
|
|
// to the query. Each insert should have the exact same amount of parameter
|
|
// bindings so we will loop through the record and parameterize them all.
|
|
$parameters = [];
|
|
|
|
foreach ($values as $record) {
|
|
$parameters[] = '('.$this->parameterize($record).')';
|
|
}
|
|
|
|
$parameters = implode(', ', $parameters);
|
|
|
|
return "insert into $table ($columns) values $parameters";
|
|
}
|
|
|
|
/**
|
|
* Compile an insert and get ID statement into SQL.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $values
|
|
* @param string $sequence
|
|
* @return string
|
|
*/
|
|
public function compileInsertGetId(Builder $query, $values, $sequence)
|
|
{
|
|
return $this->compileInsert($query, $values);
|
|
}
|
|
|
|
/**
|
|
* Compile an update statement into SQL.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param array $values
|
|
* @return string
|
|
*/
|
|
public function compileUpdate(Builder $query, $values)
|
|
{
|
|
$table = $this->wrapTable($query->from);
|
|
|
|
// Each one of the columns in the update statements needs to be wrapped in the
|
|
// keyword identifiers, also a place-holder needs to be created for each of
|
|
// the values in the list of bindings so we can make the sets statements.
|
|
$columns = [];
|
|
|
|
foreach ($values as $key => $value) {
|
|
$columns[] = $this->wrap($key).' = '.$this->parameter($value);
|
|
}
|
|
|
|
$columns = implode(', ', $columns);
|
|
|
|
// If the query has any "join" clauses, we will setup the joins on the builder
|
|
// and compile them so we can attach them to this update, as update queries
|
|
// can get join statements to attach to other tables when they're needed.
|
|
if (isset($query->joins)) {
|
|
$joins = ' '.$this->compileJoins($query, $query->joins);
|
|
} else {
|
|
$joins = '';
|
|
}
|
|
|
|
// Of course, update queries may also be constrained by where clauses so we'll
|
|
// need to compile the where clauses and attach it to the query so only the
|
|
// intended records are updated by the SQL statements we generate to run.
|
|
$where = $this->compileWheres($query);
|
|
|
|
return trim("update {$table}{$joins} set $columns $where");
|
|
}
|
|
|
|
/**
|
|
* Compile a delete statement into SQL.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @return string
|
|
*/
|
|
public function compileDelete(Builder $query)
|
|
{
|
|
$table = $this->wrapTable($query->from);
|
|
|
|
$where = is_array($query->wheres) ? $this->compileWheres($query) : '';
|
|
|
|
return trim("delete from $table ".$where);
|
|
}
|
|
|
|
/**
|
|
* Compile a truncate table statement into SQL.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @return array
|
|
*/
|
|
public function compileTruncate(Builder $query)
|
|
{
|
|
return ['truncate '.$this->wrapTable($query->from) => []];
|
|
}
|
|
|
|
/**
|
|
* Compile the lock into SQL.
|
|
*
|
|
* @param \Illuminate\Database\Query\Builder $query
|
|
* @param bool|string $value
|
|
* @return string
|
|
*/
|
|
protected function compileLock(Builder $query, $value)
|
|
{
|
|
return is_string($value) ? $value : '';
|
|
}
|
|
|
|
/**
|
|
* Concatenate an array of segments, removing empties.
|
|
*
|
|
* @param array $segments
|
|
* @return string
|
|
*/
|
|
protected function concatenate($segments)
|
|
{
|
|
return implode(' ', array_filter($segments, function ($value) {
|
|
return (string) $value !== '';
|
|
}));
|
|
}
|
|
|
|
/**
|
|
* Remove the leading boolean from a statement.
|
|
*
|
|
* @param string $value
|
|
* @return string
|
|
*/
|
|
protected function removeLeadingBoolean($value)
|
|
{
|
|
return preg_replace('/and |or /', '', $value, 1);
|
|
}
|
|
}
|