Grammar
abstract class Grammar (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Connection | $connection | The connection used for escaping values. |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Wrap an array of values.
Wrap a table in keyword identifiers.
Wrap a value that has an alias.
Wrap a table that has an alias.
Wrap the given value segments.
Wrap a single string in keyword identifiers.
Wrap the given JSON selector.
Determine if the given string is a JSON selector.
Convert an array of column names into a delimited string.
Create query parameter place-holders for an array.
Get the appropriate query parameter place-holder for a value.
Quote the given string literal.
Escapes a value for safe SQL embedding.
Determine if the given value is a raw expression.
Get the format for database stored dates.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
__construct(Connection $connection)
Create a new grammar instance.
string[]
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.
protected string
wrapAliasedValue(string $value)
Wrap a value that has an alias.
protected string
wrapAliasedTable(string $value, string|null $prefix = null)
Wrap a table that has an alias.
protected string
wrapSegments(list<string> $segments)
Wrap the given value segments.
protected string
wrapValue(string $value)
Wrap a single string in keyword identifiers.
protected string
wrapJsonSelector(string $value)
Wrap the given JSON selector.
protected 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|string[] $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
deprecated
Get the grammar's table prefix.
$this
setTablePrefix(string $prefix)
deprecated
deprecated
Set the grammar's table prefix.
Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.