1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Grammar

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.

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
__construct(Connection $connection)

Create a new grammar instance.

array
wrapArray(array $values)

Wrap an array of values.

string
wrapTable(Expression|string $table, string|null $prefix = null)

Wrap a table in keyword identifiers.

string
wrap(Expression|string $value)

Wrap a value in keyword identifiers.

string
wrapAliasedValue(string $value)

Wrap a value that has an alias.

string
wrapAliasedTable(string $value, string|null $prefix = null)

Wrap a table 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() deprecated

Get the grammar's table prefix.

$this
setTablePrefix(string $prefix) deprecated

Set the grammar's table prefix.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 26
__construct(Connection $connection)

Create a new grammar instance.

Parameters

Connection $connection

at line 37
array wrapArray(array $values)

Wrap an array of values.

Parameters

array $values

Return Value

array

at line 49
string wrapTable(Expression|string $table, string|null $prefix = null)

Wrap a table in keyword identifiers.

Parameters

Expression|string $table
string|null $prefix

Return Value

string

at line 84
string wrap(Expression|string $value)

Wrap a value in keyword identifiers.

Parameters

Expression|string $value

Return Value

string

at line 113
protected string wrapAliasedValue(string $value)

Wrap a value that has an alias.

Parameters

string $value

Return Value

string

at line 127
protected string wrapAliasedTable(string $value, string|null $prefix = null)

Wrap a table that has an alias.

Parameters

string $value
string|null $prefix

Return Value

string

at line 142
protected string wrapSegments(array $segments)

Wrap the given value segments.

Parameters

array $segments

Return Value

string

at line 157
protected string wrapValue(string $value)

Wrap a single string in keyword identifiers.

Parameters

string $value

Return Value

string

at line 174
protected string wrapJsonSelector(string $value)

Wrap the given JSON selector.

Parameters

string $value

Return Value

string

Exceptions

RuntimeException

at line 185
protected bool isJsonSelector(string $value)

Determine if the given string is a JSON selector.

Parameters

string $value

Return Value

bool

at line 196
string columnize(array $columns)

Convert an array of column names into a delimited string.

Parameters

array $columns

Return Value

string

at line 207
string parameterize(array $values)

Create query parameter place-holders for an array.

Parameters

array $values

Return Value

string

at line 218
string parameter(mixed $value)

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

Parameters

mixed $value

Return Value

string

at line 229
string quoteString(string|array $value)

Quote the given string literal.

Parameters

string|array $value

Return Value

string

at line 245
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

at line 256
bool isExpression(mixed $value)

Determine if the given value is a raw expression.

Parameters

mixed $value

Return Value

bool

at line 267
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

at line 281
string getDateFormat()

Get the format for database stored dates.

Return Value

string

at line 293
string getTablePrefix() deprecated

deprecated Use DB::getTablePrefix()

Get the grammar's table prefix.

Return Value

string

at line 306
$this setTablePrefix(string $prefix) deprecated

deprecated Use DB::setTablePrefix()

Set the grammar's table prefix.

Parameters

string $prefix

Return Value

$this