Spec-Zone.ru › Laravel 5.6

Строитель

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

Трейты

BuildsQueries
Macroable

Свойства

static protected array $macros Зарегистрированные строковые макросы. from Macroable
ConnectionInterface $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 Объединения запросов.
int $unionLimit Максимальное количество записей объединения для возврата.
int $unionOffset Количество записей объединения, которые нужно пропустить.
array $unionOrders Порядок сортировки для запроса объединения.
string|bool $lock Указывает, используется ли блокировка строк.
array $operators Все доступные операторы предложений.
bool $useWritePdo Использовать ли write pdo для выбора.

Методы

bool chunk(int $count, callable $callback)

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

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

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

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

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

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

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

 from BuildsQueries
Builder tap(Closure $callback)

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

 from BuildsQueries
mixed|$this 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)

Обработать динамические вызовы метода.
void __construct(ConnectionInterface $connection, Grammar $grammar = null, Processor $processor = null)

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

Установить столбцы для выбора.
Builder|Builder selectSub(Closure|Builder|string $query, string $as)

Добавить подзапрос в запрос.
Builder|Builder selectRaw(string $expression, array $bindings = [])

Добавить новый "сырой" выражение выбора в запрос.
Builder|Builder fromSub(Closure|Builder|string $query, string $as)

Выполнить выбор из подзапроса.
Builder|Builder fromRaw(string $expression, mixed $bindings = [])

Добавить сырое условие from в запрос.
array createSub(Closure|Builder|string $query)

Создаёт подзапрос и анализирует его.
array parseSub(mixed $query)

Разбор подзапроса в SQL и привязки.
$this addSelect(array|mixed $column)

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

Принудительное получение только уникальных результатов.
$this from(string $table)

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

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

Добавление условия "join where" в запрос.
Builder|Builder joinSub(Closure|Builder|string $query, string $as, string $first, string|null $operator = null, string|null $second = null, string $type = 'inner', bool $where = false)

Добавление условия объединения с подзапросом в запрос.
Builder|Builder leftJoin(string $table, string $first, string|null $operator = null, string|null $second = null)

Добавление левого объединения в запрос.
Builder|Builder leftJoinWhere(string $table, string $first, string $operator, string $second)

Добавить условие "left join where" к запросу.
Builder|Builder leftJoinSub(Closure|Builder|string $query, string $as, string $first, string|null $operator = null, string|null $second = null)

Добавить подзапрос left join к запросу.
Builder|Builder rightJoin(string $table, string $first, string|null $operator = null, string|null $second = null)

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

Добавить условие "right join where" к запросу.
Builder|Builder rightJoinSub(Closure|Builder|string $query, string $as, string $first, string|null $operator = null, string|null $second = null)

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

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

Объединить массив условий where и параметров.
$this where(string|array|Closure $column, mixed $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, mixed $operator = null, mixed $value = null)

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

Добавить условие "where", сравнивающее два столбца, к запросу.
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, mixed $value = null)

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

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

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

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

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

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

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

Добавить условие "где год" к запросу.
Builder|Builder orWhereYear(string $column, string $operator, mixed $value = null)

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

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

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

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

Добавить другой запрос-билдер в качестве вложенного условия where к запрос-билдеру.
$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 whereRowValues(array $columns, string $operator, array $values, string $boolean = 'and')

Добавляет условие where с использованием значений строк.
$this orWhereRowValues(array $columns, string $operator, array $values)

Добавляет условие or where с использованием значений строк.
$this whereJsonContains(string $column, mixed $value, string $boolean = 'and', bool $not = false)

Добавить условие "where JSON содержит" в запрос.
$this orWhereJsonContains(string $column, mixed $value)

Добавить условие "or where JSON содержит" в запрос.
$this whereJsonDoesntContain(string $column, mixed $value, string $boolean = 'and')

Добавить условие "where JSON не содержит" в запрос.
$this orWhereJsonDoesntContain(string $column, mixed $value)

Добавить условие "or where JSON не содержит" в запрос.
$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|null $operator = null, string|null $value = null, string $boolean = 'and')

Добавить условие "having" в запрос.
Builder|Builder orHaving(string $column, string|null $operator = null, string|null $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" по timestamp в запрос.
Builder|Builder oldest(string $column = 'created_at')

Добавить условие "order by" по timestamp в запрос.
$this inRandomOrder(string $seed = '')

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

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

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

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

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

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

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

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

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

Добавить оператор объединения в запрос.
Builder|Builder unionAll(Builder|Closure $query)

Добавить оператор объединения 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|null $alias = null)

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

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

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

Удалить имя таблицы или псевдоним из идентификатора столбца.
Коллекция pluckFromObjectColumn(array $queryResult, string $column, string $key)

Извлечь значения столбцов из строк, представленных как объекты.
Коллекция pluckFromArrayColumn(array $queryResult, string $column, string $key)

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

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

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

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

