Spec-Zone.ru › Laravel 5.5

JoinClause

class JoinClause extends Builder (View source)

Свойства

BuildsQueries
Macroable

Свойства

статический защищённый массив $macros Зарегистрированные макросы строк. из Macroable
ConnectionInterface $connection Экземпляр подключения к базе данных. из Builder
Grammar $grammar Экземпляр синтаксического анализатора запросов базы данных. из Builder
Processor $processor Экземпляр постпроцессора запросов базы данных. из Builder
массив $bindings Текущие значения связей запроса. из Builder
массив $aggregate Функция агрегирования и столбец для выполнения. из Builder
массив $columns Столбцы, которые должны быть возвращены. из Builder
логическое значение $distinct Указывает, возвращает ли запрос уникальные результаты. из Builder
строка $from Таблица, на которую нацелен запрос. из Builder
массив $joins Соединения таблиц для запроса. из Builder
массив $wheres Условия WHERE для запроса. из Builder
массив $groups Группировки для запроса. из Builder
массив $havings Условия HAVING для запроса. из Builder
массив $orders Сортировки для запроса. из Builder
целое число $limit Максимальное количество записей для возврата. из Builder
целое число $offset Количество записей для пропуска. из Builder
массив $unions Заявления объединения запросов. из Builder
целое число $unionLimit Максимальное количество записей объединения для возврата. из Builder
целое число $unionOffset Количество записей объединения для пропуска. из Builder
массив $unionOrders Сортировки для запроса объединения. из Builder
строка|логическое значение $lock Указывает, используется ли блокировка строк. из Builder
array $operators Все доступные операторы условий. из Builder
bool $useWritePdo Использовать ли pdo для записи при выборе. из Builder
string $type Тип соединения, выполняемого.
string $table Таблица, к которой присоединяется условие соединения.

Методы

bool chunk(int $count, callable $callback)

Разбить результаты запроса на куски.

from BuildsQueries
bool each(callable $callback, int $count = 1000)

Выполнить обратный вызов для каждого элемента с разбиением на куски.

from BuildsQueries
Model|BuildsQueries|null first(array $columns = ['*'])

Выполнить запрос и получить первый результат.

from BuildsQueries
mixed when(mixed $value, callable $callback, callable $default = null)

Применить изменения запроса обратного вызова, если заданное «значение» истинно.

from BuildsQueries
Builder tap(Closure $callback)

Передать запрос в предоставленный обратный вызов.

from BuildsQueries
mixed unless(mixed $value, callable $callback, callable $default = null)

Применить изменения запроса обратного вызова, если заданное «значение» ложно.

from BuildsQueries
LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)

Создать новый экземпляр пагинатора с учётом длины.

from BuildsQueries
Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)

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

from BuildsQueries
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
void __construct(Builder $parentQuery, string $type, string $table)

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

$this select(array|mixed $columns = ['*'])

Установить столбцы для выбора.

из Builder
Builder|Builder selectRaw(string $expression, array $bindings = [])

Добавить новое выражение "сырого" выбора в запрос.

из Builder
Builder|Builder selectSub(Closure|Builder|string $query, string $as)

Добавить выражение подзапроса в запрос.

из Builder
array parseSubSelect(mixed $query)

Разбор подзапроса для преобразования в SQL и связывания.

из Builder
$this addSelect(array|mixed $column)

Добавить новый столбец выбора в запрос.

из Builder
$this distinct()

Вынужденно возвращать только уникальные результаты.

из Builder
$this from(string $table)

Установить таблицу, на которую направлен запрос.

из Builder
$this join(string $table, string $first, string|null $operator = null, string|null $second = null, string $type = 'inner', bool $where = false)

Добавить условие объединения в запрос.

из Builder
Builder|Builder joinWhere(string $table, string $first, string $operator, string $second, string $type = 'inner')

Добавить условие "join where" в запрос.

из Builder
Builder|Builder leftJoin(string $table, string $first, string|null $operator = null, string|null $second = null)

Добавить левое объединение в запрос.

из Builder
Builder|Builder leftJoinWhere(string $table, string $first, string $operator, string $second)

Добавить условие "join where" в запрос.

из Builder
Builder|Builder rightJoin(string $table, string $first, string|null $operator = null, string|null $second = null)

Добавить правое объединение в запрос.

из Builder
Builder|Builder rightJoinWhere(string $table, string $first, string $operator, string $second)

Добавить условие "правое соединение с where" к запросу.

from Builder
Builder|Builder crossJoin(string $table, string|null $first = null, string|null $operator = null, string|null $second = null)

Добавить условие "внешнее соединение" к запросу.

from Builder
void mergeWheres(array $wheres, array $bindings)

Объединить массив условий where и связывающих элементов.

