Grammar
class Grammar extends Grammar (View source)
Properties
| protected string | $tablePrefix | The grammar table prefix. | from Grammar |
| protected bool | $transactions | If this Grammar supports schema changes wrapped in a transaction. |
Methods
| array | wrapArray(array $values) Wrap an array of values. | from Grammar |
| 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 | 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. | |
| array | compileChange(Blueprint $blueprint, Fluent $command, Connection $connection) Compile a change column command into a series of SQL statements. | |
| TableDiff|bool | getChangedDiff(Blueprint $blueprint, AbstractSchemaManager $schema) Get the Doctrine table difference for the given changes. | |
| TableDiff | getTableWithColumnChanges(Blueprint $blueprint, Table $table) Get a copy of the given Doctrine table after making the column changes. | |
| Column | getDoctrineColumnForChange(Table $table, Fluent $fluent) Get the Doctrine column instance for a column change. | |
| array | getDoctrineColumnChangeOptions(Fluent $fluent) Get the Doctrine column change options. | |
| Type | getDoctrineColumnType(string $type) Get the doctrine column type. | |
| int | calculateDoctrineTextLength(string $type) Calculate the proper column length to force the Doctrine text type. | |
| string|null | mapFluentOptionToDoctrine(string $attribute) Get the matching Doctrine option for a given Fluent attribute name. | |
| mixed | mapFluentValueToDoctrine(string $option, mixed $value) Get the matching Doctrine value for a given Fluent attribute. | |
| bool | supportsSchemaTransactions() Check if this Grammar supports schema changes wrapped in a transaction. |
Details
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.
protected string wrapValue(string $value)
Wrap a single string in keyword identifiers.
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 getValue(Expression $expression)
Get the value of a raw expression.
bool isExpression(mixed $value)
Determine if the given value is a raw expression.
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.
array compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)
Compile a rename column command.
protected TableDiff getRenamedDiff(Blueprint $blueprint, Fluent $command, Column $column, AbstractSchemaManager $schema)
Get a new column instance with the new column name.
protected TableDiff setRenamedColumns(TableDiff $tableDiff, Fluent $command, Column $column)
Set the renamed columns on the table diff.
protected array getColumns(Blueprint $blueprint)
Compile the blueprint's column definitions.
protected string addModifiers(string $sql, Blueprint $blueprint, Fluent $column)
Add the column modifiers to the definition.
protected Fluent|null getCommandByName(Blueprint $blueprint, string $name)
Get the primary key command if it exists on the blueprint.
protected array getCommandsByName(Blueprint $blueprint, string $name)
Get all of the commands with a given name.
protected 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.
protected string getDefaultValue(mixed $value)
Format a value so that it can be used in "default" clauses.
protected TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)
Create an empty Doctrine DBAL TableDiff from the Blueprint.
array compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)
Compile a change column command into a series of SQL statements.
protected TableDiff|bool getChangedDiff(Blueprint $blueprint, AbstractSchemaManager $schema)
Get the Doctrine table difference for the given changes.
protected TableDiff getTableWithColumnChanges(Blueprint $blueprint, Table $table)
Get a copy of the given Doctrine table after making the column changes.
protected Column getDoctrineColumnForChange(Table $table, Fluent $fluent)
Get the Doctrine column instance for a column change.
protected array getDoctrineColumnChangeOptions(Fluent $fluent)
Get the Doctrine column change options.
protected Type getDoctrineColumnType(string $type)
Get the doctrine column type.
protected int calculateDoctrineTextLength(string $type)
Calculate the proper column length to force the Doctrine text type.
protected string|null mapFluentOptionToDoctrine(string $attribute)
Get the matching Doctrine option for a given Fluent attribute name.
protected mixed mapFluentValueToDoctrine(string $option, mixed $value)
Get the matching Doctrine value for a given Fluent attribute.
bool supportsSchemaTransactions()
Check if this Grammar supports schema changes wrapped in a transaction.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Schema/Grammars/Grammar.html