Spec-Zone.ru › Laravel 5.4

Builder

class Builder (View source)

Traits

BuildsQueries
Macroable

Свойства

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

Методы

bool chunk(int $count, callable $callback)

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

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

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

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

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

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

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

 из BuildsQueries
Билдер tap(Closure $callback)

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

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

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

 из BuildsQueries
LengthAwarePaginator paginator(Коллекция $items, int $total, int $perPage, int $currentPage, array $options)

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

 из BuildsQueries
Paginator simplePaginator(Коллекция $items, int $perPage, int $currentPage, array $options)

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

 из BuildsQueries
static void macro(string $name, callable $macro)

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

 из Macroable
static bool hasMacro(string $name)

Проверка регистрации макроса.

 из Macroable
static mixed __callStatic(string $method, array $parameters)

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

 из Macroable
mixed __call(string $method, array $parameters)

Обработка динамических вызовов метода.
void __construct(Интерфейс подключения $connection, Grammar $grammar = null, Processor $processor = null)

Создать новый экземпляр билдера запроса.
$this select(array|mixed $columns = ['*'])

Установить столбцы для выбора.
Билдер|Билдер selectRaw(string $expression, array $bindings = [])

Добавить новое выражение "raw" для выбора в запрос.
Билдер|Билдер selectSub(Closure|Билдер|string $query, string $as)

Добавить подзапрос в выражение запроса.
array parseSubSelect(mixed $query)

Разбирать подзапрос в SQL и параметры.
$this addSelect(array|mixed $column)

Добавить новый столбец выбора в запрос.
$this distinct()

Вынужденно возвращать только уникальные результаты.
$this from(string $table)

Установить таблицу, на которую нацелен запрос.
$this join(string $table, string $first, string $operator = null, string $second = null, string $type = 'inner', bool $where = false)

Добавить условие объединения в запрос.
Билдер|Билдер joinWhere(string $table, string $first, string $operator, string $second, string $type = 'inner')

Добавить условие "join where" в запрос.
Билдер|Билдер leftJoin(string $table, string $first, string $operator = null, string $second = null)

Добавить левое соединение в запрос.
Билдер|Билдер leftJoinWhere(string $table, string $first, string $operator, string $second)

Добавить условие "join where" в запрос.
Билдер|Билдер rightJoin(string $table, string $first, string $operator = null, string $second = null)

Добавить правое соединение в запрос.
Билдер|Билдер rightJoinWhere(string $table, string $first, string $operator, string $second)

Добавить условие "right join where" в запрос.
Билдер|Билдер crossJoin(string $table, string $first = null, string $operator = null, string $second = null)

Добавить условие "cross join" в запрос.
void mergeWheres(array $wheres, array $bindings)

Объединить массив условий и параметров.
$this where(string|array|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие "where" в запрос.
$this addArrayOfWheres(array $column, string $boolean, string $method = 'where')

Добавить массив условий "where" в запрос.
array prepareValueAndOperator(string $value, string $operator, bool $useDefault = false)

Подготовить значение и оператор для условия "where".
bool invalidOperatorAndValue(string $operator, mixed $value)

Определить, является ли данная комбинация оператора и значения законной.
bool invalidOperator(string $operator)

Определить, поддерживается ли данный оператор.
Builder|Builder orWhere(string|array|Closure $column, string $operator = null, mixed $value = null)

Добавить условие «или где» к запросу.
Builder|Builder whereColumn(string|array $first, string|null $operator = null, string|null $second = null, string|null $boolean = 'and')

Добавить условие «где» для сравнения двух столбцов к запросу.
Builder|Builder orWhereColumn(string|array $first, string|null $operator = null, string|null $second = null)

Добавить условие «или где» для сравнения двух столбцов к запросу.
$this whereRaw(string $sql, mixed $bindings = [], string $boolean = 'and')

Добавить сырое условие «где» к запросу.
Builder|Builder orWhereRaw(string $sql, mixed $bindings = [])

Добавить сырое условие «или где» к запросу.
$this whereIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)