from Builder
$this where(string|array|Closure $column, string|null $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие where к запросу.

from Builder
$this addArrayOfWheres(array $column, string $boolean, string $method = 'where')

Добавить массив условий where к запросу.

from Builder
array prepareValueAndOperator(string $value, string $operator, bool $useDefault = false)

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

from Builder
bool invalidOperatorAndValue(string $operator, mixed $value)

Определить, является ли данная комбинация оператора и значения корректной.

from Builder
bool invalidOperator(string $operator)

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

from Builder
Builder|Builder orWhere(string|array|Closure $column, string|null $operator = null, mixed $value = null)

Добавить условие "или где" к запросу.

from Builder
Builder|Builder whereColumn(string|array $first, string|null $operator = null, string|null $second = null, string|null $boolean = 'and')

Добавить условие "where" для сравнения двух столбцов к запросу.

from Builder
Builder|Builder orWhereColumn(string|array $first, string|null $operator = null, string|null $second = null)

Добавить условие "или где" для сравнения двух столбцов к запросу.

from Builder
$this whereRaw(string $sql, mixed $bindings = [], string $boolean = 'and')

Добавить сырое условие where к запросу.

from Builder
Builder|Builder orWhereRaw(string $sql, mixed $bindings = [])

Добавить условие «или где» (raw or where) к запросу.

из Builder
$this whereIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)

Добавить условие «где в» (where in) к запросу.

из Builder
Builder|Builder orWhereIn(string $column, mixed $values)

Добавить условие «или где в» (or where in) к запросу.

из Builder
Builder|Builder whereNotIn(string $column, mixed $values, string $boolean = 'and')

Добавить условие «где не в» (where not in) к запросу.

из Builder
Builder|Builder orWhereNotIn(string $column, mixed $values)

Добавить условие «или где не в» (or where not in) к запросу.

из Builder
$this whereInSub(string $column, Closure $callback, string $boolean, bool $not)

Добавить условие «где в» (where in) с подзапросом к запросу.

из Builder
$this whereInExistingQuery(string $column, Builder|Builder $query, string $boolean, bool $not)

Добавить внешний подзапрос к запросу.

из Builder
$this whereNull(string $column, string $boolean = 'and', bool $not = false)

Добавить условие «где null» (where null) к запросу.

из Builder
Builder|Builder orWhereNull(string $column)

Добавить условие «или где null» (or where null) к запросу.

из Builder
Builder|Builder whereNotNull(string $column, string $boolean = 'and')

Добавить условие «где не null» (where not null) к запросу.

из Builder
$this whereBetween(string $column, array $values, string $boolean = 'and', bool $not = false)

Добавить условие «где между» (where between) к запросу.

из Builder
Builder|Builder orWhereBetween(string $column, array $values)

Добавить условие «или где между» (or where between) к запросу.

из Builder
Builder|Builder whereNotBetween(string $column, array $values, string $boolean = 'and')

Добавить условие «не между» в запрос.

из Builder
Builder|Builder orWhereNotBetween(string $column, array $values)

Добавить условие «или не между» в запрос.

из Builder
Builder|Builder orWhereNotNull(string $column)

Добавить условие «или не равно null» в запрос.