Получить результат "count" запроса.
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)

Установить свойство aggregate без выполнения запроса.
mixed onceWithColumns(array $columns, callable $callback)

Выполнить заданный обратный вызов, выбрав заданные столбцы.
bool insert(array $values)

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

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

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

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

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

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

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

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

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

Создать новый экземпляр запроса для подзапроса.
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 $properties)

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

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

Подробности

bool chunk(int $count, callable $callback)

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

Параметры

int $count
callable $callback

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

bool

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

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

Параметры

callable $callback
int $count

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

bool

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

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

Параметры

array $columns

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

Модель|object|BuildsQueries|null

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

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

Параметры

mixed $value
callable $callback
callable $default

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

mixed|$this

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

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

Параметры

Closure $callback

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

Билдер

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

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

Параметры

mixed $value
callable $callback
callable $default

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

mixed|$this

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)

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin)

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

Параметры

object $mixin

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static mixed __callStatic(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

пустое значение __construct(ConnectionInterface $connection, Grammar $grammar = null, Processor $processor = null)

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

Параметры

ConnectionInterface $connection
Grammar $grammar
Processor $processor

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

пустое значение

$this select(массив|смешанный $columns = ['*'])

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

Параметры

массив|смешанный $columns

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

$this

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

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

Параметры

Closure|Builder|string $query
string $as

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

Builder|Builder

Исключения

InvalidArgumentException

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

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

Параметры

string $expression
array $bindings

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

Builder|Builder

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

Выполняет запрос "from" из подзапроса.

Параметры

Closure|Builder|string $query
string $as

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

Builder|Builder

Исключения

InvalidArgumentException

Builder|Builder fromRaw(string $expression, mixed $bindings = [])

Добавляет в запрос условие "from" с сырым выражением.

Параметры

string $expression
mixed $bindings

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

Builder|Builder

protected array createSub(Closure|Builder|string $query)

Создает подзапрос и анализирует его.

Параметры

Closure|Builder|string $query

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

array

protected array parseSub(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')

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

Параметры

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

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

Builder|Builder

Builder|Builder joinSub(Closure|Builder|string $query, string $as, string $first, string|null $operator = null, string|null $second = null, string $type = 'inner', bool $where = false)

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

Параметры

Closure|Builder|string $query
string $as
string $first
string|null $operator
string|null $second
string $type
bool $where

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

Builder|Builder

Исключения

InvalidArgumentException

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

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

Параметры

string $table
string $first
string|null $operator
string|null $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 leftJoinSub(Closure|Builder|string $query, string $as, string $first, string|null $operator = null, string|null $second = null)

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

Параметры

Closure|Builder|string $query
string $as
string $first
string|null $operator
string|null $second

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

Builder|Builder

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

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

Параметры

string $table
string $first
string|null $operator
string|null $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 rightJoinSub(Closure|Builder|string $query, string $as, string $first, string|null $operator = null, string|null $second = null)

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

Параметры

Closure|Builder|string $query
string $as
string $first
string|null $operator
string|null $second

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

Builder|Builder

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

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

Параметры

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

Значение результата

Builder|Builder

void mergeWheres(array $wheres, array $bindings)

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

Параметры

array $wheres
array $bindings

Значение результата

void

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

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

Параметры

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

Значение результата

$this

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

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

Параметры

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

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

$this

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

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

Параметры

строка $value
строка $operator
bool $useDefault

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

массив

Исключения

InvalidArgumentException

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

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

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

Параметры

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

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

bool

protected bool invalidOperator(string $operator)

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

Параметры

строка $operator

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

bool

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

string $sql
mixed $bindings
string $boolean

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

$this

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

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

Параметры

string $sql
mixed $bindings

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

Builder|Builder

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
mixed $values

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

Builder|Builder

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

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

Параметры

string $column
mixed $values
string $boolean

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

Builder|Builder

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

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

Параметры

string $column
mixed $values

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

Builder|Builder

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

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

Параметры

string $column
Closure $callback
string $boolean
bool $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)

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

Параметры

string $column
string $boolean
bool $not

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

$this

Builder|Builder orWhereNull(string $column)

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

Параметры

string $column

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

Builder|Builder

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

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

Параметры

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)

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

Параметры

string $column
array $values

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

Builder|Builder

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

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

Параметры

string $column
array $values
string $boolean

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

Builder|Builder

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

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

Параметры

string $column
array $values

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

Builder|Builder

Builder|Builder orWhereNotNull(string $column)

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

Параметры

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, mixed $value = null)

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

Параметры

string $column
string $operator
mixed $value

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

Builder|Builder

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

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

Параметры

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

Значение результата

Builder|Builder

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

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

Параметры

string $column
string $operator
mixed $value

Значение результата

Builder|Builder

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

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

Параметры

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

Значение результата

Builder|Builder

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

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

Параметры

string $column
string $operator
mixed $value

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

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 orWhereMonth(string $column, string $operator, mixed $value = null)

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

