Spec-Zone.ru › Laravel 5.7

Грамматика

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

Трейты

Macroable

Свойства

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

Методы

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

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

from Macroable
static void mixin(object $mixin)

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

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)

Компиляция предложения raw 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 whereInSub(Builder $query, array $where)

Компиляция предложения where in подзапроса.

string whereNotInSub(Builder $query, array $where)

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

string whereNull(Builder $query, array $where)

Компилировать условие «где пусто».

string whereNotNull(Builder $query, array $where)

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

string whereBetween(Builder $query, array $where)

Компилировать условие «между».

string whereDate(Builder $query, array $where)

Компилировать условие «где дата».

string whereTime(Builder $query, array $where)

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

string whereDay(Builder $query, array $where)

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

string whereMonth(Builder $query, array $where)

Компилировать условие «где месяц».

string whereYear(Builder $query, array $where)

Компилировать условие «где год».

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

Компилировать условие «где дата».

string whereColumn(Builder $query, array $where)

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

string whereNested(Builder $query, array $where)

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

string whereSub(Builder $query, array $where)

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

string whereExists(Builder $query, array $where)

Компилировать условие «где существует».

string whereNotExists(Builder $query, array $where)

Компилировать условие «где не существует».

string whereRowValues(Builder $query, array $where)

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

string whereJsonContains(Builder $query, array $where)

Компилировать условие «где JSON содержит».

string compileJsonContains(string $column, string $value)

Компилировать утверждение «JSON содержит» в SQL.

string prepareBindingForJsonContains(mixed $binding)

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

string whereJsonLength(Builder $query, array $where)

Компилировать условие «где длина JSON».

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

Компилировать утверждение «длина JSON» в SQL.

string compileGroups(Builder $query, array $groups)

Компилировать части запроса «группировать по».

string compileHavings(Builder $query, array $havings)

Компилировать части запроса «где».

string compileHaving(array $having)

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

string compileBasicHaving(array $having)

Компилировать базовое условие «где».

string compileOrders(Builder $query, array $orders)

Компилировать части запроса «упорядочить по».

array compileOrdersToArray(Builder $query, array $orders)

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

string compileRandom(string $seed)

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

string compileLimit(Builder $query, int $limit)

Компилировать части запроса «ограничить».

string compileOffset(Builder $query, int $offset)

Компилировать части запроса «смещение».

string compileUnions(Builder $query)

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

string compileUnion(array $union)

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

string compileExists(Builder $query)

Компилировать утверждение «существует» в SQL.

string compileInsert(Builder $query, array $values)

Компилировать утверждение «вставить» в SQL.

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

Компилировать утверждение «вставить и получить ID» в SQL.

string compileUpdate(Builder $query, array $values)

Компилировать утверждение «обновить» в SQL.

array prepareBindingsForUpdate(array $bindings, array $values)

Подготовить привязки для утверждения «обновить».

string compileDelete(Builder $query)

Компилировать утверждение «удалить» в SQL.

array prepareBindingsForDelete(array $bindings)

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

array compileTruncate(Builder $query)

Компилировать утверждение «обнулить таблицу» в SQL.

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

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

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

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

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

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

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

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

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

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

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

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

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

Оборачивание заданного 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)

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

Параметры

объект $mixin

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

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 строка wrapValue(string $value)

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

Параметры

строка $value

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

строка

строка columnize(array $columns)

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

Параметры

массив $columns

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

строка

строка parameterize(array $values)

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

Параметры

массив $values

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

строка

строка parameter(mixed $value)

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

Параметры

смешанное $value

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

строка

строка quoteString(string|array $value)

Обрамление заданной строковой литералы.

Параметры

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

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

строка

bool isExpression(mixed $value)

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

Parameters

mixed $value

Return Value

bool

string getValue(Expression $expression)

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

Parameters

Expression $expression

Return Value

string

string getDateFormat()

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

Return Value

string

string getTablePrefix()

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

Return Value

string

$this setTablePrefix(string $prefix)

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

Parameters

string $prefix

Return Value

$this

string compileSelect(Builder $query)

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

Parameters

Builder $query

Return Value

string

protected array compileComponents(Builder $query)

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

Parameters

Builder $query

Return Value

array

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

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

Parameters

Builder $query
array $aggregate

Return Value

string

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

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

Parameters

Builder $query
array $columns

Return Value

string|null

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

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

Parameters

Builder $query
string $table

Return Value

string

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

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

Parameters

Builder $query
array $joins

Return Value

string

protected string compileWheres(Builder $query)

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

Parameters

Builder $query

Return Value

string

protected array compileWheresToArray(Builder $query)

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

Parameters

Builder $query

Return Value

array

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

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

Parameters

Builder $query
array $sql

Return Value

string

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

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

Parameters

Builder $query
array $where

Return Value

string

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 whereInSub(Builder $query, array $where)

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

Builder $query
массив $where

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

string

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

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

Параметры

string $type
Builder $query
массив $where

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

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.

Parameters

Builder $query
array $where

Return Value

string

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

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

Parameters

Builder $query
array $where

Return Value

string

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

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

Parameters

string $column
string $value

Return Value

string

Exceptions

RuntimeException

string prepareBindingForJsonContains(mixed $binding)

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

Parameters

mixed $binding

Return Value

string

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

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

Parameters

Builder $query
array $where

Return Value

string

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

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

Parameters

string $column
string $operator
string $value

Return Value

string

Exceptions

RuntimeException

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

Компилировать фрагменты "группировать по" (group by) запроса.

Parameters

Builder $query
array $groups

Return Value

string

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

Компилировать фрагменты "having" запроса.

Parameters

Builder $query
array $havings

Return Value

string

protected string compileHaving(array $having)

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

Parameters

array $having

Return Value

string

protected string compileBasicHaving(array $having)

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

Parameters

array $having

Return Value

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)

Компилировать отдельное выражение union.

Parameters

array $union

Return Value

string

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

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

Параметры

Builder $query

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

строка

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

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

Параметры

Builder $query
массив $values

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

строка

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

Скомпилировать утверждение insert и получить ID в SQL.

Параметры

Builder $query
массив $values
строка $sequence

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

строка

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

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

Параметры

Builder $query
массив $values

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

строка

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

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

Параметры

массив $bindings
массив $values

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

массив

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

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

Параметры

Builder $query

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

строка

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

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

Параметры

массив $bindings

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

массив

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

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

Параметры

Builder $query

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

массив

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

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

Параметры

Builder $query
bool|string $value

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

строка

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

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

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

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

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

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

Параметры

строка $name

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

строка

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

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

Параметры

строка $name

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

строка

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

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

Параметры

строка $value

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

строка

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

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

Параметры

строка $column

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

массив

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

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

Параметры

строка $value

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

строка

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.7/Illuminate/Database/Query/Grammars/Grammar.html

Spec-Zone.ru

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