Grammar

class Grammar extends Grammar (View source)

Traits

Macroable

Properties

static protected array $macros The registered string macros. from Macroable
protected string $tablePrefix The grammar table prefix. from Grammar
protected array $operators The grammar specific operators.
protected array $selectComponents The components that make up a select clause.

Methods

static void macro(string $name, object|callable $macro)

Register a custom macro.

 from Macroable
static void mixin(object $mixin)

Mix another object into the class.

 from Macroable
static bool hasMacro(string $name)

Checks if macro is registered.

 from Macroable
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

 from Macroable
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

 from Macroable
array wrapArray(array $values)

Wrap an array of values.

 from Grammar
string wrapTable(Expression|string $table)

Wrap a table in keyword identifiers.

 from Grammar
string wrap(Expression|string $value, bool $prefixAlias = false)

Wrap a value in keyword identifiers.
string wrapAliasedValue(string $value, bool $prefixAlias = false)

Wrap a value that has an alias.

 from Grammar
string wrapSegments(array $segments)

Wrap the given value segments.

 from Grammar
string wrapValue(string $value)

Wrap a single string in keyword identifiers.

 from Grammar
string columnize(array $columns)

Convert an array of column names into a delimited string.

 from Grammar
string parameterize(array $values)

Create query parameter place-holders for an array.

 from Grammar
string parameter(mixed $value)

Get the appropriate query parameter place-holder for a value.

 from Grammar
string quoteString(string|array $value)

Quote the given string literal.

 from Grammar
bool isExpression(mixed $value)

Determine if the given value is a raw expression.

 from Grammar
string getValue(Expression $expression)

Get the value of a raw expression.

 from Grammar
string getDateFormat()

Get the format for database stored dates.

 from Grammar
string getTablePrefix()

Get the grammar's table prefix.

 from Grammar
$this setTablePrefix(string $prefix)

Set the grammar's table prefix.

 from Grammar
string compileSelect(Builder $query)

Compile a select query into SQL.
array compileComponents(Builder $query)

Compile the components necessary for a select clause.
string compileAggregate(Builder $query, array $aggregate)

Compile an aggregated select clause.
string|null compileColumns(Builder $query, array $columns)

Compile the "select *" portion of the query.
string compileFrom(Builder $query, string $table)

Compile the "from" portion of the query.
string compileJoins(Builder $query, array $joins)

Compile the "join" portions of the query.
string compileWheres(Builder $query)

Compile the "where" portions of the query.
array compileWheresToArray(Builder $query)

Get an array of all the where clauses for the query.
string concatenateWhereClauses(Builder $query, array $sql)

Format the where clause statements into one string.
string whereRaw(Builder $query, array $where)

Compile a raw where clause.
string whereBasic(Builder $query, array $where)

Compile a basic where clause.
string whereIn(Builder $query, array $where)

Compile a "where in" clause.
string whereNotIn(Builder $query, array $where)

Compile a "where not in" clause.
string whereInSub(Builder $query, array $where)

Compile a where in sub-select clause.
string whereNotInSub(Builder $query, array $where)

Compile a where not in sub-select clause.
string whereNull(Builder $query, array $where)

Compile a "where null" clause.
string whereNotNull(Builder $query, array $where)

Compile a "where not null" clause.
string whereBetween(Builder $query, array $where)

Compile a "between" where clause.
string whereDate(Builder $query, array $where)

Compile a "where date" clause.
string whereTime(Builder $query, array $where)

Compile a "where time" clause.
string whereDay(Builder $query, array $where)

Compile a "where day" clause.
string whereMonth(Builder $query, array $where)

Compile a "where month" clause.
string whereYear(Builder $query, array $where)

Compile a "where year" clause.
string dateBasedWhere(string $type, Builder $query, array $where)

Compile a date based where clause.
string whereColumn(Builder $query, array $where)

Compile a where clause comparing two columns.
string whereNested(Builder $query, array $where)

Compile a nested where clause.
string whereSub(Builder $query, array $where)

Compile a where condition with a sub-select.
string whereExists(Builder $query, array $where)

Compile a where exists clause.
string whereNotExists(Builder $query, array $where)

