Spec-Zone.ru › Laravel 5.8

Грамматика

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

Трейты

Macroable

Свойства

статический защищённый массив $macros Зарегистрированные строковые макросы. из Macroable
защищённая строка $tablePrefix Префикс таблицы грамматики. из Grammar
защищённый массив $operators Операторы, специфичные для грамматики.
защищённый массив $selectComponents Компоненты, составляющие предложение select.

Методы

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 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)

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

from Grammar
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
string getValue(Expression $expression)

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

from Grammar
string getDateFormat()

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

from Grammar
string getTablePrefix()

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

from Grammar
$this setTablePrefix(string $prefix)

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

from Grammar
string compileSelect(Builder $query)

Компилировать запрос select в SQL.

array compileComponents(Builder $query)

Скомпилировать компоненты, необходимые для предложения select.

string compileAggregate(Builder $query, array $aggregate)

Скомпилировать предложение агрегированного select.

string|null compileColumns(Builder $query, array $columns)

Скомпилировать часть запроса "select *".

string compileFrom(Builder $query, string $table)

Скомпилировать часть запроса "from".

string compileJoins(Builder $query, array $joins)

Скомпилировать части запроса "join".

string compileWheres(Builder $query)

Скомпилировать части запроса "where".

array compileWheresToArray(Builder $query)

Получить массив всех предложений where для запроса.

string concatenateWhereClauses(Builder $query, array $sql)

Отформатировать операторы предложения where в одну строку.

string whereRaw(Builder $query, array $where)

Скомпилировать исходное предложение where.

string whereBasic(Builder $query, array $where)

Скомпилировать основное предложение where.

string whereIn(Builder $query, array $where)

Скомпилировать предложение "where in".

string whereNotIn(Builder $query, array $where)

Скомпилировать предложение "where not in".

string whereNotInRaw(Builder $query, array $where)

Скомпилировать предложение "where not in raw".

string whereInSub(Builder $query, array $where)

Скомпилировать предложение where in подзапроса.

string whereNotInSub(Builder $query, array $where)

Скомпилировать условие where not in подзапроса.

string whereInRaw(Builder $query, array $where)

Скомпилировать условие "where in raw".

string whereNull(Builder $query, array $where)

Скомпилировать условие "where null".

string whereNotNull(Builder $query, array $where)

Скомпилировать условие "where not null".

string whereBetween(Builder $query, array $where)

Скомпилировать условие "between".

string whereDate(Builder $query, array $where)

Скомпилировать условие "where date".

string whereTime(Builder $query, array $where)

Скомпилировать условие "where time".

string whereDay(Builder $query, array $where)

Скомпилировать условие "where day".

string whereMonth(Builder $query, array $where)

Скомпилировать условие "where month".

string whereYear(Builder $query, array $where)

Скомпилировать условие "where year".

string dateBasedWhere(string $type, Builder $query, array $where)

Скомпилировать условие where, основанное на дате.

string whereColumn(Builder $query, array $where)

Скомпилировать условие where, сравнивающее две колонки.

string whereNested(Builder $query, array $where)

Скомпилировать вложенное условие where.

string whereSub(Builder $query, array $where)

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

string whereExists(Builder $query, array $where)

Скомпилировать условие where exists.

string whereNotExists(Builder $query, array $where)

Скомпилировать условие where exists.

string whereRowValues(Builder $query, array $where)

Скомпилировать условие where с значениями строки.

string whereJsonBoolean(Builder $query, array $where)

Скомпилировать условие "where JSON boolean".

string whereJsonContains(Builder $query, array $where)

Скомпилировать условие "where JSON содержит".

string compileJsonContains(string $column, string $value)

Скомпилировать выражение "JSON содержит" в SQL.

string prepareBindingForJsonContains(mixed $binding)

Подготовить привязку для выражения "JSON содержит".

string whereJsonLength(Builder $query, array $where)

Скомпилировать условие "where JSON длина".

string compileJsonLength(string $column, string $operator, string $value)

Скомпилировать выражение "JSON длина" в SQL.

string compileGroups(Builder $query, array $groups)

Скомпилировать части "group by" запроса.

string compileHavings(Builder $query, array $havings)

Скомпилировать части "having" запроса.

string compileHaving(array $having)

Скомпилировать одно условие having.

string compileBasicHaving(array $having)

Скомпилировать простое условие having.

string compileHavingBetween(array $having)

Скомпилировать условие "between" having.

string compileOrders(Builder $query, array $orders)