Добавить условие «где в» к запросу.
Builder|Builder orWhereIn(string $column, mixed $values)

Добавить условие «или где в» к запросу.
Builder|Builder whereNotIn(string $column, mixed $values, string $boolean = 'and')

Добавить условие «где не в» к запросу.
Builder|Builder orWhereNotIn(string $column, mixed $values)

Добавить условие «или где не в» к запросу.
$this whereInSub(string $column, Closure $callback, string $boolean, bool $not)

Добавить условие «где в» с подзапросом к запросу.
$this whereInExistingQuery(string $column, Builder|Builder $query, string $boolean, bool $not)

Добавить внешний подзапрос к запросу.
$this whereNull(string $column, string $boolean = 'and', bool $not = false)

Добавить условие «где null» к запросу.
Builder|Builder orWhereNull(string $column)

Добавить условие «или где null» к запросу.
Builder|Builder whereNotNull(string $column, string $boolean = 'and')

Добавить условие «где не null» к запросу.
$this whereBetween(string $column, array $values, string $boolean = 'and', bool $not = false)

Добавить условие «где между» к запросу.
Builder|Builder orWhereBetween(string $column, array $values)

Добавить условие «или где между» к запросу.
Builder|Builder whereNotBetween(string $column, array $values, string $boolean = 'and')

Добавить условие «где не между» к запросу.
Builder|Builder orWhereNotBetween(string $column, array $values)

Добавить условие «или где не между» к запросу.
Builder|Builder orWhereNotNull(string $column)