Compile a where exists clause.
string whereRowValues(Builder $query, array $where)

Compile a where row values condition.
string whereJsonContains(Builder $query, array $where)

Compile a "where JSON contains" clause.
string compileJsonContains(string $column, string $value)

Compile a "JSON contains" statement into SQL.
string prepareBindingForJsonContains(mixed $binding)

Prepare the binding for a "JSON contains" statement.
string whereJsonLength(Builder $query, array $where)

Compile a "where JSON length" clause.
string compileJsonLength(string $column, string $operator, string $value)

Compile a "JSON length" statement into SQL.
string compileGroups(Builder $query, array $groups)

Compile the "group by" portions of the query.
string compileHavings(Builder $query, array $havings)

Compile the "having" portions of the query.
string compileHaving(array $having)

Compile a single having clause.
string compileBasicHaving(array $having)

Compile a basic having clause.
string compileOrders(Builder $query, array $orders)

Compile the "order by" portions of the query.
array compileOrdersToArray(Builder $query, array $orders)

Compile the query orders to an array.
string compileRandom(string $seed)

Compile the random statement into SQL.
string compileLimit(Builder $query, int $limit)

Compile the "limit" portions of the query.
string compileOffset(Builder $query, int $offset)

Compile the "offset" portions of the query.
string compileUnions(Builder $query)

Compile the "union" queries attached to the main query.
string compileUnion(array $union)

Compile a single union statement.
string compileExists(Builder $query)

Compile an exists statement into SQL.
string compileInsert(Builder $query, array $values)

Compile an insert statement into SQL.
string compileInsertGetId(Builder $query, array $values, string $sequence)

Compile an insert and get ID statement into SQL.
string compileUpdate(Builder $query, array $values)

Compile an update statement into SQL.
array prepareBindingsForUpdate(array $bindings, array $values)

Prepare the bindings for an update statement.
string compileDelete(Builder $query)

Compile a delete statement into SQL.
array prepareBindingsForDelete(array $bindings)

Prepare the bindings for a delete statement.
array compileTruncate(Builder $query)

Compile a truncate table statement into SQL.
string compileLock(Builder $query, bool|string $value)

Compile the lock into SQL.
bool supportsSavepoints()

Determine if the grammar supports savepoints.
string compileSavepoint(string $name)

Compile the SQL statement to define a savepoint.
string compileSavepointRollBack(string $name)

Compile the SQL statement to execute a savepoint rollback.
string wrapJsonSelector(string $value)

Wrap the given JSON selector.
array wrapJsonFieldAndPath(string $column)

Split the given JSON selector into the field and the optional path and wrap them separately.
string wrapJsonPath(string $value)

Wrap the given JSON path.
bool isJsonSelector(string $value)

Determine if the given string is a JSON selector.
string concatenate(array $segments)

Concatenate an array of segments, removing empties.
string removeLeadingBoolean(string $value)

Remove the leading boolean from a statement.
array getOperators()

Get the grammar specific operators.

Details

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

array wrapArray(array $values)

Wrap an array of values.

Parameters

array $values

Return Value

array

string wrapTable(Expression|string $table)

Wrap a table in keyword identifiers.

Parameters

Expression|string $table

Return Value

string

string wrap(Expression|string $value, bool $prefixAlias = false)

Wrap a value in keyword identifiers.

Parameters

Expression|string $value
bool $prefixAlias

Return Value

string

protected string wrapAliasedValue(string $value, bool $prefixAlias = false)

Wrap a value that has an alias.

Parameters

string $value
bool $prefixAlias

Return Value

string

protected string wrapSegments(array $segments)

Wrap the given value segments.

Parameters

array $segments

Return Value

string

protected string wrapValue(string $value)

Wrap a single string in keyword identifiers.

Parameters

string $value

Return Value

string

string columnize(array $columns)

Convert an array of column names into a delimited string.

Parameters

array $columns

Return Value

string

string parameterize(array $values)

Create query parameter place-holders for an array.

Parameters

array $values

Return Value

string

string parameter(mixed $value)

Get the appropriate query parameter place-holder for a value.

Parameters