Скомпилировать части "order by" запроса.

array compileOrdersToArray(Builder $query, array $orders)

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

string compileRandom(string $seed)

Скомпилировать выражение random в SQL.

string compileLimit(Builder $query, int $limit)

Скомпилировать части "limit" запроса.

string compileOffset(Builder $query, int $offset)

Скомпилировать части "offset" запроса.

string compileUnions(Builder $query)

Скомпилировать объединенные запросы, присоединенные к основному запросу.

string compileUnion(array $union)

Скомпилировать одно объединенное выражение.

string compileUnionAggregate(Builder $query)

Скомпилировать агрегированный объединенный запрос в SQL.

string compileExists(Builder $query)

Скомпилировать выражение exists в SQL.

string compileInsert(Builder $query, array $values)

Скомпилировать выражение insert в SQL.

string compileInsertOrIgnore(Builder $query, array $values)

Скомпилировать выражение insert ignore в SQL.

строка compileInsertGetId(Builder $query, array $values, string $sequence)

Скомпилировать оператор вставки и получения идентификатора в SQL.

строка compileInsertUsing(Builder $query, array $columns, string $sql)

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

строка compileUpdate(Builder $query, array $values)

Скомпилировать оператор обновления в SQL.

массив prepareBindingsForUpdate(array $bindings, array $values)

Подготовить привязки для оператора обновления.

строка compileDelete(Builder $query)

Скомпилировать оператор удаления в SQL.

массив prepareBindingsForDelete(array $bindings)

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

массив compileTruncate(Builder $query)

Скомпилировать оператор обнуления таблицы в SQL.

строка compileLock(Builder $query, bool|string $value)

Скомпилировать блокировку в SQL.

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

Определить, поддерживает ли грамматика сохранение точек.

строка compileSavepoint(string $name)

Скомпилировать оператор SQL для определения точки сохранения.

строка compileSavepointRollBack(string $name)

Скомпилировать оператор SQL для выполнения отката точки сохранения.

строка wrapJsonSelector(string $value)

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

строка wrapJsonBooleanSelector(string $value)

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

строка wrapJsonBooleanValue(string $value)

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

массив wrapJsonFieldAndPath(string $column)

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

строка wrapJsonPath(string $value, string $delimiter = '->')

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

логическое значение isJsonSelector(string $value)

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

строка concatenate(array $segments)

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

строка removeLeadingBoolean(string $value)

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

массив getOperators()

Получение операторов, специфичных для грамматики.

Подробности

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 смешанный тип __callStatic(string $method, array $parameters)

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

Параметры

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

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

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

Исключения

BadMethodCallException

смешанный тип __call(string $method, array $parameters)

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

Параметры

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

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

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

Исключения

BadMethodCallException

массив wrapArray(array $values)

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

Параметры

массив $values

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

массив

строка wrapTable(Expression|string $table)

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

Параметры

Expression|строка $table

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

строка

строка wrap(Expression|string $value, bool $prefixAlias = false)

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

Параметры

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

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

строка

protected строка wrapAliasedValue(string $value, bool $prefixAlias = false)

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

Параметры

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

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

строка

protected строка wrapSegments(array $segments)

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

Параметры

массив $segments

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

строка

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

string compileSelect(Builder $query)

Компиляция запроса select в SQL.

Параметры

Builder $query

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

string

protected array compileComponents(Builder $query)

Компиляция компонентов, необходимых для фрагмента select.

Параметры

Builder $query

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

array

protected string compileAggregate(Builder $query, array $aggregate)

Компиляция фрагмента агрегированного select.

Параметры

Builder $query
array $aggregate

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

string

protected string|null compileColumns(Builder $query, array $columns)

Компиляция фрагмента "select *" запроса.

Параметры

Builder $query
array $columns

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

string|null

protected string compileFrom(Builder $query, string $table)

Компиляция фрагмента "from" запроса.

Параметры

Builder $query
string $table

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

string

protected string compileJoins(Builder $query, array $joins)

Компиляция фрагментов "join" запроса.

Параметры

Builder $query
array $joins

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

string

protected string compileWheres(Builder $query)

Компиляция фрагментов "where" запроса.

Параметры

Builder $query

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

string

protected array compileWheresToArray(Builder $query)

Получение массива всех фрагментов "where" для запроса.

Параметры

Builder $query

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

array

protected string concatenateWhereClauses(Builder $query, array $sql)

Форматирование операторов фрагмента where в одну строку.