из Builder
Builder|Builder whereDate(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

из Builder
Builder|Builder orWhereDate(string $column, string $operator, string $value)

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

из Builder
Builder|Builder whereTime(string $column, string $operator, int $value, string $boolean = 'and')

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

из Builder
Builder|Builder orWhereTime(string $column, string $operator, int $value)

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

из Builder
Builder|Builder whereDay(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

из Builder
Builder|Builder whereMonth(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

из Builder
Builder|Builder whereYear(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

из Builder
$this addDateBasedWhere(string $type, string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие, основанное на дате (год, месяц, день, время), в запрос.

из Builder
Builder|Builder whereNested(Closure $callback, string $boolean = 'and')

Добавить вложенное условие where к запросу.

from Builder
Builder forNestedWhere()

Создать новый экземпляр запроса для вложенного условия where.

from Builder
$this addNestedWhereQuery(Builder|Builder $query, string $boolean = 'and')

Добавить другой объект Query Builder как вложенное условие where к объекту Query Builder.

from Builder
$this whereSub(string $column, string $operator, Closure $callback, string $boolean)

Добавить полный подзапрос к запросу.

from Builder
$this whereExists(Closure $callback, string $boolean = 'and', bool $not = false)

Добавить условие exists к запросу.

from Builder
Builder|Builder orWhereExists(Closure $callback, bool $not = false)

Добавить условие or exists к запросу.

from Builder
Builder|Builder whereNotExists(Closure $callback, string $boolean = 'and')

Добавить условие where not exists к запросу.

from Builder
Builder|Builder orWhereNotExists(Closure $callback)

Добавить условие or where not exists к запросу.

from Builder
$this addWhereExistsQuery(Builder $query, string $boolean = 'and', bool $not = false)

Добавить условие exists к запросу.

from Builder
$this dynamicWhere(string $method, string $parameters)

Обрабатывает динамические условия where для запроса.

from Builder
void addDynamic(string $segment, string $connector, array $parameters, int $index)

Добавить одно динамическое условие where в запрос.

from Builder
$this groupBy(array $groups)

Добавить условие "group by" к запросу.

from Builder
$this having(string $column, string|null $operator = null, string|null $value = null, string $boolean = 'and')

Добавить условие "having" к запросу.

из Builder
Builder|Builder orHaving(string $column, string|null $operator = null, string|null $value = null)

Добавить условие "or having" к запросу.

из Builder
$this havingRaw(string $sql, array $bindings = [], string $boolean = 'and')

Добавить условие having в сыром виде к запросу.

из Builder
Builder|Builder orHavingRaw(string $sql, array $bindings = [])

Добавить условие "or having" в сыром виде к запросу.

из Builder
$this orderBy(string $column, string $direction = 'asc')

Добавить условие "order by" к запросу.

из Builder
$this orderByDesc(string $column)

Добавить условие "order by" по убыванию к запросу.

из Builder
Builder|Builder latest(string $column = 'created_at')

Добавить условие "order by" для временной метки в запрос.

из Builder
Builder|Builder oldest(string $column = 'created_at')

Добавить условие "order by" для временной метки в запрос.

из Builder
$this inRandomOrder(string $seed = '')

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

из Builder
$this orderByRaw(string $sql, array $bindings = [])

Добавить условие "order by" в сыром виде к запросу.

из Builder
Builder|Builder skip(int $value)

Псевдоним для установки значения "offset" запроса.

из Builder
$this offset(int $value)

Установить значение "offset" запроса.

из Builder
Builder|Builder take(int $value)

Псевдоним для установки значения "limit" запроса.

из Builder
$this limit(int $value)

Установить значение "limit" запроса.

из Builder
Builder|Builder forPage(int $page, int $perPage = 15)

Установить лимит и смещение для заданной страницы.

from Builder
Builder|Builder forPageAfterId(int $perPage = 15, int $lastId, string $column = 'id')

Ограничить запрос следующей "страницей" результатов после заданного ID.

from Builder
array removeExistingOrdersFor(string $column)

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

from Builder
Builder|Builder union(Builder|Closure $query, bool $all = false)

Добавить оператор объединения к запросу.

from Builder
Builder|Builder unionAll(Builder|Closure $query)

Добавить оператор объединения all к запросу.

from Builder
$this lock(string|bool $value = true)

Заблокировать выбранные строки в таблице.

from Builder
Builder lockForUpdate()

Заблокировать выбранные строки в таблице для обновления.

from Builder
Builder sharedLock()

Разделить блокировку выбранных строк в таблице.

from Builder
string toSql()

Получить SQL представление запроса.

from Builder
mixed|Builder find(int $id, array $columns = ['*'])

Выполнить запрос для получения одной записи по ID.

from Builder
mixed value(string $column)

Получить значение одного столбца из первого результата запроса.

from Builder
Collection get(array $columns = ['*'])

Выполнить запрос как оператор «select».

from Builder
array runSelect()

Выполнить запрос как оператор «select» относительно подключения.

from Builder
LengthAwarePaginator paginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить заданный запрос на страницы с помощью пагинатора.

from Builder
Paginator simplePaginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Получить пагинатор, поддерживающий только простые ссылки «следующая» и «предыдущая».

from Builder
int getCountForPagination(array $columns = ['*'])

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

from Builder
array runPaginationCountQuery(array $columns = ['*'])

Выполнить запрос для подсчёта страниц.

from Builder
array withoutSelectAliases(array $columns)

Удалить псевдонимы столбцов, так как они нарушают запросы подсчёта.

from Builder
Generator cursor()

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

from Builder
bool chunkById(int $count, callable $callback, string $column = 'id', string $alias = null)

Разбить результаты запроса на куски, сравнивая числовые идентификаторы.

from Builder
void enforceOrderBy()

Выбросить исключение, если в запросе отсутствует условие orderBy.

from Builder
Collection pluck(string $column, string|null $key = null)

Получить массив со значениями заданного столбца.

from Builder
string|null stripTableForPluck(string $column)

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

from Builder
string implode(string $column, string $glue = '')

Сконкатенировать значения заданного столбца в строку.

from Builder
bool exists()

Определить, существуют ли какие-либо строки для текущего запроса.

from Builder
int count(string $columns = '*')

Получить результат «количество» запроса.

from Builder
mixed min(string $column)

Получить минимальное значение заданного столбца.

from Builder
mixed max(string $column)

Получить максимальное значение заданного столбца.

from Builder
mixed sum(string $column)

Получить сумму значений заданного столбца.

из Builder
mixed avg(string $column)

Получить среднее значение значений заданного столбца.

из Builder
mixed average(string $column)

Псевдоним для метода «avg».

из Builder
mixed aggregate(string $function, array $columns = ['*'])

Выполнить агрегатную функцию в базе данных.

из Builder
float|int numericAggregate(string $function, array $columns = ['*'])

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

из Builder
$this setAggregate(string $function, array $columns)

Установить свойство агрегации без выполнения запроса.

из Builder
bool insert(array $values)

Вставить новую запись в базу данных.

из Builder
int insertGetId(array $values, string|null $sequence = null)

Вставить новую запись и получить значение первичного ключа.

из Builder
int update(array $values)

Обновить запись в базе данных.

из Builder
bool updateOrInsert(array $attributes, array $values = [])

Вставить или обновить запись, соответствующую атрибутам, и заполнить ее значениями.

из Builder
int increment(string $column, int $amount = 1, array $extra = [])

Увеличить значение столбца на заданную величину.

из Builder
int decrement(string $column, int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданную величину.

из Builder
int delete(mixed $id = null)

Удалить запись из базы данных.

из Builder
void truncate()

Выполнить операцию обнуления таблицы.

из Builder
Builder newQuery()

Получить новый экземпляр билдера для условия объединения.

Builder forSubQuery()

Создать новый экземпляр запроса для подзапроса.

Expression raw(mixed $value)

Создать выражение базы данных в сыром виде.

из Builder
массив getBindings()

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

из Builder
массив getRawBindings()

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

из Builder
$this setBindings(массив $bindings, строка $type = 'where')

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

из Builder
$this addBinding(смешанное $value, строка $type = 'where')

Добавить связываемые данные к запросу.

из Builder
$this mergeBindings(Builder $query)

Объединить массив связываемых данных в наши связываемые данные.

из Builder
массив cleanBindings(массив $bindings)

Удалить все выражения из списка связываемых данных.

из Builder
ConnectionInterface getConnection()

Получить экземпляр подключения к базе данных.

из Builder
Processor getProcessor()

Получить экземпляр обработчика запросов базы данных.

из Builder
Grammar getGrammar()

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

из Builder
$this useWritePdo()

Использовать write pdo для запроса.

из Builder
Builder cloneWithout(массив $properties)

Клонировать запрос без указанных свойств.

из Builder
Builder cloneWithoutBindings(массив $except)

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

из Builder
$this on(Closure|строка $first, строка|null $operator = null, строка|null $second = null, строка $boolean = 'and')

Добавить условие "on" к объединению.

JoinClause orOn(Closure|строка $first, строка|null $operator = null, строка|null $second = null)

Добавить условие "или on" к объединению.

Подробности

логическое значение chunk(целое число $count, вызываемый объект $callback)

Разбить результаты запроса на части.

Параметры

целое число $count
вызываемый объект $callback

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

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

bool each(callable $callback, int $count = 1000)

Выполнить обратный вызов над каждым элементом с разбиением на части.

Параметры

callable $callback
int $count

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

bool

Модель|BuildsQueries|null first(array $columns = ['*'])

Выполнить запрос и получить первый результат.

Параметры

array $columns

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

Модель|BuildsQueries|null

mixed when(mixed $value, callable $callback, callable $default = null)

Применить изменения запроса обратного вызова, если заданное «значение» истинно.

Параметры

mixed $value
callable $callback
callable $default

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

mixed

Построитель tap(Closure $callback)

Передать запрос в заданный обратный вызов.

Параметры

Closure $callback

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

Построитель

mixed unless(mixed $value, callable $callback, callable $default = null)

Применить изменения запроса обратного вызова, если заданное «значение» ложно.

Параметры

mixed $value
callable $callback
callable $default

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

mixed

protected LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)

Создать новый экземпляр страниц с учётом размера.

Параметры

Collection $items
int $total
int $perPage
int $currentPage
array $options

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

LengthAwarePaginator

protected Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)

Создать новый экземпляр простой системы пагинации.

Параметры

Collection $items
int $perPage
int $currentPage
array $options

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

Paginator

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

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

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

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

Parameters

object $mixin

Return Value

void

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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

void __construct(Builder $parentQuery, string $type, string $table)

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

Parameters

Builder $parentQuery
string $type
string $table

Return Value

void

$this select(array|mixed $columns = ['*'])

Установить столбцы для выбора.

Parameters

array|mixed $columns

Return Value

$this

Builder|Builder selectRaw(string $expression, array $bindings = [])

Добавить новое выражение "raw" выбора в запрос.

Parameters

string $expression
array $bindings

Return Value

Builder|Builder

Builder|Builder selectSub(Closure|Builder|string $query, string $as)

Добавить выражение подзапроса в запрос.

Параметры

Closure|Builder|string $query
string $as

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

Builder|Builder

Исключения

InvalidArgumentException

protected array parseSubSelect(mixed $query)

Обработать подзапрос в SQL и параметры.

Параметры

mixed $query

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

array

$this addSelect(array|mixed $column)

Добавить новый столбец выбора в запрос.

Параметры

array|mixed $column

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

$this

$this distinct()

Выбрать только уникальные результаты.

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

$this

$this from(string $table)

Указать таблицу для запроса.

Параметры

string $table

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

$this

$this join(string $table, string $first, string|null $operator = null, string|null $second = null, string $type = 'inner', bool $where = false)

Добавить условие объединения к запросу.

Параметры

string $table
string $first
string|null $operator
string|null $second
string $type
bool $where

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

$this

Builder|Builder joinWhere(string $table, string $first, string $operator, string $second, string $type = 'inner')

Добавить условие объединения с проверкой к запросу.

Параметры

string $table
string $first
string $operator
string $second
string $type

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

Builder|Builder

Builder|Builder leftJoin(string $table, string $first, string|null $operator = null, string|null $second = null)

Добавить левое соединение к запросу.

Parameters

string $table
string $first
string|null $operator
string|null $second

Return Value

Builder|Builder

Builder|Builder leftJoinWhere(string $table, string $first, string $operator, string $second)

Добавить условие "join where" к запросу.

Parameters

string $table
string $first
string $operator
string $second

Return Value

Builder|Builder

Builder|Builder rightJoin(string $table, string $first, string|null $operator = null, string|null $second = null)

Добавить правое соединение к запросу.

Parameters

string $table
string $first
string|null $operator
string|null $second

Return Value

Builder|Builder

Builder|Builder rightJoinWhere(string $table, string $first, string $operator, string $second)

Добавить условие "right join where" к запросу.

Parameters

string $table
string $first
string $operator
string $second

Return Value

Builder|Builder

Builder|Builder crossJoin(string $table, string|null $first = null, string|null $operator = null, string|null $second = null)

Добавить условие "cross join" к запросу.

Parameters

string $table
string|null $first
string|null $operator
string|null $second

Return Value

Builder|Builder

void mergeWheres(array $wheres, array $bindings)

Объединить массив условий и привязок.

Parameters

array $wheres
array $bindings

Return Value

void

$this where(string|array|Closure $column, string|null $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие where в запрос.

Параметры

string|array|Closure $column
string|null $operator
mixed $value
string $boolean

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

$this

protected $this addArrayOfWheres(array $column, string $boolean, string $method = 'where')

Добавить массив условий where в запрос.

Параметры

array $column
string $boolean
string $method

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

$this

protected array prepareValueAndOperator(string $value, string $operator, bool $useDefault = false)

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

Параметры

string $value
string $operator
bool $useDefault

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

array

Исключения

InvalidArgumentException

protected bool invalidOperatorAndValue(string $operator, mixed $value)

Определить, является ли комбинация оператора и значения допустимой.

Предотвращает использование Null-значений с недопустимыми операторами.

Параметры

string $operator
mixed $value

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

bool

protected bool invalidOperator(string $operator)

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

Параметры

string $operator

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

bool

Builder|Builder orWhere(string|array|Closure $column, string|null $operator = null, mixed $value = null)

Добавить условие "or where" к запросу.

Параметры

string|array|Closure $column
string|null $operator
mixed $value

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

Builder|Builder

Builder|Builder whereColumn(string|array $first, string|null $operator = null, string|null $second = null, string|null $boolean = 'and')

Добавить условие "where" для сравнения двух столбцов к запросу.

Параметры

string|array $first
string|null $operator
string|null $second
string|null $boolean

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

Builder|Builder
END_OF_DOCUMENT_MARKER

Builder|Builder orWhereColumn(string|array $first, string|null $operator = null, string|null $second = null)

Добавить условие "или где" сравнивая два столбца в запросе.

Parameters

string|array $first
string|null $operator
string|null $second

Return Value

Builder|Builder

$this whereRaw(string $sql, mixed $bindings = [], string $boolean = 'and')

Добавить сырое условие "где" в запрос.

Parameters

string $sql
mixed $bindings
string $boolean

Return Value

$this

Builder|Builder orWhereRaw(string $sql, mixed $bindings = [])

Добавить сырое условие "или где" в запрос.

Parameters

string $sql
mixed $bindings

Return Value

Builder|Builder

$this whereIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)

Добавить условие "в" в запрос.

Parameters

string $column
mixed $values
string $boolean
bool $not

Return Value

$this

Builder|Builder orWhereIn(string $column, mixed $values)

Добавить условие "или в" в запрос.

Parameters

string $column
mixed $values

Return Value

Builder|Builder

Builder|Builder whereNotIn(string $column, mixed $values, string $boolean = 'and')

Добавить условие "не в" в запрос.

Parameters

string $column
mixed $values
string $boolean

Return Value

Builder|Builder

Builder|Builder orWhereNotIn(string $column, mixed $values)

Добавить условие "или не в" в запрос.

Parameters

string $column
mixed $values

Return Value

Builder|Builder

protected $this whereInSub(string $column, Closure $callback, string $boolean, bool $not)

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

Parameters

string $column
Closure $callback
string $boolean
bool $not

Return Value

$this

protected $this whereInExistingQuery(string $column, Builder|Builder $query, string $boolean, bool $not)

Добавить внешний подзапрос к запросу.

Parameters

string $column
Builder|Builder $query
string $boolean
bool $not

Return Value

$this

$this whereNull(string $column, string $boolean = 'and', bool $not = false)

Добавить условие "where null" к запросу.

Parameters

string $column
string $boolean
bool $not

Return Value

$this

Builder|Builder orWhereNull(string $column)

Добавить условие "or where null" к запросу.

Parameters

string $column

Return Value

Builder|Builder

Builder|Builder whereNotNull(string $column, string $boolean = 'and')

Добавить условие "where not null" к запросу.

Parameters

string $column
string $boolean

Return Value

Builder|Builder

$this whereBetween(string $column, array $values, string $boolean = 'and', bool $not = false)

Добавить условие where between к запросу.

Parameters

string $column
array $values
string $boolean
bool $not

Return Value

$this

Builder|Builder orWhereBetween(string $column, array $values)

Добавить условие or where between к запросу.

Parameters

string $column
array $values

Return Value

Builder|Builder

Builder|Builder whereNotBetween(string $column, array $values, string $boolean = 'and')

Добавить условие where not between в запрос.

Параметры

string $column
array $values
string $boolean

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

Builder|Builder

Builder|Builder orWhereNotBetween(string $column, array $values)

Добавить условие or where not between в запрос.

Параметры

string $column
array $values

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

Builder|Builder

Builder|Builder orWhereNotNull(string $column)

Добавить условие "or where not null" в запрос.

Параметры

string $column

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

Builder|Builder

Builder|Builder whereDate(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "where date" в запрос.

Параметры

string $column
string $operator
mixed $value
string $boolean

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

Builder|Builder

Builder|Builder orWhereDate(string $column, string $operator, string $value)

Добавить условие "or where date" в запрос.

Параметры

string $column
string $operator
string $value

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

Builder|Builder

Builder|Builder whereTime(string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие "where time" в запрос.

Параметры

string $column
string $operator
int $value
string $boolean

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

Builder|Builder

Builder|Builder orWhereTime(string $column, string $operator, int $value)

Добавить условие "или где время" в запрос.

Параметры

string $column
string $operator
int $value

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

Builder|Builder

Builder|Builder whereDay(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "где день" в запрос.

Параметры

string $column
string $operator
mixed $value
string $boolean

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

Builder|Builder

Builder|Builder whereMonth(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "где месяц" в запрос.

Параметры

string $column
string $operator
mixed $value
string $boolean

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

Builder|Builder

Builder|Builder whereYear(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "где год" в запрос.

Параметры

string $column
string $operator
mixed $value
string $boolean

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

Builder|Builder

protected $this addDateBasedWhere(string $type, string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие, основанное на дате (год, месяц, день, время), в запрос.

Параметры

string $type
string $column
string $operator
int $value
string $boolean

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

$this

Builder|Builder whereNested(Closure $callback, string $boolean = 'and')

Добавить вложенное условие в запрос.

Параметры

Closure $callback
string $boolean

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

Builder|Builder

Builder forNestedWhere()

Создать новый экземпляр запроса для вложенного условия where.

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

Builder

$this addNestedWhereQuery(Builder|Builder $query, string $boolean = 'and')

Добавить другой объект-строитель запроса как вложенное условие where к объекту-строителю запроса.

Параметры

Builder|Builder $query
string $boolean

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

$this

protected $this whereSub(string $column, string $operator, Closure $callback, string $boolean)

Добавить полный подзапрос к запросу.

Параметры

string $column
string $operator
Closure $callback
string $boolean

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

$this

$this whereExists(Closure $callback, string $boolean = 'and', bool $not = false)

Добавить условие exists к запросу.

Параметры

Closure $callback
string $boolean
bool $not

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

$this

Builder|Builder orWhereExists(Closure $callback, bool $not = false)

Добавить условие or exists к запросу.

Параметры

Closure $callback
bool $not

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

Builder|Builder

Builder|Builder whereNotExists(Closure $callback, string $boolean = 'and')

Добавить условие where not exists к запросу.

Параметры

Closure $callback
string $boolean

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

Builder|Builder

Builder|Builder orWhereNotExists(Closure $callback)

Добавить условие or where not exists к запросу.

Параметры

Closure $callback

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

Builder|Builder

$this addWhereExistsQuery(Builder $query, string $boolean = 'and', bool $not = false)

Добавить условие exists к запросу.

Параметры

Builder $query
string $boolean
bool $not

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

$this

$this dynamicWhere(string $method, string $parameters)

Обрабатывает динамические условия "where" для запроса.

Параметры

string $method
string $parameters

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

$this

protected void addDynamic(string $segment, string $connector, array $parameters, int $index)

Добавить одно динамическое условие where в запрос.

Параметры

string $segment
string $connector
array $parameters
int $index

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

void

$this groupBy(array $groups)

Добавить условие "group by" к запросу.

Параметры

array $groups

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

$this

$this having(string $column, string|null $operator = null, string|null $value = null, string $boolean = 'and')

Добавить условие "having" к запросу.

Параметры

string $column
string|null $operator
string|null $value
string $boolean

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

$this

Builder|Builder orHaving(string $column, string|null $operator = null, string|null $value = null)

Добавить условие "or having" к запросу.

Параметры

string $column
string|null $operator
string|null $value

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

Builder|Builder

$this havingRaw(string $sql, array $bindings = [], string $boolean = 'and')

Добавить сырое условие having к запросу.

Параметры

string $sql
array $bindings
string $boolean

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

$this

Builder|Builder orHavingRaw(string $sql, array $bindings = [])

Добавить сырое условие or having к запросу.

Параметры

string $sql
array $bindings

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

Builder|Builder

$this orderBy(string $column, string $direction = 'asc')

Добавить в запрос условие «упорядочить по».

Параметры

string $column
string $direction

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

$this

$this orderByDesc(string $column)

Добавить в запрос условие «упорядочить по убыванию».

Параметры

string $column

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

$this

Builder|Builder latest(string $column = 'created_at')

Добавить в запрос условие «упорядочить по» для временной метки.

Параметры

string $column

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

Builder|Builder

Builder|Builder oldest(string $column = 'created_at')

Добавить в запрос условие «упорядочить по» для временной метки.

Параметры

string $column

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

Builder|Builder

$this inRandomOrder(string $seed = '')

Вывести результаты запроса в случайном порядке.

Параметры

string $seed

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

$this

$this orderByRaw(string $sql, array $bindings = [])

Добавить в запрос условие «упорядочить по» с использованием SQL выражения.

Параметры

string $sql
array $bindings

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

$this

Builder|Builder skip(int $value)

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

Параметры

int $value

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

Builder|Builder

$this offset(int $value)

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

Параметры

int $value

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

$this

Builder|Builder take(int $value)

Псевдоним для установки значения «лимита» запроса.

Параметры

int $value

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

Builder|Builder

$this limit(int $value)

Установить значение "limit" запроса.

Параметры

int $value

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

$this

Builder|Builder forPage(int $page, int $perPage = 15)

Установить лимит и смещение для заданной страницы.

Параметры

int $page
int $perPage

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

Builder|Builder

Builder|Builder forPageAfterId(int $perPage = 15, int $lastId, string $column = 'id')

Ограничить запрос следующей "страницей" результатов после заданного ID.

Параметры

int $perPage
int $lastId
string $column

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

Builder|Builder

protected array removeExistingOrdersFor(string $column)

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

Параметры

string $column

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

array

Builder|Builder union(Builder|Closure $query, bool $all = false)

Добавить оператор объединения в запрос.

Параметры

Builder|Closure $query
bool $all

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

Builder|Builder

Builder|Builder unionAll(Builder|Closure $query)

Добавить оператор объединения all в запрос.

Параметры

Builder|Closure $query

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

Builder|Builder

$this lock(string|bool $value = true)

Заблокировать выбранные строки в таблице.

Параметры

string|bool $value

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

$this

Builder lockForUpdate()

Заблокировать выбранные строки в таблице для обновления.

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

Builder

Builder sharedLock()

Заблокировать выбранные строки в таблице по принципу совместного доступа.

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

Builder

string toSql()

Получить SQL-представление запроса.

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

string

mixed|Builder find(int $id, array $columns = ['*'])

Выполнить запрос для получения одной записи по ID.

Параметры

int $id
array $columns

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

mixed|Builder

mixed value(string $column)

Получить значение одного столбца из первого результата запроса.

Параметры

string $column

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

mixed

Collection get(array $columns = ['*'])

Выполнить запрос как операцию "select".

Параметры

array $columns

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

Collection

protected array runSelect()

Выполнить запрос как операцию "select" к соединению.

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

array

LengthAwarePaginator paginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить запрос на страницы с помощью пагинатора.

Параметры

int $perPage
array $columns
string $pageName
int|null $page

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

LengthAwarePaginator

Paginator simplePaginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Получить пагинатор, поддерживающий только простые ссылки "следующая" и "предыдущая".

Более эффективно для больших наборов данных.

Параметры

int $perPage
array $columns
string $pageName
int|null $page

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

Paginator

int getCountForPagination(array $columns = ['*'])

Получить количество записей для пагинации.

Параметры

array $columns

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

int

protected array runPaginationCountQuery(array $columns = ['*'])

Выполнить запрос подсчёта для пагинации.

Параметры

array $columns

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

array

protected array withoutSelectAliases(array $columns)

Удалить псевдонимы столбцов, так как они могут нарушить работу запросов подсчёта.

Параметры

array $columns

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

array

Генератор cursor()

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

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

Генератор

bool chunkById(int $count, callable $callback, string $column = 'id', string $alias = null)

Разбить результаты запроса на части по численным идентификаторам.

Параметры

int $count
callable $callback
string $column
string $alias

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

bool

protected void enforceOrderBy()

Выбросить исключение, если в запросе нет порядка сортировки.

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

void

Исключения

RuntimeException

Коллекция pluck(string $column, string|null $key = null)

Получить массив с значениями заданного столбца.

Параметры

string $column
string|null $key

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

Коллекция

protected string|null stripTableForPluck(string $column)

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

Параметры

string $column

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

string|null

string implode(string $column, string $glue = '')

Склеить значения заданного столбца в строку.

Параметры

string $column
string $glue

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

string

bool exists()

Определить, существуют ли строки для текущего запроса.

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

bool

int count(string $columns = '*')

Получить результат "счёт" запроса.

Параметры

string $columns

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

int

mixed min(string $column)

Получить минимальное значение заданного столбца.

Parameters

string $column

Return Value

mixed

mixed max(string $column)

Получить максимальное значение заданного столбца.

Parameters

string $column

Return Value

mixed

mixed sum(string $column)

Получить сумму значений заданного столбца.

Parameters

string $column

Return Value

mixed

mixed avg(string $column)

Получить среднее значение значений заданного столбца.

Parameters

string $column

Return Value

mixed

mixed average(string $column)

Псевдоним для метода "avg".

Parameters

string $column

Return Value

mixed

mixed aggregate(string $function, array $columns = ['*'])

Выполнить агрегатную функцию в базе данных.

Parameters

string $function
array $columns

Return Value

mixed

float|int numericAggregate(string $function, array $columns = ['*'])

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

Parameters

string $function
array $columns

Return Value

float|int

protected $this setAggregate(string $function, array $columns)

Установить свойство агрегации без выполнения запроса.

Parameters

string $function
array $columns

Return Value

$this

bool insert(array $values)

Вставить новую запись в базу данных.

Parameters

array $values

Return Value

bool

int insertGetId(array $values, string|null $sequence = null)

Вставить новую запись и получить значение первичного ключа.

Parameters

array $values
string|null $sequence

Return Value

int

int update(array $values)

Обновить запись в базе данных.

Parameters

array $values

Return Value

int

bool updateOrInsert(array $attributes, array $values = [])

Вставить или обновить запись, соответствующую атрибутам, и заполнить её значениями.

Параметры

array $attributes
array $values

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

bool

int increment(string $column, int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.

Параметры

string $column
int $amount
array $extra

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

int

int decrement(string $column, int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.

Параметры

string $column
int $amount
array $extra

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

int

int delete(mixed $id = null)

Удалить запись из базы данных.

Параметры

mixed $id

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

int

void truncate()

Выполнить операцию truncate для таблицы.

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

void

Builder newQuery()

Получить новый экземпляр билдера для объединения.

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

Builder

protected Builder forSubQuery()

Создать новый экземпляр запроса для подзапроса.

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

Builder

Expression raw(mixed $value)

Создать выражение для базы данных в сыром виде.

Параметры

mixed $value

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

Expression

array getBindings()

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

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

array

array getRawBindings()

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

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

array

$this setBindings(array $bindings, string $type = 'where')

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

Параметры

array $bindings
string $type

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

$this

Исключения

InvalidArgumentException

$this addBinding(mixed $value, string $type = 'where')

Добавить привязку к запросу.

Параметры

mixed $value
string $type

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

$this

Исключения

InvalidArgumentException

$this mergeBindings(Builder $query)

Объединить массив привязок в наши привязки.

Параметры

Builder $query

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

$this

protected array cleanBindings(array $bindings)

Удалить все выражения из списка привязок.

Параметры

array $bindings

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

array

ConnectionInterface getConnection()

Получить экземпляр подключения к базе данных.

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

ConnectionInterface

Processor getProcessor()

Получить экземпляр обработчика запросов базы данных.

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

Processor

Grammar getGrammar()

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

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

Grammar

$this useWritePdo()

Использовать write pdo для запроса.

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

$this

Builder cloneWithout(array $properties)

Клонировать запрос без указанных свойств.

Параметры

array $properties

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

Builder

Builder cloneWithoutBindings(array $except)

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

Параметры

array $except

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

Builder

$this on(Closure|string $first, string|null $operator = null, string|null $second = null, string $boolean = 'and')

Добавить условие "on" к объединению.

Условие "on" можно объединять, например:

$join->on('contacts.user_id', '=', 'users.id') ->on('contacts.info_id', '=', 'info.id')

что приведет к следующему SQL:

on contacts.user_id = users.id and contacts.info_id = info.id

Параметры

Closure|string $first
string|null $operator
string|null $second
string $boolean

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

$this

Исключения

InvalidArgumentException

JoinClause orOn(Closure|string $first, string|null $operator = null, string|null $second = null)

Добавить условие "или on" к объединению.

Параметры

Closure|string $first
string|null $operator
string|null $second

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

JoinClause

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

Spec-Zone.ru

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