Docs4dev
Docs
laravel / 10 / api / 10.x / illuminate / database / grammar.html

Grammar

abstract class Grammar (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from Macroable
protected Connection $connection

The connection used for escaping values.
protected string $tablePrefix

The grammar table prefix.

Methods

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

Register a custom macro.

 from Macroable
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

 from Macroable
static bool hasMacro(string $name)

Checks if macro is registered.

 from Macroable
static void flushMacros()

Flush the existing macros.

 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.
string wrapTable(Expression|string $table)

Wrap a table in keyword identifiers.
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.
string wrapSegments(array $segments)

Wrap the given value segments.
string wrapValue(string $value)

Wrap a single string in keyword identifiers.
string wrapJsonSelector(string $value)

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

Determine if the given string is a JSON selector.
string columnize(array $columns)

Convert an array of column names into a delimited string.
string parameterize(array $values)

Create query parameter place-holders for an array.
string parameter(mixed $value)

Get the appropriate query parameter place-holder for a value.
string quoteString(string|array $value)

Quote the given string literal.
string escape(string|float|int|bool|null $value, bool $binary = false)

Escapes a value for safe SQL embedding.
bool isExpression(mixed $value)

Determine if the given value is a raw expression.
string|int|float getValue(Expression|string|int|float $expression)

Transforms expressions to their scalar types.
string getDateFormat()

Get the format for database stored dates.
string getTablePrefix()

Get the grammar's table prefix.
$this setTablePrefix(string $prefix)

Set the grammar's table prefix.
$this setConnection($connection)

Set the grammar's database connection.

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, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

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

protected string wrapJsonSelector(string $value)

Wrap the given JSON selector.

Parameters

string $value

Return Value

string

Exceptions

RuntimeException

protected bool isJsonSelector(string $value)

Determine if the given string is a JSON selector.

Parameters

string $value

Return Value

bool

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

string escape(string|float|int|bool|null $value, bool $binary = false)

Escapes a value for safe SQL embedding.

Parameters

string|float|int|bool|null $value
bool $binary

Return Value

string

bool isExpression(mixed $value)

Determine if the given value is a raw expression.

Parameters

mixed $value

Return Value

bool

string|int|float getValue(Expression|string|int|float $expression)

Transforms expressions to their scalar types.

Parameters

Expression|string|int|float $expression

Return Value

string|int|float

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

$this setConnection($connection)

Set the grammar's database connection.

Parameters

$connection

Return Value

$this

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