Добавить условие «или где не null» к запросу.
Builder|Builder whereDate(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие «где дата» к запросу.
Builder|Builder orWhereDate(string $column, string $operator, string $value)

Добавить условие «или где дата» к запросу.
Builder|Builder whereTime(string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие «где время» к запросу.
Builder|Builder orWhereTime(string $column, string $operator, int $value)

Добавить условие «или где время» к запросу.
Builder|Builder whereDay(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие «где день» к запросу.
Builder|Builder whereMonth(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие «где месяц» к запросу.
Builder|Builder whereYear(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие «где год» к запросу.
$this addDateBasedWhere(string $type, string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие, основанное на дате (год, месяц, день, время), к запросу.
Builder|Builder whereNested(Closure $callback, string $boolean = 'and')

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

Создать новый экземпляр запроса для вложенного условия.
$this addNestedWhereQuery(Builder|Builder $query, string $boolean = 'and')

Добавить другой конструктор запроса в качестве вложенного условия к конструктору запроса.
$this whereSub(string $column, string $operator, Closure $callback, string $boolean)

Добавить полное подзапрос к запросу.
$this whereExists(Closure $callback, string $boolean = 'and', bool $not = false)

Добавить условие exists к запросу.
Builder|Builder orWhereExists(Closure $callback, bool $not = false)

Добавить условие or exists к запросу.
Builder|Builder whereNotExists(Closure $callback, string $boolean = 'and')

Добавить условие where not exists к запросу.
Builder|Builder orWhereNotExists(Closure $callback)

Добавить условие or where not exists к запросу.
$this addWhereExistsQuery(Builder $query, string $boolean = 'and', bool $not = false)

Добавить условие exists к запросу.
$this dynamicWhere(string $method, string $parameters)

Обрабатывает динамические условия «where» для запроса.
void addDynamic(string $segment, string $connector, array $parameters, int $index)

Добавить отдельное динамическое условие «where» в запрос.
$this groupBy(array $groups)

Добавить условие «group by» к запросу.
$this having(string $column, string $operator = null, string $value = null, string $boolean = 'and')

Добавить условие «having» к запросу.
Builder|Builder orHaving(string $column, string $operator = null, string $value = null)

Добавить условие «or having» к запросу.
$this havingRaw(string $sql, array $bindings = [], string $boolean = 'and')

Добавить сырое условие «having» в запрос.
Builder|Builder orHavingRaw(string $sql, array $bindings = [])

Добавить сырое условие «or having» к запросу.
$this orderBy(string $column, string $direction = 'asc')

Добавить условие «order by» к запросу.
$this orderByDesc(string $column)

Добавить условие «order by» по убыванию к запросу.
Builder|Builder latest(string $column = 'created_at')

Добавить условие «order by» для отметки времени к запросу.
Builder|Builder oldest(string $column = 'created_at')

Добавить условие «order by» для отметки времени к запросу.
$this inRandomOrder(string $seed = '')

Вывести результаты запроса в случайном порядке.
$this orderByRaw(string $sql, array $bindings = [])

Добавить сырое условие «order by» в запрос.
Builder|Builder skip(int $value)

Псевдоним для установки значения «offset» запроса.
$this offset(int $value)

Установить значение «offset» запроса.
Builder|Builder take(int $value)

Псевдоним для установки значения «limit» запроса.
$this limit(int $value)

Установить значение «limit» запроса.
Builder|Builder forPage(int $page, int $perPage = 15)

Установить значение limit и offset для заданной страницы.
Builder|Builder forPageAfterId(int $perPage = 15, int $lastId, string $column = 'id')

Ограничить запрос следующей «страницей» результатов после заданного идентификатора.
array removeExistingOrdersFor(string $column)

Получить массив со всеми удаленными заказами по заданному столбцу.
Builder|Builder union(Builder|Closure $query, bool $all = false)

Добавить оператор union к запросу.
Builder|Builder unionAll(Builder|Closure $query)

Добавить оператор union all к запросу.
$this lock(string|bool $value = true)

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

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

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

Получить SQL представление запроса.
mixed|Builder find(int $id, array $columns = ['*'])

Выполнить запрос для получения одной записи по ID.
mixed value(string $column)

Получить значение одного столбца из первого результата запроса.
Collection get(array $columns = ['*'])

Выполнить запрос в качестве оператора «select».
array runSelect()

Выполнить запрос в качестве оператора «select» на подключении.
LengthAwarePaginator paginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить заданный запрос на страницы с помощью простого пагинатора.
Paginator simplePaginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Получить пагинатор, поддерживающий только простые ссылки «следующая» и «предыдущая».
int getCountForPagination(array $columns = ['*'])

Получить количество всех записей для пагинатора.
array runPaginationCountQuery(array $columns = ['*'])

Выполнить запрос подсчёта для пагинации.
array withoutSelectAliases(array $columns)

Удалить алиасы столбцов, так как они нарушат запросы подсчёта.
Generator cursor()

Получить генератор для заданного запроса.
bool chunkById(int $count, callable $callback, string $column = 'id', string $alias = null)

Разбить результаты запроса на куски по сравнению числовых идентификаторов.
void enforceOrderBy()

Выбросить исключение, если в запросе нет предложения orderBy.
Collection pluck(string $column, string|null $key = null)

Получить массив со значениями заданного столбца.
string|null stripTableForPluck(string $column)

Удалить имя таблицы или псевдоним из идентификатора столбца.
string implode(string $column, string $glue = '')

Объединить значения заданного столбца в строку.
bool exists()

Определить, существуют ли какие-либо строки для текущего запроса.
int count(string $columns = '*')

Получить результат «счёт» запроса.
mixed min(string $column)

Получить минимальное значение заданного столбца.
mixed max(string $column)

Получить максимальное значение заданного столбца.
mixed sum(string $column)

Получить сумму значений заданного столбца.
mixed avg(string $column)

Получить среднее значение значений заданного столбца.
mixed average(string $column)

Псевдоним для метода «avg».
mixed aggregate(string $function, array $columns = ['*'])

Выполнить агрегатную функцию на базе данных.
float|int numericAggregate(string $function, array $columns = ['*'])

Выполнить числовую агрегатную функцию на базе данных.
$this setAggregate(string $function, array $columns)

Установить свойство агрегата без выполнения запроса.
bool insert(array $values)

Вставить новую запись в базу данных.
int insertGetId(array $values, string $sequence = null)

Вставить новую запись и получить значение первичного ключа.
int update(array $values)

Обновить запись в базе данных.
bool updateOrInsert(array $attributes, array $values = [])

Вставить или обновить запись, соответствующую атрибутам, и заполнить её значениями.
int increment(string $column, int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.
int decrement(string $column, int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.
int delete(mixed $id = null)

Удалить запись из базы данных.
void truncate()

Выполнить оператор truncate для таблицы.
Builder newQuery()

Получить новый экземпляр билдера запросов.
Expression raw(mixed $value)

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

Получить текущие параметры запроса в плоском массиве.
array getRawBindings()

Получить сырой массив параметров.
$this setBindings(array $bindings, string $type = 'where')

Установить параметры запроса.
$this addBinding(mixed $value, string $type = 'where')

Добавить параметр запроса.
$this mergeBindings(Builder $query)

Объединить массив параметров в наши параметры.
array cleanBindings(array $bindings)

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

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

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

Получить экземпляр грамматики запроса.
$this useWritePdo()

Использовать write pdo для запроса.
Builder cloneWithout(array $except)

Клонировать запрос без указанных свойств.
Builder cloneWithoutBindings(array $except)

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

Подробности

bool chunk(int $count, callable $callback)

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

Parameters

int $count
callable $callback

Return Value

bool

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

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

Parameters

callable $callback
int $count

Return Value

bool

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

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

Parameters

array $columns

Return Value

Model|BuildsQueries|null

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

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

Parameters

mixed $value
callable $callback
callable $default

Return Value

mixed

Builder tap(Closure $callback)

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

Parameters

Closure $callback

Return Value

Builder

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

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

Parameters

mixed $value
callable $callback
callable $default

Return Value

mixed

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

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

Parameters

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

Return Value

LengthAwarePaginator

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

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

Parameters

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

Return Value

Paginator

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

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

Parameters

string $name
callable $macro

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(ConnectionInterface $connection, Grammar $grammar = null, Processor $processor = null)

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

Parameters

ConnectionInterface $connection
Grammar $grammar
Processor $processor

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
END_OF_DOCUMENT_MARKER

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 $operator = null, string $second = null, string $type = 'inner', bool $where = false)

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

Параметры

string $table
string $first
string $operator
string $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 $operator = null, string $second = null)

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

Параметры

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

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

void mergeWheres(array $wheres, array $bindings)

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

Параметры

array $wheres
array $bindings

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

void

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

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

Параметры

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

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

$this
END_OF_DOCUMENT_MARKER

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

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

Параметры

массив $column
строка $boolean
строка $method

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

$this

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

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

Параметры

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

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

массив

Исключения

InvalidArgumentException

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

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

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

Параметры

строка $operator
смешанный тип $value

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

логическое

protected bool invalidOperator(string $operator)

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

Параметры

строка $operator

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

логическое

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

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

Параметры

строка|массив|Closure $column
строка $operator
смешанный тип $value

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

Builder|Builder

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

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

Параметры

строка|массив $first
строка|null $operator
строка|null $second
строка|null $boolean

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

Builder|Builder

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

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

Параметры

строка|массив $first
строка|null $operator
строка|null $second

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

Builder|Builder

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

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

Параметры

строка $sql
смешанный тип $bindings
строка $boolean

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

$this

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

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

Параметры

строка $sql
смешанный тип $bindings

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

Builder|Builder

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

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

Параметры

строка $column
смешанный тип $values
строка $boolean
логическое $not

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

$this

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

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

Параметры

строка $column
смешанный тип $values

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

Builder|Builder

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

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

Параметры

строка $column
смешанный тип $values
строка $boolean

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

Builder|Builder

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

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

Параметры

строка $column
смешанный тип $values

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

Builder|Builder

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

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

Параметры

строка $column
Closure $callback
строка $boolean
логическое $not

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
string $boolean
bool $not

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

$this

Builder|Builder orWhereNull(string $column)

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

Параметры

string $column

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

Builder|Builder

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

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

Параметры

string $column
string $boolean

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

Builder|Builder

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
array $values

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

Builder|Builder

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

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

Параметры

string $column
array $values
string $boolean

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

Builder|Builder

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

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

Параметры

string $column
array $values

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

Builder|Builder

Builder|Builder orWhereNotNull(string $column)

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

Параметры

string $column

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

string $column
string $operator
string $value

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

Builder|Builder

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

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

Параметры

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

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

Parameters

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

Return Value

Builder|Builder

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

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

Parameters

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

Return Value

Builder|Builder

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

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

Parameters

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

Return Value

Builder|Builder

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

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

Parameters

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

Return Value

$this

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

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

Parameters

Closure $callback
string $boolean

Return Value

Builder|Builder

Builder forNestedWhere()

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

Return Value

Builder

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

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

Parameters

Builder|Builder $query
string $boolean

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

Closure $callback
string $boolean
bool $not

Return Value

$this

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

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

Parameters

Closure $callback
bool $not

Return Value

Builder|Builder

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

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

Parameters

Closure $callback
string $boolean

Return Value

Builder|Builder

Builder|Builder orWhereNotExists(Closure $callback)

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

Parameters

Closure $callback

Return Value

Builder|Builder

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

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

Parameters

Builder $query
string $boolean
bool $not

Return Value

$this

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

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

Parameters

string $method
string $parameters

Return Value

$this
END_OF_DOCUMENT_MARKER

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 $operator = null, string $value = null, string $boolean = 'and')

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

Параметры

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

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

$this

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

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

Параметры

string $column
string $operator
string $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')

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

Параметры

string $column
string $direction

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

$this

$this orderByDesc(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

string $column

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

Builder|Builder

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

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

Параметры

string $column

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

Builder|Builder

$this inRandomOrder(string $seed = '')

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

Параметры

string $seed

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

Builder|Builder skip(int $value)

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

Параметры

int $value

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

Builder|Builder

$this offset(int $value)

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

Параметры

int $value

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

$this

Builder|Builder take(int $value)

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

Параметры

int $value

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

Builder|Builder

$this limit(int $value)

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

Параметры

int $value

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

$this

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

Установить limit и offset для заданной страницы.

Параметры

int $page
int $perPage

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

Builder|Builder
END_OF_DOCUMENT_MARKER

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

Generator cursor()

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

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

Generator

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

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

Параметры

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

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

bool

protected void enforceOrderBy()

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

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

void

Исключения

RuntimeException

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

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

Параметры

string $column
string|null $key

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

Collection

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)

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

Параметры

string $column

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

mixed

mixed max(string $column)

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

Параметры

string $column

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

mixed

mixed sum(string $column)

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

Параметры

string $column

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

mixed

mixed avg(string $column)

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

Параметры

string $column

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

mixed

mixed average(string $column)

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

Параметры

string $column

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

mixed

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

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

Параметры

string $function
array $columns

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

mixed

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

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

Параметры

string $function
array $columns

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

float|int

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

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

Параметры

string $function
array $columns

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

$this

bool insert(array $values)

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

Параметры

array $values

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

bool

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

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

Параметры

array $values
string $sequence

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

int

int update(array $values)

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

Параметры

array $values

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

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

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

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

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

$this

Builder cloneWithout(array $except)

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

Параметры

array $except

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

Builder

Builder cloneWithoutBindings(array $except)

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

Параметры

array $except

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

Builder

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

Spec-Zone.ru

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