Documentation

Grammar
in package

Table of Contents

$tablePrefix  : string
The grammar table prefix.
columnize()  : string
Convert an array of column names into a delimited string.
getDateFormat()  : string
Get the format for database stored dates.
getTablePrefix()  : string
Get the grammar's table prefix.
getValue()  : string
Get the value of a raw expression.
isExpression()  : bool
Determine if the given value is a raw expression.
parameter()  : string
Get the appropriate query parameter place-holder for a value.
parameterize()  : string
Create query parameter place-holders for an array.
setTablePrefix()  : $this
Set the grammar's table prefix.
wrap()  : string
Wrap a value in keyword identifiers.
wrapArray()  : array<string|int, mixed>
Wrap an array of values.
wrapTable()  : string
Wrap a table in keyword identifiers.
wrapAliasedValue()  : string
Wrap a value that has an alias.
wrapSegments()  : string
Wrap the given value segments.
wrapValue()  : string
Wrap a single string in keyword identifiers.

Properties

$tablePrefix

The grammar table prefix.

protected string $tablePrefix = ''

Methods

columnize()

Convert an array of column names into a delimited string.

public columnize(array<string|int, mixed> $columns) : string
Parameters
$columns : array<string|int, mixed>
Return values
string

getDateFormat()

Get the format for database stored dates.

public getDateFormat() : string
Return values
string

getTablePrefix()

Get the grammar's table prefix.

public getTablePrefix() : string
Return values
string

getValue()

Get the value of a raw expression.

public getValue(Expression $expression) : string
Parameters
$expression : Expression
Return values
string

isExpression()

Determine if the given value is a raw expression.

public isExpression(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

parameter()

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

public parameter(mixed $value) : string
Parameters
$value : mixed
Return values
string

parameterize()

Create query parameter place-holders for an array.

public parameterize(array<string|int, mixed> $values) : string
Parameters
$values : array<string|int, mixed>
Return values
string

setTablePrefix()

Set the grammar's table prefix.

public setTablePrefix(string $prefix) : $this
Parameters
$prefix : string
Return values
$this

wrap()

Wrap a value in keyword identifiers.

public wrap(Expression|string $value[, bool $prefixAlias = false ]) : string
Parameters
$value : Expression|string
$prefixAlias : bool = false
Return values
string

wrapArray()

Wrap an array of values.

public wrapArray(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
$values : array<string|int, mixed>
Return values
array<string|int, mixed>

wrapTable()

Wrap a table in keyword identifiers.

public wrapTable(Expression|string $table) : string
Parameters
$table : Expression|string
Return values
string

wrapAliasedValue()

Wrap a value that has an alias.

protected wrapAliasedValue(string $value[, bool $prefixAlias = false ]) : string
Parameters
$value : string
$prefixAlias : bool = false
Return values
string

wrapSegments()

Wrap the given value segments.

protected wrapSegments(array<string|int, mixed> $segments) : string
Parameters
$segments : array<string|int, mixed>
Return values
string

wrapValue()

Wrap a single string in keyword identifiers.

protected wrapValue(string $value) : string
Parameters
$value : string
Return values
string

Search results