Spec-Zone.ru › Laravel 11

Грамматика

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

Трейты

CompilesJsonPaths
Macroable

Свойства

статический защищённый массив $macros

Зарегистрированные строковые макросы.

 из Macroable
защищённый Подключение $connection

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

 из Грамматика
защищённая строка $tablePrefix

Префикс таблицы грамматики.

 из Грамматика
защищённый массив строк $modifiers

Возможные модификаторы столбцов.
защищённый булев $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)

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

 from Grammar
string wrapAliasedTable(string $value)

Обернуть таблицу с алиасом.

 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)

Компилировать команду ключа полнотекстового индекса.
string compileDropFullText(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления полнотекстового индекса.
string compileForeign(Blueprint $blueprint, Fluent $command)

Компилировать команду внешнего ключа.
string compileDropForeign(Blueprint $blueprint, Fluent $command)

Компилировать команду удаления внешнего ключа.
array getColumns(Blueprint $blueprint)

Компилировать определения добавленных столбцов в макет.
string getColumn(Blueprint $blueprint, ColumnDefinition $column)

Компилировать определение столбца.
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)

Получить все команды с заданным именем.
hasCommand(Blueprint $blueprint, $name)

Без описания
array prefixArray(string $prefix, array $values)

Добавить префикс к массиву значений.
string getDefaultValue(mixed $value)

Отформатировать значение для использования в предложениях «по умолчанию».
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 void flushMacros()

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

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

void

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)

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

Параметры

string $value

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

string

protected string wrapAliasedTable(string $value)

Оборачивание таблицы, имеющей псевдоним.

Параметры

string $value

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

string

protected string wrapSegments(array $segments)

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

Параметры

array $segments

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

string

protected string wrapValue(string $value)

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

Параметры

string $value

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

string

protected string wrapJsonSelector(string $value)

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

Параметры

string $value

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

string

Исключения

RuntimeException

protected bool isJsonSelector(string $value)

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

Параметры

string $value

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

bool

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

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

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

Параметры

string|float|int|bool|null $value
bool $binary

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

string

bool isExpression(mixed $value)

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

Параметры

mixed $value

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

bool

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

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

Параметры

Expression|string|int|float $expression

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

string|int|float

string getDateFormat()

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

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

string

string getTablePrefix()

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

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

string

$this setTablePrefix(string $prefix)

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

Параметры

string $prefix

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

$this

$this setConnection(Connection $connection)

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

Параметры

Connection $connection

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

$this

protected array wrapJsonFieldAndPath(string $column)

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

Параметры

string $column

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

array

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

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

Параметры

string $value
string $delimiter

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

string

protected string wrapJsonPathSegment(string $segment)

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

Параметры

string $segment

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

string

void compileCreateDatabase(string $name, Connection $connection)

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

Параметры

string $name
Connection $connection

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

void

Исключения

LogicException
END_OF_DOCUMENT_MARKER

void compileDropDatabaseIfExists(string $name)

Компилировать команду drop database if exists.

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

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

Parameters

Blueprint $blueprint
Fluent $command
Connection $connection

Return Value

array|string

Exceptions

RuntimeException

string compileFulltext(Blueprint $blueprint, Fluent $command)

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

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

Exceptions

RuntimeException

string compileDropFullText(Blueprint $blueprint, Fluent $command)

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

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

Exceptions

RuntimeException

string compileForeign(Blueprint $blueprint, Fluent $command)

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

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

string compileDropForeign(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 getColumn(Blueprint $blueprint, ColumnDefinition $column)

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

Parameters

Blueprint $blueprint
ColumnDefinition $column

Return Value

string

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)

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

Parameters

string $sql
Blueprint $blueprint
Fluent $column

Return Value

string

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

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

Parameters

Blueprint $blueprint
string $name

Return Value

Fluent|null

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

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

Parameters

Blueprint $blueprint
string $name

Return Value

array

protected hasCommand(Blueprint $blueprint, $name)

Описание отсутствует.

Parameters

Blueprint $blueprint
$name

array prefixArray(string $prefix, array $values)

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

Parameters

string $prefix
array $values

Return Value

array

protected string getDefaultValue(mixed $value)

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

Parameters

mixed $value

Return Value

string

array getFluentCommands()

Получить флюэнт-команды для грамматики.

Return Value

array

bool supportsSchemaTransactions()

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

Return Value

bool

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API