Grammar

class Grammar extends Grammar (View source)

Properties

protected string $tablePrefix The grammar table prefix. from Grammar

Methods

array wrapArray(array $values)

Wrap an array of values.

 from Grammar
string wrapTable(string $table)

Wrap a table in keyword identifiers.
string wrap(string $value)

Wrap a value in keyword identifiers.
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 getValue(Expression $expression)

Get the value of a raw expression.

 from Grammar
bool isExpression(mixed $value)

Determine if the given value is 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
array compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)

Compile a rename column command.
TableDiff getRenamedDiff(Blueprint $blueprint, Fluent $command, Column $column, AbstractSchemaManager $schema)

Get a new column instance with the new column name.
TableDiff setRenamedColumns(TableDiff $tableDiff, Fluent $command, Column $column)

Set the renamed columns on the table diff.
string compileForeign(Blueprint $blueprint, Fluent $command)

Compile a foreign key command.
array getColumns(Blueprint $blueprint)

Compile the blueprint's column definitions.
string addModifiers(string $sql, Blueprint $blueprint, Fluent $column)

Add the column modifiers to the definition.
Fluent|null getCommandByName(Blueprint $blueprint, string $name)

Get the primary key command if it exists on the blueprint.
array getCommandsByName(Blueprint $blueprint, string $name)

Get all of the commands with a given name.
string getType(Fluent $column)

Get the SQL for the column data type.
array prefixArray(string $prefix, array $values)

Add a prefix to an array of values.
string getDefaultValue(mixed $value)

Format a value so that it can be used in "default" clauses.
TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Create an empty Doctrine DBAL TableDiff from the Blueprint.

Details

array wrapArray(array $values)

Wrap an array of values.

Parameters

array $values

Return Value

array

string wrapTable(string $table)

Wrap a table in keyword identifiers.

Parameters

string $table

Return Value

string

string wrap(string $value)

Wrap a value in keyword identifiers.

Parameters

string $value

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 getValue(Expression $expression)

Get the value of a raw expression.

Parameters

Expression $expression

Return Value

string

bool isExpression(mixed $value)

Determine if the given value is a raw expression.

Parameters

mixed $value

Return Value

bool

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

array compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)

Compile a rename column command.

Parameters

Blueprint $blueprint
Fluent $command
Connection $connection

Return Value

array

protected TableDiff getRenamedDiff(Blueprint $blueprint, Fluent $command, Column $column, AbstractSchemaManager $schema)

Get a new column instance with the new column name.

Parameters

Blueprint $blueprint
Fluent $command
Column $column
AbstractSchemaManager $schema

Return Value

TableDiff

protected TableDiff setRenamedColumns(TableDiff $tableDiff, Fluent $command, Column $column)

Set the renamed columns on the table diff.

Parameters

TableDiff $tableDiff
Fluent $command
Column $column

Return Value

TableDiff

string compileForeign(Blueprint $blueprint, Fluent $command)

Compile a foreign key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

protected array getColumns(Blueprint $blueprint)

Compile the blueprint's column definitions.

Parameters

Blueprint $blueprint

Return Value

array

protected string addModifiers(string $sql, Blueprint $blueprint, Fluent $column)

Add the column modifiers to the definition.

Parameters

string $sql
Blueprint $blueprint
Fluent $column

Return Value

string

protected Fluent|null getCommandByName(Blueprint $blueprint, string $name)

Get the primary key command if it exists on the blueprint.

Parameters

Blueprint $blueprint
string $name

Return Value

Fluent|null

protected array getCommandsByName(Blueprint $blueprint, string $name)

Get all of the commands with a given name.

Parameters

Blueprint $blueprint
string $name

Return Value

array

protected string getType(Fluent $column)

Get the SQL for the column data type.

Parameters

Fluent $column

Return Value

string

array prefixArray(string $prefix, array $values)

Add a prefix to an array of values.

Parameters

string $prefix
array $values

Return Value

array

protected string getDefaultValue(mixed $value)

Format a value so that it can be used in "default" clauses.

Parameters

mixed $value

Return Value

string

protected TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Create an empty Doctrine DBAL TableDiff from the Blueprint.

Parameters

Blueprint $blueprint
AbstractSchemaManager $schema

Return Value

TableDiff

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