Параметры

string $column
string $operator
mixed $value

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

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

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

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

Параметры

string $column
string $operator
mixed $value

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

Builder|Builder

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

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

Параметры

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

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

$this

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

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

Параметры

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)

Добавить условие 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 whereRowValues(array $columns, string $operator, array $values, string $boolean = 'and')

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

Параметры

array $columns
string $operator
array $values
string $boolean

Значение результата

$this

$this orWhereRowValues(array $columns, string $operator, array $values)

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

Параметры

array $columns
string $operator
array $values

Значение результата

$this

$this whereJsonContains(string $column, mixed $value, string $boolean = 'and', bool $not = false)

Добавляет условие "where JSON содержит" в запрос.

Параметры

string $column
mixed $value
string $boolean
bool $not

Значение результата

$this

$this orWhereJsonContains(string $column, mixed $value)

Добавляет условие "or where JSON содержит" в запрос.

Параметры

string $column
mixed $value

Значение результата

$this

$this whereJsonDoesntContain(string $column, mixed $value, string $boolean = 'and')

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

Параметры

string $column
mixed $value
string $boolean

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

$this

$this orWhereJsonDoesntContain(string $column, mixed $value)

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

Параметры

string $column
mixed $value

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

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

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

Параметры

массив $groups

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

$this

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

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

Параметры

строка $column
строка|null $operator
строка|null $value
строка $boolean

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

$this

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

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

Параметры

строка $column
строка|null $operator
строка|null $value

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

Builder|Builder

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

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

Параметры

строка $sql
массив $bindings
строка $boolean

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

$this

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

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

Параметры

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

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

Параметры

строка $column

Значение результата

Builder|Builder

$this inRandomOrder(string $seed = '')

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

Параметры

строка $seed

Значение результата

$this

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

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

Параметры

строка $sql
массив $bindings

Значение результата

$this

Builder|Builder skip(int $value)

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

Параметры

целое $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)

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

Параметры

int $page
int $perPage

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

Builder|Builder

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

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

Параметры

int $perPage
int|null $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)

Добавить оператор union 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 = ['*'])

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

Параметры

int $id
array $columns

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

mixed|Builder

mixed value(string $column)

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

Параметры

string $column

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

mixed

Коллекция get(array $columns = ['*'])

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

Параметры

array $columns

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

Коллекция

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|null $alias = null)

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

Параметры

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

Значение результата

bool

protected void enforceOrderBy()

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

Значение результата

void

Исключения

RuntimeException

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

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

Параметры

string $column
string|null $key

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

Коллекция

protected string|null stripTableForPluck(string $column)

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

Параметры

string $column

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

string|null

protected Коллекция pluckFromObjectColumn(array $queryResult, string $column, string $key)

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

Параметры

array $queryResult
string $column
string $key

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

Коллекция

protected Коллекция pluckFromArrayColumn(array $queryResult, string $column, string $key)

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

Параметры

array $queryResult
string $column
string $key

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

Коллекция

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

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

Параметры

string $column
string $glue

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

string

bool exists()

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

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

bool

bool doesntExist()

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

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

bool

int count(string $columns = '*')

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

Параметры

string $columns

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

int

mixed min(string $column)

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

Параметры

string $column

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

mixed

mixed max(string $column)

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

Параметры

string $column

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

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)

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

Параметры

string $function
array $columns

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

$this

protected mixed onceWithColumns(array $columns, callable $callback)

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

После выполнения обратного вызова столбцы сбрасываются до исходного значения.

Параметры

array $columns
callable $callback

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

mixed

bool insert(array $values)

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

Параметры

array $values

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

bool

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

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

Параметры

array $values
string|null $sequence

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

int

int update(array $values)

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

Параметры

array $values

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

int

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

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

Параметры

array $attributes
array $values

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

bool

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

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

Параметры

string $column
float|int $amount
array $extra

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

int

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

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

Параметры

string $column
float|int $amount
array $extra

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

int

int delete(mixed $id = null)

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

Параметры

mixed $id

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

int

void truncate()

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

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

void

Построитель запросов newQuery()

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

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

Построитель запросов

protected Построитель запросов forSubQuery()

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

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

Построитель запросов

Выражение raw(mixed $value)

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

Параметры

mixed $value

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

Выражение

массив getBindings()

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

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

массив

массив getRawBindings()

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

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

массив

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

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

Параметры

массив $bindings
строка $type

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

$this

Исключения

InvalidArgumentException

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

Добавить параметр в запрос.

Параметры

смешанный $value
строка $type

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

$this

Исключения

InvalidArgumentException

$this mergeBindings(Builder $query)

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

Параметры

Builder $query

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

$this

protected array cleanBindings(array $bindings)

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

Параметры

массив $bindings

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

массив

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)

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

Параметры

массив $except

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

Builder

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

Spec-Zone.ru

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