Грамматика

абстрактный класс Грамматика расширяет Грамматика (Просмотреть исходный код)

Трейты

Свойства

статический защищенный массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищенная строка	$tablePrefix	Префикс таблицы грамматики.	из Грамматика
защищенная логическая переменная	$transactions	Поддерживает ли эта грамматика изменения схемы, заключенные в транзакцию.
защищенный массив	$fluentCommands	Команды, которые будут выполняться вне команды создания или изменения.

Методы

static void

macro(string $name, object|callable $macro)

Зарегистрировать пользовательскую макрокоманду.

из Macroable

static void

mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

из Macroable

static bool

hasMacro(string $name)

Проверить, зарегистрирована ли макрокоманда.

из Macroable

static mixed

__callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

из Macroable

mixed

__call(string $method, array $parameters)

Динамически обработать вызовы к классу.

из Macroable

array

wrapArray(array $values)

Оборачивает массив значений.

из Grammar

string

wrapTable(Expression|string $table)

Оборачивает таблицу в ключевые идентификаторы.

string

wrap(Expression|string $value, bool $prefixAlias = false)

Оборачивает значение в ключевые идентификаторы.

string

wrapAliasedValue(string $value, bool $prefixAlias = false)

Оборачивает значение с алиасом.

из Grammar

string

wrapSegments(array $segments)

Оборачивает заданные сегменты значений.

из Grammar

string

wrapValue(string $value)

Оборачивает отдельную строку в ключевые идентификаторы.

из Grammar

string

columnize(array $columns)

Преобразовать массив имён столбцов в строку с разделителями.

из Grammar

string

parameterize(array $values)

Создать маркеры параметров запроса для массива.

из Grammar

string

parameter(mixed $value)

Получить соответствующий маркер параметра запроса для значения.

из Grammar

string

quoteString(string|array $value)

Процитировать заданную строку-литерал.

из Grammar

bool

isExpression(mixed $value)

Определить, является ли заданное значение выражением.

из Grammar

string

getValue(Expression $expression)

Получить значение выражения.

из Grammar

string

getDateFormat()

Получить формат дат, хранящихся в базе данных.

из Grammar

string

getTablePrefix()

Получить префикс таблицы грамматики.

из Grammar

$this

setTablePrefix(string $prefix)

Установить префикс таблицы грамматики.

из Grammar

array

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

Компилировать команду переименования столбца.

array

compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилировать команду изменения столбца в серию SQL-запросов.

string

compileForeign(Blueprint $blueprint, Fluent $command)

Компилировать команду внешнего ключа.

array

getColumns(Blueprint $blueprint)

Компилировать определения столбцов из чертежа.

string

getType(Fluent $column)

Получить SQL для типа данных столбца.

void

typeComputed(Fluent $column)

Создать определение столбца для вычисляемого типа столбца.

string

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

Добавить модификаторы столбца к определению.

Fluent|null

getCommandByName(Blueprint $blueprint, string $name)

Получить команду первичного ключа, если она существует в чертеже.

array

getCommandsByName(Blueprint $blueprint, string $name)

Получить все команды с заданным именем.

array

prefixArray(string $prefix, array $values)

Добавить префикс к массиву значений.

string

getDefaultValue(mixed $value)

Отформатировать значение, чтобы его можно было использовать в "default" операторах.

TableDiff

getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Создать пустой Doctrine DBAL TableDiff из чертежа.

array

getFluentCommands()

Получить команды fluent для грамматики.

bool

supportsSchemaTransactions()

Проверить, поддерживает ли эта грамматика изменения схемы в транзакции.

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макрос.

Параметры

string	$name
object\|callable	$macro

Возвращаемое значение

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрировано ли макрос.

Параметры

string

$name

Возвращаемое значение

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

array wrapArray(array $values)

Оборачивает массив значений.

Параметры

array

$values

Возвращаемое значение

array

string wrapTable(Expression|string $table)

Оборачивает таблицу в идентификаторы ключевых слов.

Параметры

Expression|string

$table

Возвращаемое значение

string

string wrap(Expression|string $value, bool $prefixAlias = false)

Оборачивает значение в идентификаторы ключевых слов.

Параметры

