Грамматика

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

Трейты

Свойства

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

Методы

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

string	compileFulltext(Blueprint $blueprint, Fluent $command) Компилировать команду создания индекса fulltext.
string	compileDropFullText(Blueprint $blueprint, Fluent $command) Компилировать команду удаления индекса fulltext.
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

END_OF_DOCUMENT_MARKER

protected string wrapValue(string $value)

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

Параметры

строка

$value

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

строка

protected string wrapJsonSelector(string $value)

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

Параметры

строка

$value

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

строка

Исключения

RuntimeException

protected bool isJsonSelector(string $value)

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

Параметры

строка

$value

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

bool

string columnize(array $columns)

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

Параметры

массив

$columns

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

строка

string parameterize(array $values)

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

Параметры

массив

$values

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

строка

string parameter(mixed $value)

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

Параметры

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

$value

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

строка

string quoteString(string|array $value)

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

Параметры

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

$value

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

строка

string escape(string|float|int|bool|null $value, bool $binary = false)

Экранирование значения для безопасной вставки в SQL.

Параметры

строка\|число с плавающей точкой\|целое число\|логическое значение\|null	$value
bool	$binary

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

строка

bool isExpression(mixed $value)

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

Параметры

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

$value

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

bool

string|int|float getValue(Expression|string|int|float $expression)

Преобразование выражений в скалярные типы.

Параметры

Expression|строка|целое число|число с плавающей точкой

$expression

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

строка|целое число|число с плавающей точкой

string getDateFormat()

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

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

строка

string getTablePrefix()

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

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

строка

$this setTablePrefix(string $prefix)

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

Параметры

строка

$prefix

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

$this

$this setConnection(Connection $connection)

Установка подключения к базе данных грамматики.

Параметры

Connection

$connection

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

$this

protected array wrapJsonFieldAndPath(string $column)

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

Параметры

строка

$column

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

массив

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

Оборачивание заданного пути JSON.

Параметры

строка	$value
строка	$delimiter

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

строка

protected string wrapJsonPathSegment(string $segment)

Оборачивание заданного сегмента пути JSON.

Параметры

строка

$segment

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

строка

void compileCreateDatabase(string $name, Connection $connection)

Компиляция команды создания базы данных.

Параметры

строка	$name
Connection	$connection

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

void

Исключения

LogicException

void compileDropDatabaseIfExists(string $name)

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

Параметры

строка

$name

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

void

Исключения

LogicException

массив|строка 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

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

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

Параметры

Blueprint	$blueprint
Fluent	$command

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

строка

Исключения

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

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

строка

Таблица различий getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Создать пустую таблицу Doctrine DBAL TableDiff из Blueprint.

Параметры

Blueprint	$blueprint
AbstractSchemaManager	$schema

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

Таблица различий

массив getFluentCommands()

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

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

массив

логическое значение supportsSchemaTransactions()

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

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

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

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