Грамматика

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

Трейты

Свойства

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

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательский макрос.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Вмешать другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрирован ли макрос.	from Macroable
static void	flushMacros() Очистить существующие макросы.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывает вызовы класса.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывает вызовы класса.	from Macroable
array	wrapArray(array $values) Завернуть массив значений.	from Grammar
string	wrapTable(Expression\|string $table) Завернуть таблицу в идентификаторы ключевых слов.
string	wrap(Expression\|string $value, bool $prefixAlias = false) Завернуть значение в идентификаторы ключевых слов.
string	wrapAliasedValue(string $value, bool $prefixAlias = false) Завернуть значение, имеющее псевдоним.	from Grammar
string	wrapSegments(array $segments) Завернуть заданные сегменты значений.	from Grammar
string	wrapValue(string $value) Завернуть отдельную строку в идентификаторы ключевых слов.	from Grammar
string	columnize(array $columns) Преобразовать массив имен столбцов в строку с разделителями.	from Grammar
string	parameterize(array $values) Создать заполнители для параметров запроса для массива.	from Grammar
string	parameter(mixed $value) Получить соответствующий заполняющий параметр запроса для значения.	from Grammar
string	quoteString(string\|array $value) Взять в кавычки данную строковую константу.	from Grammar
bool	isExpression(mixed $value) Определить, является ли данное значение сырым выражением.	from Grammar
mixed	getValue(Expression $expression) Получить значение сырого выражения.	from Grammar
string	getDateFormat() Получить формат для дат, хранящихся в базе данных.	from Grammar
string	getTablePrefix() Получить префикс таблицы грамматики.	from Grammar
$this	setTablePrefix(string $prefix) Установить префикс таблицы грамматики.	from Grammar
void	compileCreateDatabase(string $name, Connection $connection) Скомпилировать команду создания базы данных.
void	compileDropDatabaseIfExists(string $name) Скомпилировать команду удаления базы данных, если она существует.
array	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) Получить команду первичного ключа, если она существует в чертеже.

массив	getCommandsByName(Blueprint $blueprint, string $name) Получить все команды с заданным именем.
массив	prefixArray(string $prefix, array $values) Добавить префикс к массиву значений.
строка	getDefaultValue(mixed $value) Отформатировать значение для использования в операторе «по умолчанию».
TableDiff	getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema) Создать пустой Doctrine DBAL TableDiff из Blueprint.
массив	getFluentCommands() Получить управляемые команды для грамматики.
логическое значение	supportsSchemaTransactions() Проверить, поддерживает ли эта грамматика изменения схемы, заключённые в транзакцию.

Подробности

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

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

Параметры

строка	$name
объект\|вызываемый объект	$macro

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

void

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

Добавить другой объект в класс.

Параметры

объект	$mixin
логическое значение	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка

$name

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

логическое значение

static void flushMacros()

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

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

void

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

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

Параметры

строка	$method
массив	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

строка	$method
массив	$parameters

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

mixed

Исключения

BadMethodCallException

array wrapArray(array $values)

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

Параметры

массив

$values

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

массив

string wrapTable(Expression|string $table)

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

Параметры

Expression|строка

$table

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

строка

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

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

Параметры

Expression\|строка	$value
логическое значение	$prefixAlias

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

строка

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

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

Параметры

строка	$value
логическое значение	$prefixAlias

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

строка

protected string wrapSegments(array $segments)

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

Параметры

массив

$segments

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

строка

protected string wrapValue(string $value)

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

Параметры

строка

$value

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

строка

string columnize(array $columns)

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

Параметры

массив

$columns

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

строка

string parameterize(array $values)

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

Параметры

массив

$values

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

строка

string parameter(mixed $value)

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

Параметры

смешанный тип

$value

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

строка

string quoteString(string|array $value)

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

Параметры

строка|массив

$value

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

строка

bool isExpression(mixed $value)

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

Параметры

смешанный тип

$value

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

логическое значение

END_OF_DOCUMENT_MARKER

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

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 compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)

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

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array

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

string compileDropFullText(Blueprint $blueprint, Fluent $command)

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

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

string compileForeign(Blueprint $blueprint, Fluent $command)

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

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

protected array getColumns(Blueprint $blueprint)

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

Parameters

Blueprint

$blueprint

Return Value

array

protected string getType(Fluent $column)

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

Parameters

Fluent

$column

Return Value

string

protected void typeComputed(Fluent $column)

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

Parameters

Fluent

$column

Return Value

void

Exceptions

RuntimeException

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

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

Параметры

string	$sql
Blueprint	$blueprint
Fluent	$column

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

string

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

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

Параметры

Blueprint	$blueprint
string	$name

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

Fluent|null

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

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

Параметры

Blueprint	$blueprint
string	$name

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

array

array prefixArray(string $prefix, array $values)

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

Параметры

string	$prefix
array	$values

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

array

protected string getDefaultValue(mixed $value)

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

Параметры

mixed

$value

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

string

TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Создать пустой Doctrine DBAL TableDiff из Blueprint.

Параметры

Blueprint	$blueprint
AbstractSchemaManager	$schema

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

TableDiff

array getFluentCommands()

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

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

array

bool supportsSchemaTransactions()

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

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

bool

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