Expression\|string	$value
bool	$prefixAlias

Возвращаемое значение

string

protected string wrapAliasedValue(string $value, bool $prefixAlias = false)

Оборачивает значение с алиасом.

Параметры

string	$value
bool	$prefixAlias

Возвращаемое значение

string

protected string wrapSegments(array $segments)

Оборачивает предоставленные сегменты значений.

Параметры

array

$segments

Возвращаемое значение

string

protected string wrapValue(string $value)

Оборачивает одну строку в идентификаторы ключевых слов.

Параметры

string

$value

Возвращаемое значение

string

string columnize(array $columns)

Преобразовать массив имён столбцов в строку с разделителями.

Параметры

array

$columns

Возвращаемое значение

string

string parameterize(array $values)

Создать маркеры параметров запроса для массива.

Параметры

array

$values

Возвращаемое значение

string

string parameter(mixed $value)

Получить соответствующий маркер параметра запроса для значения.

Параметры

mixed

$value

Возвращаемое значение

string

string quoteString(string|array $value)

Привести данную строковую литерал в кавычки.

Параметры

string|array

$value

Возвращаемое значение

string

bool isExpression(mixed $value)

Определить, является ли данное значение выражением.

Параметры

mixed

$value

Возвращаемое значение

bool

string getValue(Expression $expression)

Получить значение выражения.

Параметры

Expression

$expression

Возвращаемое значение

string

string getDateFormat()

Получить формат для дат, хранящихся в базе данных.

Возвращаемое значение

string

string getTablePrefix()

Получить префикс таблицы грамматики.

Возвращаемое значение

string

$this setTablePrefix(string $prefix)

Установить префикс таблицы грамматики.

Параметры

string

$prefix

Возвращаемое значение

$this

END_OF_DOCUMENT_MARKER

массив compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилировать команду переименования столбца.

Параметры

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Возвращаемое значение

массив

массив compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)

Компилировать команду изменения столбца в серию SQL-запросов.

Параметры

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Возвращаемое значение

массив

Исключения

RuntimeException

строка compileForeign(Blueprint $blueprint, Fluent $command)

Компилировать команду внешнего ключа.

Параметры

Blueprint	$blueprint
Fluent	$command

Возвращаемое значение

строка

protected массив getColumns(Blueprint $blueprint)

Компилировать определения столбцов из чертежа.

Параметры

Blueprint

$blueprint

Возвращаемое значение

массив

protected строка getType(Fluent $column)

Получить SQL для типа данных столбца.

Параметры

Fluent

$column

Возвращаемое значение

строка

protected void typeComputed(Fluent $column)

Создать определение столбца для сгенерированного, вычисляемого типа столбца.

Параметры

Fluent

$column

Возвращаемое значение

void

Исключения

RuntimeException

protected строка addModifiers(string $sql, Blueprint $blueprint, Fluent $column)

Добавить модификаторы столбца к определению.

Параметры

строка	$sql
Blueprint	$blueprint
Fluent	$column

Возвращаемое значение

строка

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

Получить команду первичного ключа, если она существует в чертеже.

Параметры

Blueprint	$blueprint
строка	$name

Возвращаемое значение

Fluent|null

protected массив getCommandsByName(Blueprint $blueprint, string $name)

Получить все команды с заданным именем.

Параметры

Blueprint	$blueprint
строка	$name

Возвращаемое значение

массив

массив prefixArray(string $prefix, array $values)

Добавить префикс к массиву значений.

Параметры

строка	$prefix
массив	$values

Возвращаемое значение

массив

protected строка getDefaultValue(mixed $value)

Отформатировать значение для использования в предложениях "default".

Параметры

смешанный

$value

Возвращаемое значение

строка

TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Создать пустой Doctrine DBAL TableDiff из чертежа.

Параметры

Blueprint	$blueprint
AbstractSchemaManager	$schema

Возвращаемое значение

TableDiff

массив getFluentCommands()

Получить команды fluent для синтаксического анализатора.

Возвращаемое значение

массив

булево supportsSchemaTransactions()

Проверить, поддерживает ли этот синтаксический анализатор изменения схемы, заключённые в транзакцию.

Возвращаемое значение

булево

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