Параметры

Builder $query
array $sql

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

string

protected string whereRaw(Builder $query, array $where)

Компиляция исходного фрагмента where.

Параметры

Builder $query
array $where

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

string
END_OF_DOCUMENT_MARKER

protected string whereBasic(Builder $query, array $where)

Компиляция простого условия where.

Parameters

Builder $query
array $where

Return Value

string

protected string whereIn(Builder $query, array $where)

Компиляция условия "where in".

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotIn(Builder $query, array $where)

Компиляция условия "where not in".

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotInRaw(Builder $query, array $where)

Компиляция условия "where not in raw".

Для безопасности, whereIntegerInRaw гарантирует, что этот метод используется только с целочисленными значениями.

Parameters

Builder $query
array $where

Return Value

string

protected string whereInSub(Builder $query, array $where)

Компиляция условия where в подзапросе.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotInSub(Builder $query, array $where)

Компиляция условия where not in в подзапросе.

Parameters

Builder $query
array $where

Return Value

string

protected string whereInRaw(Builder $query, array $where)

Компиляция условия "where in raw".

Для безопасности, whereIntegerInRaw гарантирует, что этот метод используется только с целочисленными значениями.

Parameters

Builder $query
array $where

Return Value

string

protected string whereNull(Builder $query, array $where)

Компиляция условия "where null".

Parameters

Builder $query
array $where

Return Value

string

protected string whereNotNull(Builder $query, array $where)

Компиляция условия "where not null".

Parameters

Builder $query
array $where

Return Value

string

protected string whereBetween(Builder $query, array $where)

Компиляция условия "between".

Parameters

Builder $query
array $where

Return Value

string

protected string whereDate(Builder $query, array $where)

Компиляция условия "where date".

Parameters

Builder $query
array $where

Return Value

string

protected string whereTime(Builder $query, array $where)

Компиляция условия "where time".

Parameters

Builder $query
array $where

Return Value

string

protected string whereDay(Builder $query, array $where)

Компиляция условия "where day".

Parameters

Builder $query
array $where

Return Value

string

protected string whereMonth(Builder $query, array $where)

Компиляция условия "where month".

Parameters

Builder $query
array $where

Return Value

string

protected string whereYear(Builder $query, array $where)

Компиляция условия "where year".

Parameters

Builder $query
array $where

Return Value

string

protected string dateBasedWhere(string $type, Builder $query, array $where)

Компиляция условия where, основанного на дате.

Parameters

string $type
Builder $query
array $where

Return Value

string

protected string whereColumn(Builder $query, array $where)

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

.

Параметры

Builder $query
массив $where

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

string

protected string whereNested(Builder $query, array $where)

Компилировать вложенное условие where.

Параметры

Builder $query
массив $where

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

string

protected string whereSub(Builder $query, array $where)

Компилировать условие where с подзапросом.

Параметры

Builder $query
массив $where

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

string

protected string whereExists(Builder $query, array $where)

Компилировать условие where exists.

Параметры

Builder $query
массив $where

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

string

protected string whereNotExists(Builder $query, array $where)

Компилировать условие where exists.

Параметры

Builder $query
массив $where

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

string

protected string whereRowValues(Builder $query, array $where)

Компилировать условие where row values.

Параметры

Builder $query
массив $where

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

string

protected string whereJsonBoolean(Builder $query, array $where)

Компилировать условие "where JSON boolean".

Параметры

Builder $query
массив $where

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

string

protected string whereJsonContains(Builder $query, array $where)

Компилировать условие "where JSON содержит".

Параметры

Builder $query
массив $where

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

string

protected string compileJsonContains(string $column, string $value)

Компилировать оператор "JSON содержит" в SQL.

Параметры

string $column
string $value

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

string

Исключения

RuntimeException

string prepareBindingForJsonContains(mixed $binding)

Подготовить привязку для оператора "JSON содержит".

Параметры

mixed $binding

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

string

protected string whereJsonLength(Builder $query, array $where)

Компилировать условие "where JSON длина".

Параметры

Builder $query
массив $where

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

string

protected string compileJsonLength(string $column, string $operator, string $value)

Компилировать оператор "JSON длина" в SQL.

Параметры

string $column
string $operator
string $value

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

string

Исключения

RuntimeException

protected string compileGroups(Builder $query, array $groups)

Компилировать части "group by" запроса.

Параметры

Builder $query
массив $groups

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

string

protected string compileHavings(Builder $query, array $havings)