mixed $value

Return Value

string

string quoteString(string|array $value)

Quote the given string literal.

Parameters

string|array $value

Return Value

string

bool isExpression(mixed $value)

Determine if the given value is a raw expression.

Parameters

mixed $value

Return Value

bool

string getValue(Expression $expression)

Get the value of a raw expression.

Parameters

Expression $expression

Return Value

string

string getDateFormat()

Get the format for database stored dates.

Return Value

string

string getTablePrefix()

Get the grammar's table prefix.

Return Value

string

$this setTablePrefix(string $prefix)

Set the grammar's table prefix.

Parameters

string $prefix

Return Value

$this

string compileSelect(Builder $query)

Compile a select query into SQL.

Parameters

Builder $query

Return Value

string

protected array compileComponents(Builder $query)

Compile the components necessary for a select clause.

Parameters

Builder $query

Return Value

array

protected string compileAggregate(Builder $query, array $aggregate)

Compile an aggregated select clause.

Parameters

Builder $query
array $aggregate

Return Value

string

protected string|null compileColumns(Builder $query, array $columns)

Compile the "select *" portion of the query.

Parameters

Builder $query
array $columns

Return Value

string|null

protected string compileFrom(Builder $query, string $table)

Compile the "from" portion of the query.

Parameters

Builder $query
string $table

Return Value

string

protected string compileJoins(Builder $query, array $joins)

Compile the "join" portions of the query.

Parameters

Builder $query
array $joins

Return Value

string

protected string compileWheres(Builder $query)

Compile the "where" portions of the query.

Parameters

Builder $query

Return Value

string

protected array compileWheresToArray(Builder $query)

Get an array of all the where clauses for the query.

Parameters

Builder $query

Return Value

array

protected string concatenateWhereClauses(Builder $query, array $sql)

Format the where clause statements into one string.

Parameters

Builder $query
array $sql

Return Value

string

protected string whereRaw(Builder $query, array $where)

Compile a raw where clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereBasic(Builder $query, array $where)

Compile a basic where clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereIn(Builder $query, array $where)

Compile a "where in" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotIn(Builder $query, array $where)

Compile a "where not in" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereInSub(Builder $query, array $where)

Compile a where in sub-select clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotInSub(Builder $query, array $where)

Compile a where not in sub-select clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNull(Builder $query, array $where)

Compile a "where null" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotNull(Builder $query, array $where)

Compile a "where not null" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereBetween(Builder $query, array $where)

Compile a "between" where clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereDate(Builder $query, array $where)

Compile a "where date" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereTime(Builder $query, array $where)

Compile a "where time" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereDay(Builder $query, array $where)

Compile a "where day" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereMonth(Builder $query, array $where)

Compile a "where month" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereYear(Builder $query, array $where)

Compile a "where year" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string dateBasedWhere(string $type, Builder $query, array $where)

Compile a date based where clause.

Parameters

string $type
Builder $query
array $where

Return Value

string

protected string whereColumn(Builder $query, array $where)

Compile a where clause comparing two columns.

.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNested(Builder $query, array $where)

Compile a nested where clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereSub(Builder $query, array $where)

Compile a where condition with a sub-select.

Parameters

Builder $query
array $where

Return Value

string

protected string whereExists(Builder $query, array $where)

Compile a where exists clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotExists(Builder $query, array $where)

Compile a where exists clause.

Parameters

Builder $query
array $where

Return Value

string

protected string whereRowValues(Builder $query, array $where)

Compile a where row values condition.

Parameters

Builder $query
array $where

Return Value

string

protected string whereJsonContains(Builder $query, array $where)

Compile a "where JSON contains" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string compileJsonContains(string $column, string $value)

Compile a "JSON contains" statement into SQL.

Parameters

string $column
string $value

Return Value

string

Exceptions

RuntimeException

string prepareBindingForJsonContains(mixed $binding)

Prepare the binding for a "JSON contains" statement.

Parameters

mixed $binding

Return Value

string

protected string whereJsonLength(Builder $query, array $where)

Compile a "where JSON length" clause.

Parameters

Builder $query
array $where

