Грамматика

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

Трейты

Свойства

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

Методы

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 void	flushMacros() Очистить существующие макросы.	из 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	wrapJsonSelector(string $value) Оборачивание заданного JSON-селектора.	из Grammar
bool	isJsonSelector(string $value) Определение, является ли заданная строка JSON-селектором.	из 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
mixed	getValue(Expression $expression) Получение значения выражения.	из Grammar
string	getDateFormat() Получение формата дат, хранящихся в базе данных.	из Grammar
string	getTablePrefix() Получение префикса таблицы грамматики.	из Grammar
$this	setTablePrefix(string $prefix) Установка префикса таблицы грамматики.	из Grammar
array	wrapJsonFieldAndPath(string $column) Разделение заданного JSON-селектора на поле и необязательный путь и их оборачивание отдельно.	из CompilesJsonPaths
string	wrapJsonPath(string $value, string $delimiter = '->') Оборачивание заданного JSON-пути.	из CompilesJsonPaths
string	wrapJsonPathSegment(string $segment) Оборачивание заданного сегмента JSON-пути.	из CompilesJsonPaths
void	compileCreateDatabase(string $name, Connection $connection) Компиляция команды создания базы данных.
void	compileDropDatabaseIfExists(string $name) Компиляция команды удаления базы данных, если она существует.
array\|string	compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection) Компиляция команды переименования столбца.
array	compileChange(Blueprint $blueprint, Fluent $command, Connection $connection) Компиляция команды изменения столбца в набор SQL-запросов.
string	compileFulltext(Blueprint $blueprint, Fluent $command) Компиляция команды создания полнотекстового индекса.
string	compileDropFullText(Blueprint $blueprint, Fluent $command) Компиляция команды удаления полнотекстового индекса.

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) Отформатировать значение для использования в предложениях «по умолчанию».
TableDiff	getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema) Создать пустой Doctrine DBAL TableDiff из Blueprint.
array	getFluentCommands() Получить команды fluent для грамматики.
bool	supportsSchemaTransactions() Проверить, поддерживает ли эта грамматика изменения схемы, заключенные в транзакцию.

Подробности

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

array wrapArray(array $values)

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

Parameters

array

$values

Return Value

array

string wrapTable(Expression|string $table)

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

Parameters

Expression|string

$table

Return Value

string

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

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

Parameters

Expression\|string	$value
bool	$prefixAlias

Return Value

string

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

Оборачивание значения с псевдонимом.

Parameters

string	$value
bool	$prefixAlias

Return Value

string

protected string wrapSegments(array $segments)

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

Parameters

array

$segments

Return Value

string

protected string wrapValue(string $value)

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

Parameters

string

$value

Return Value

string

protected string wrapJsonSelector(string $value)

Оборачивание заданного JSON-селектора.

Parameters

string

$value

Return Value

string

Exceptions

RuntimeException

protected bool isJsonSelector(string $value)

Определить, является ли заданная строка селектором JSON.

Parameters

string

$value

Return Value

bool

string columnize(array $columns)

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

Parameters

array

$columns

Return Value

string

string parameterize(array $values)

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

Parameters

array

$values

Return Value

string

string parameter(mixed $value)

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

Parameters

mixed

$value

Return Value

string

string quoteString(string|array $value)

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

Parameters

string|array

$value

Return Value

string

bool isExpression(mixed $value)

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

Parameters

mixed

$value

Return Value

bool

mixed getValue(Expression $expression)

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

Parameters

Expression

$expression

Return Value

mixed

string getDateFormat()

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

Return Value

string

string getTablePrefix()

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

Return Value

string

$this setTablePrefix(string $prefix)

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

Parameters

string

$prefix

Return Value

$this

protected array wrapJsonFieldAndPath(string $column)

Разделить заданный JSON селектор на поле и необязательный путь и обернуть их по отдельности.

Parameters

string

$column

Return Value

array

protected string wrapJsonPath(string $value, string $delimiter = '->')

Обернуть заданный JSON путь.

Parameters

string	$value
string	$delimiter

Return Value

string

protected string wrapJsonPathSegment(string $segment)

Обернуть заданный сегмент JSON пути.

Parameters

string

$segment

Return Value

string

void compileCreateDatabase(string $name, Connection $connection)

Компилировать команду создания базы данных.

Parameters

string	$name
Connection	$connection

Return Value

void

Exceptions

LogicException

void compileDropDatabaseIfExists(string $name)

Компилировать команду удаления базы данных, если она существует.

Parameters

string

$name

Return Value

void

Exceptions

LogicException

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

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

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array|string

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

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

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array

Exceptions

RuntimeException

string compileFulltext(Blueprint $blueprint, Fluent $command)

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

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

Exceptions

RuntimeException

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

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

Параметры

Blueprint	$blueprint
Fluent	$command

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

строка

Исключения

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».

Параметры

mixed

$value

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

строка

TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

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

Параметры

Blueprint	$blueprint
AbstractSchemaManager	$schema

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

TableDiff

массив getFluentCommands()

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

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

массив

логическое supportsSchemaTransactions()

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

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

логическое

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