Компилировать части "having" запроса.

Параметры

Builder $query
массив $havings

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

string

protected string compileHaving(array $having)

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

Параметры

массив $having

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

string

protected string compileBasicHaving(array $having)

Компилировать базовое условие having.

Параметры

массив $having

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

string

protected string compileHavingBetween(array $having)

Компилировать условие "between" для having.

Параметры

массив $having

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

string

protected string compileOrders(Builder $query, array $orders)

Компилировать части запроса "order by".

Parameters

Builder $query
array $orders

Return Value

string

protected array compileOrdersToArray(Builder $query, array $orders)

Компилировать заказы запроса в массив.

Parameters

Builder $query
array $orders

Return Value

array

string compileRandom(string $seed)

Компилировать оператор случайных чисел в SQL.

Parameters

string $seed

Return Value

string

protected string compileLimit(Builder $query, int $limit)

Компилировать части запроса "limit".

Parameters

Builder $query
int $limit

Return Value

string

protected string compileOffset(Builder $query, int $offset)

Компилировать части запроса "offset".

Parameters

Builder $query
int $offset

Return Value

string

protected string compileUnions(Builder $query)

Компилировать "union" запросы, присоединенные к основному запросу.

Parameters

Builder $query

Return Value

string

protected string compileUnion(array $union)

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

Parameters

array $union

Return Value

string

protected string compileUnionAggregate(Builder $query)

Компилировать агрегированный запрос union в SQL.

Parameters

Builder $query

Return Value

string

string compileExists(Builder $query)

Компилировать оператор exists в SQL.

Parameters

Builder $query

Return Value

string

string compileInsert(Builder $query, array $values)

Компилировать оператор insert в SQL.

Parameters

Builder $query
array $values

Return Value

string

string compileInsertOrIgnore(Builder $query, array $values)

Компилировать оператор insert ignore в SQL.

Parameters

Builder $query
array $values

Return Value

string

string compileInsertGetId(Builder $query, array $values, string $sequence)

Компилировать оператор insert и получение ID в SQL.

Parameters

Builder $query
array $values
string $sequence

Return Value

string

string compileInsertUsing(Builder $query, array $columns, string $sql)

Компилировать оператор insert с использованием подзапроса в SQL.

Parameters

Builder $query
array $columns
string $sql

Return Value

string

string compileUpdate(Builder $query, array $values)

Компилировать оператор update в SQL.

Parameters

Builder $query
array $values

Return Value

string

array prepareBindingsForUpdate(array $bindings, array $values)

Подготовить параметры для оператора update.

Parameters

array $bindings
array $values

Return Value

array

string compileDelete(Builder $query)

Компилировать оператор delete в SQL.

Parameters

Builder $query

Return Value

string

array prepareBindingsForDelete(array $bindings)

Подготовить параметры для оператора delete.

Parameters

array $bindings

Return Value

array

массив compileTruncate(Builder $query)

Скомпилировать оператор обнуления таблицы в SQL.

Параметры

Builder $query

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

массив

protected строка compileLock(Builder $query, bool|string $value)

Скомпилировать блокировку в SQL.

Параметры

Builder $query
bool|string $value

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

строка

булево supportsSavepoints()

Определить, поддерживает ли синтаксический анализатор сохранение точек.

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

булево

строка compileSavepoint(string $name)

Скомпилировать оператор SQL для определения точки сохранения.

Параметры

строка $name

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

строка

строка compileSavepointRollBack(string $name)

Скомпилировать оператор SQL для отката точки сохранения.

Параметры

строка $name

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

строка

protected строка wrapJsonSelector(string $value)

Обернуть заданный JSON-селектор.

Параметры

строка $value

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

строка

protected строка wrapJsonBooleanSelector(string $value)

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

Параметры

строка $value

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

строка

protected строка wrapJsonBooleanValue(string $value)

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

Параметры

строка $value

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

строка

protected массив wrapJsonFieldAndPath(string $column)

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

Параметры

строка $column

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

массив

protected строка wrapJsonPath(string $value, string $delimiter = '->')

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

Параметры

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

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

строка

protected булево isJsonSelector(string $value)

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

Параметры

строка $value

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

булево

protected строка concatenate(array $segments)

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

Параметры

массив $segments

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

строка

protected строка removeLeadingBoolean(string $value)

Удалить ведущую логическую операцию из оператора.

Параметры

строка $value

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

строка

массив getOperators()

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

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

массив

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

Spec-Zone.ru

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