Return Value

string

protected string compileJsonLength(string $column, string $operator, string $value)

Compile a "JSON length" statement into SQL.

Parameters

string $column
string $operator
string $value

Return Value

string

Exceptions

RuntimeException

protected string compileGroups(Builder $query, array $groups)

Compile the "group by" portions of the query.

Parameters

Builder $query
array $groups

Return Value

string

protected string compileHavings(Builder $query, array $havings)

Compile the "having" portions of the query.

Parameters

Builder $query
array $havings

Return Value

string

protected string compileHaving(array $having)

Compile a single having clause.

Parameters

array $having

Return Value

string

protected string compileBasicHaving(array $having)

Compile a basic having clause.

Parameters

array $having

Return Value

string

protected string compileOrders(Builder $query, array $orders)

Compile the "order by" portions of the query.

Parameters

Builder $query
array $orders

Return Value

string

protected array compileOrdersToArray(Builder $query, array $orders)

Compile the query orders to an array.

Parameters

Builder $query
array $orders

Return Value

array

string compileRandom(string $seed)

Compile the random statement into SQL.

Parameters

string $seed

Return Value

string

protected string compileLimit(Builder $query, int $limit)

Compile the "limit" portions of the query.

Parameters

Builder $query
int $limit

Return Value

string

protected string compileOffset(Builder $query, int $offset)

Compile the "offset" portions of the query.

Parameters

Builder $query
int $offset

Return Value

string

protected string compileUnions(Builder $query)

Compile the "union" queries attached to the main query.

Parameters

Builder $query

Return Value

string

protected string compileUnion(array $union)

Compile a single union statement.

Parameters

array $union

Return Value

string

string compileExists(Builder $query)

Compile an exists statement into SQL.

Parameters

Builder $query

Return Value

string

string compileInsert(Builder $query, array $values)

Compile an insert statement into SQL.

Parameters

Builder $query
array $values

Return Value

string

string compileInsertGetId(Builder $query, array $values, string $sequence)

Compile an insert and get ID statement into SQL.

Parameters

Builder $query
array $values
string $sequence

Return Value

string

string compileUpdate(Builder $query, array $values)

Compile an update statement into SQL.

Parameters

Builder $query
array $values

Return Value

string

array prepareBindingsForUpdate(array $bindings, array $values)

Prepare the bindings for an update statement.

Parameters

array $bindings
array $values

Return Value

array

string compileDelete(Builder $query)

Compile a delete statement into SQL.

Parameters

Builder $query

Return Value

string

array prepareBindingsForDelete(array $bindings)

Prepare the bindings for a delete statement.

Parameters

array $bindings

Return Value

array

array compileTruncate(Builder $query)

Compile a truncate table statement into SQL.

Parameters

Builder $query

Return Value

array

protected string compileLock(Builder $query, bool|string $value)

Compile the lock into SQL.

Parameters

Builder $query
bool|string $value

Return Value

string

bool supportsSavepoints()

Determine if the grammar supports savepoints.

Return Value

bool

string compileSavepoint(string $name)

Compile the SQL statement to define a savepoint.

Parameters

string $name

Return Value

string

string compileSavepointRollBack(string $name)

Compile the SQL statement to execute a savepoint rollback.

Parameters

string $name

Return Value

string

protected string wrapJsonSelector(string $value)

Wrap the given JSON selector.

Parameters

string $value

Return Value

string

protected array wrapJsonFieldAndPath(string $column)

Split the given JSON selector into the field and the optional path and wrap them separately.

Parameters

string $column

Return Value

array

protected string wrapJsonPath(string $value)

Wrap the given JSON path.

Parameters

string $value

Return Value

string

protected bool isJsonSelector(string $value)

Determine if the given string is a JSON selector.

Parameters

string $value

Return Value

bool

protected string concatenate(array $segments)

Concatenate an array of segments, removing empties.

Parameters

array $segments

Return Value

string

protected string removeLeadingBoolean(string $value)

Remove the leading boolean from a statement.

Parameters

string $value

Return Value

string

array getOperators()

Get the grammar specific operators.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Database/Query/Grammars/Grammar.html