Spec-Zone.ru › Laravel 5.6

Грамматика

class Грамматика extends Грамматика (Просмотреть исходный код)

Трейты

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)

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

string whereNotNull(Builder $query, array $where)

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

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

string compileLock(Builder $query, bool|string $value)

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

bool supportsSavepoints()

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

string compileSavepoint(string $name)

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

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

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

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

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

логическое isJsonSelector(строка $value)

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

строка concatenate(массив $segments)

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

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

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

массив getOperators()

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

Подробности

статический void macro(строка $name, объект|вызываемый $macro)

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

Параметры

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

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

void

статический void mixin(объект $mixin)

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

Параметры

объект $mixin

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

void

Исключения

ReflectionException

статический логическое hasMacro(строка $name)

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

Параметры

строка $name

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

логическое

статический смешанное __callStatic(строка $method, массив $parameters)

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

Параметры

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

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

смешанное

Исключения

BadMethodCallException

смешанное __call(строка $method, массив $parameters)

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

Параметры

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

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

смешанное

Исключения

BadMethodCallException

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

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

Параметры

массив $values

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

массив

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

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

Параметры

Expression|строка $table

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

строка

строка wrap(Expression|строка $value, логическое $prefixAlias = false)

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

Параметры

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

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

строка

защищенный строка wrapAliasedValue(строка $value, логическое $prefixAlias = false)

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

Параметры

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

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

строка

защищенный строка wrapSegments(массив $segments)

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

Параметры

массив $segments

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

строка

защищенный строка wrapValue(строка $value)

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

Параметры

строка $value

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

строка

строка columnize(массив $columns)

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

Параметры

массив $columns

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

строка

строка parameterize(массив $values)

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

Параметры

массив $values

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

строка

строка parameter(смешанное $value)

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

Параметры

смешанное $value

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

строка

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

Указывает заданную строковую литерал.

Параметры

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

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

строка

логическое isExpression(смешанное $value)

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

Параметры

смешанное $value

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

логическое

строка getValue(Expression $expression)

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

Параметры

Expression $expression

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

строка

строка getDateFormat()

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

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

строка

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

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

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

Параметры

Builder $query
array $where

Значение возврата

string

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

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

Параметры

Builder $query
array $where

Значение возврата

string

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

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

Параметры

Builder $query
array $where

Значение возврата

string

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

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

Параметры

Builder $query
array $where

Значение возврата

string

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

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

Параметры

Builder $query
array $where

Значение возврата

string

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

Компиляция условия "где пусто".

Параметры

Builder $query
array $where

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

string

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

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

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "между".

Параметры

Builder $query
array $where

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

string

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

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

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "где время".

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "где день".

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "где месяц".

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "где год".

Параметры

Builder $query
array $where

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

string

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

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

Параметры

string $type
Builder $query
array $where

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

string

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

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

.

Параметры

Builder $query
array $where

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

string

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

Компиляция вложенного условия.

Параметры

Builder $query
array $where

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

string

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

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

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "где существует".

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "где не существует".

Параметры

Builder $query
array $where

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

string

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

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

Параметры

Builder $query
array $where

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

string

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

Компиляция условия "где JSON содержит".

Параметры

Builder $query
array $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 compileGroups(Builder $query, array $groups)

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

Параметры

Builder $query
array $groups

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

string

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

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

Параметры

Builder $query
array $havings

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

string

protected string compileHaving(array $having)

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

Параметры

array $having

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

string

protected string compileBasicHaving(array $having)

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

Параметры

array $having

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

string

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

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

Параметры

Builder $query
array $orders

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

string

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

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

Параметры

Builder $query
array $orders

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

array

string compileRandom(string $seed)

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

Параметры

string $seed

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

string

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

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

Параметры

Builder $query
int $limit

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

string

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

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

Параметры

Builder $query
int $offset

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

string

protected string compileUnions(Builder $query)

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

Параметры

Builder $query

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

string

protected string compileUnion(array $union)

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

Параметры

array $union

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

string

string compileExists(Builder $query)

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

Параметры

Builder $query

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

string

string compileInsert(Builder $query, array $values)

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

Параметры

Builder $query
array $values

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

string

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

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

Параметры

Builder $query
array $values
string $sequence

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

string

string compileUpdate(Builder $query, array $values)

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

Параметры

Builder $query
array $values

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

string

array prepareBindingsForUpdate(array $bindings, array $values)

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

Параметры

array $bindings
array $values

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

array

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

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

Параметры

Builder $query

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

строка

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

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

Параметры

массив $bindings

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

массив

массив 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 логическое значение 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.6/Illuminate/Database/Query/Grammars/Grammar.html

Spec-Zone.ru

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