Spec-Zone.ru › Laravel 6

Builder

класс Builder mixin Builder (View source)

Трейты

BuildsQueries
QueriesRelationships
ForwardsCalls

Свойства

protected Builder $query

Базовый экземпляр построителя запросов.
protected Model $model

Запрашиваемая модель.
protected array $eagerLoad

Связи, которые должны быть загружены нетерпеливо.
static protected array $macros

Все глобально зарегистрированные макросы построителя.
protected array $localMacros

Все локально зарегистрированные макросы построителя.
protected Closure $onDelete

Замена для типичной функции удаления.
protected array $passthru

Методы, которые должны быть возвращены из построителя запросов.
protected array $scopes

Примененные глобальные области видимости.
protected array $removedScopes

Удаленные глобальные области видимости.
HigherOrderBuilderProxy read-only $orWhere

Методы

bool chunk(int $count, callable $callback)

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

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

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

 from BuildsQueries
bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

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

 from BuildsQueries
bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

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

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

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

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

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

 from BuildsQueries
$this tap(callable $callback)

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

 from BuildsQueries
mixed|$this unless(mixed $value, callable $callback, callable|null $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
Builder|QueriesRelationships has(Relation|string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships hasNested(string $relations, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure|null $callback = null)

Добавить вложенные условия подсчета/существования связи к запросу.

 from QueriesRelationships
Builder|QueriesRelationships orHas(string $relation, string $operator = '>=', int $count = 1)

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

 from QueriesRelationships
Builder|QueriesRelationships doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships orDoesntHave(string $relation)

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

 from QueriesRelationships
Builder|QueriesRelationships whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

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

 from QueriesRelationships
Builder|QueriesRelationships orWhereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

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

 from QueriesRelationships
Builder|QueriesRelationships whereDoesntHave(string $relation, Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships orWhereDoesntHave(string $relation, Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships hasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

Добавить условие подсчета/существования полиморфного отношения к запросу.

 из QueriesRelationships
BelongsTo getBelongsToRelation(MorphTo $relation, string $type)

Получить отношение BelongsTo для одного полиморфного типа.

 из QueriesRelationships
Builder|QueriesRelationships orHasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1)

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

 из QueriesRelationships
Builder|QueriesRelationships doesntHaveMorph(string $relation, string|array $types, string $boolean = 'and', Closure $callback = null)

Добавить условие подсчета/существования полиморфного отношения к запросу.

 из QueriesRelationships
Builder|QueriesRelationships orDoesntHaveMorph(string $relation, string|array $types)

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

 из QueriesRelationships
Builder|QueriesRelationships whereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчета/существования полиморфного отношения к запросу с where-условиями.

 из QueriesRelationships
Builder|QueriesRelationships orWhereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчета/существования полиморфного отношения к запросу с where-условиями и "или".

 из QueriesRelationships
Builder|QueriesRelationships whereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

Добавить условие подсчета/существования полиморфного отношения к запросу с where-условиями.

 из QueriesRelationships
Builder|QueriesRelationships orWhereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

Добавить условие подсчета/существования полиморфного отношения к запросу с where-условиями и "или".

 из QueriesRelationships
$this withCount(mixed $relations)

Добавить подзапросы для подсчета отношений.

 из QueriesRelationships
Builder|QueriesRelationships addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean)

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

 из QueriesRelationships
Builder|QueriesRelationships mergeConstraintsFrom(Builder $from)

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

 из QueriesRelationships
$this addWhereCountQuery(Builder $query, string $operator = '>=', int $count = 1, string $boolean = 'and')

Добавить подзапрос count к этому запросу.

 из QueriesRelationships
Relation getRelationWithoutConstraints(string $relation)

Получить базовый экземпляр запроса "has relation".

 из QueriesRelationships
bool canUseExistsForExistenceCheck(string $operator, int $count)

Проверить, можно ли запустить запрос "exists" для оптимизации производительности.

 из QueriesRelationships
mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

 из ForwardsCalls
static void throwBadMethodCallException(string $method)

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

 из ForwardsCalls
void __construct(Builder $query)

Создать новый экземпляр построителя запросов Eloquent.
Model|Builder make(array $attributes = [])

Создать и вернуть несохранённый экземпляр модели.
$this withGlobalScope(string $identifier, Scope|Closure $scope)

Зарегистрировать новый глобальный scope.
$this withoutGlobalScope(Scope|string $scope)

Удалить зарегистрированный глобальный scope.
$this withoutGlobalScopes(array $scopes = null)

Удалить все или переданные зарегистрированные глобальные scopes.
array removedScopes()

Получить массив глобальных scopes, которые были удалены из запроса.
$this whereKey(mixed $id)

Добавить условие where по первичному ключу к запросу.
$this whereKeyNot(mixed $id)

Добавить условие where по первичному ключу к запросу.
$this where(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие where к запросу.
Model|Builder firstWhere(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие where к запросу и вернуть первый результат.
Builder|Builder orWhere(Closure|array|string|Expression $column, mixed $operator = null, mixed $value = null)

Добавить условие "or where" к запросу.
$this latest(string|Expression $column = null)

Добавить условие "order by" для метки времени к запросу.
$this oldest(string|Expression $column = null)

Добавить условие "order by" для метки времени к запросу.
Collection hydrate(array $items)

Создать коллекцию моделей из простых массивов.
Collection fromQuery(string $query, array $bindings = [])

Создать коллекцию моделей из необработанного запроса.
Model|Collection|Builder[]|Builder|null find(mixed $id, array $columns = ['*'])

Найти модель по её первичному ключу.
Collection findMany(Arrayable|array $ids, array $columns = ['*'])

Найти несколько моделей по их первичным ключам.
Model|Collection|Builder|Builder[] findOrFail(mixed $id, array $columns = ['*'])

Найти модель по её первичному ключу или выбросить исключение.
Model|Builder findOrNew(mixed $id, array $columns = ['*'])

Найти модель по её первичному ключу или вернуть новый экземпляр модели.
Model|Builder firstOrNew(array $attributes, array $values = [])

Получить первую запись, соответствующую атрибутам, или создать её.
Model|Builder firstOrCreate(array $attributes, array $values = [])

Получить первую запись, соответствующую атрибутам, или создать её.
Model|Builder updateOrCreate(array $attributes, array $values = [])

Создать или обновить запись, соответствующую атрибутам, и заполнить её значениями.
Model|Builder firstOrFail(array $columns = ['*'])

Выполнить запрос и получить первый результат или выбросить исключение.
Model|Builder|mixed firstOr(Closure|array $columns = ['*'], Closure $callback = null)

Выполнить запрос и получить первый результат или вызвать обратный вызов.
mixed value(string|Expression $column)

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

Выполнить запрос как оператор "select".
Model[]|Builder[] getModels(array|string $columns = ['*'])

Получить гидратированные модели без предзагрузки.
array eagerLoadRelations(array $models)

Предварительно загрузить связи для моделей.
array eagerLoadRelation(array $models, string $name, Closure $constraints)

Предварительно загрузить связь в наборе моделей.
Relation getRelation(string $name)

Получить экземпляр связи для данного имени связи.
array relationsNestedUnder(string $relation)

Получить глубоко вложенные связи для данной связи верхнего уровня.
bool isNestedUnder(string $relation, string $name)

Определить, является ли связь вложенной.
LazyCollection cursor()

Получить ленивую коллекцию для данного запроса.
void enforceOrderBy()

Добавить обобщенное условие "order by", если его еще нет в запросе.
Collection pluck(string|Expression $column, string|null $key = null)

Получить массив со значениями данного столбца.
LengthAwarePaginator paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

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

Разбить данный запрос на страницы с помощью простого пагинатора.
Model|$this create(array $attributes = [])

Сохранить новую модель и вернуть экземпляр.
Model|$this forceCreate(array $attributes)

Сохранить новую модель и вернуть экземпляр. Разрешить массовое присваивание.
int update(array $values)

Обновить запись в базе данных.
int increment(string|Expression $column, float|int $amount = 1, array $extra = [])

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

Уменьшить значение столбца на заданную величину.
array addUpdatedAtColumn(array $values)

Добавить столбец "updated at" в массив значений.
mixed delete()

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

Выполнить функцию удаления по умолчанию для построителя.
void onDelete(Closure $callback)

Зарегистрировать замену для функции удаления по умолчанию.
Builder|mixed scopes(array|string $scopes)

Вызвать заданные локальные области видимости модели.
Builder applyScopes()

Применить области видимости к экземпляру построителя Eloquent и вернуть его.
mixed callScope(callable $scope, array $parameters = [])

Применить заданную область видимости к текущему экземпляру построителя.
void addNewWheresWithinGroup(Builder $query, int $originalWhereCount)

Вложить условия where, разделив их по заданному счетчику where.
void groupWhereSliceForScope(Builder $query, array $whereSlice)

Разделить условия where по заданному смещению и добавить их в запрос как вложенное условие.
array createNestedWhere(array $whereSlice, string $boolean = 'and')

Создать массив where со вложенными условиями where.
$this with(mixed $relations)

Установить отношения, которые должны быть загружены eagerly.
$this without(mixed $relations)

Запретить загрузку указанных отношений eagerly.
Model|Builder newModelInstance(array $attributes = [])

Создать новый экземпляр модели, которая запрашивается.
array parseWithRelations(array $relations)

Разбить список отношений на отдельные элементы.
array createSelectWithConstraint(string $name)

Создать ограничение для выбора заданных столбцов для отношения.
array addNestedWiths(string $name, array $results)

Разбить вложенные отношения в отношении.
Builder getQuery()

Получить базовый экземпляр построителя запросов.
$this setQuery(Builder $query)

Установить базовый экземпляр построителя запросов.
Builder toBase()

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

Получить отношения, которые загружаются eagerly.
$this setEagerLoads(array $eagerLoad)

Установить отношения, которые загружаются eagerly.
string defaultKeyName()

Получить имя ключа таблицы по умолчанию.
Model|Builder getModel()

Получить экземпляр модели, которая запрашивается.
$this setModel(Model $model)

Установить экземпляр модели для модели, которая запрашивается.
string qualifyColumn(string|Expression $column)

Квалифицировать имя данного столбца таблицей модели.
Closure getMacro(string $name)

Получить заданный макрос по имени.
bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.
static Closure getGlobalMacro(string $name)

Получить заданный глобальный макрос по имени.
static bool hasGlobalMacro(string $name)

Проверить, зарегистрирован ли глобальный макрос.
mixed __get(string $key)

Динамически получить доступ к прокси построителя.
mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы в экземпляр запроса.
static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы в экземпляр запроса.
static void registerMixin(string $mixin, bool $replace)

Регистрирует данный mixin в builder.
void __clone()

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

Подробности

bool chunk(int $count, callable $callback)

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

Параметры

int $count
callable $callback

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

bool

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

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

Параметры

callable $callback
int $count

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

bool

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

Разбивает результаты запроса путем сравнения ID.

Параметры

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

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

bool

bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

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

Параметры

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

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

bool

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

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

Параметры

array|string $columns

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

Model|object|BuildsQueries|null

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

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

Параметры

mixed $value
callable $callback
callable|null $default

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

mixed|$this

$this tap(callable $callback)

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

Параметры

callable $callback

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

$this

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

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

Параметры

mixed $value
callable $callback
callable|null $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

Builder|QueriesRelationships has(Relation|string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

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

Параметры

Relation|string $relation
string $operator
int $count
string $boolean
Closure $callback

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

Builder|QueriesRelationships

Исключения

RuntimeException

protected Builder|QueriesRelationships hasNested(string $relations, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure|null $callback = null)

Добавляет вложенные условия подсчета/существования связей к запросу.

Настраивает рекурсивный вызов whereHas, пока не закончим вложенную связь.

Параметры

string $relations
string $operator
int $count
string $boolean
Closure|null $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orHas(string $relation, string $operator = '>=', int $count = 1)

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

Параметры

string $relation
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)

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

Параметры

string $relation
string $boolean
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orDoesntHave(string $relation)

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

Параметры

string $relation

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

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

Параметры

string $relation
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчета/существования связи к запросу с помощью where-условий и "или".

Параметры

string $relation
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereDoesntHave(string $relation, Closure $callback = null)

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

Параметры

string $relation
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereDoesntHave(string $relation, Closure $callback = null)

Добавить условие подсчета/существования связи к запросу с помощью where-условий и "или".

Параметры

string $relation
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships hasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

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

Параметры

string $relation
string|array $types
string $operator
int $count
string $boolean
Closure $callback

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

Builder|QueriesRelationships

protected BelongsTo getBelongsToRelation(MorphTo $relation, string $type)

Получить связь BelongsTo для одного полиморфного типа.

Параметры

MorphTo $relation
string $type

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

BelongsTo

Builder|QueriesRelationships orHasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1)

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

Параметры

string $relation
string|array $types
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships doesntHaveMorph(string $relation, string|array $types, string $boolean = 'and', Closure $callback = null)

Добавить условие подсчета/существования полиморфного отношения к запросу.

Параметры

string $relation
string|array $types
string $boolean
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orDoesntHaveMorph(string $relation, string|array $types)

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

Параметры

string $relation
string|array $types

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчета/существования полиморфного отношения к запросу с условиями where.

Параметры

string $relation
string|array $types
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчета/существования полиморфного отношения к запросу с условиями where и "или".

Параметры

string $relation
string|array $types
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

Добавить условие подсчета/существования полиморфного отношения к запросу с условиями where.

Параметры

string $relation
string|array $types
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

Добавить условие подсчета/существования полиморфного отношения к запросу с условиями where и "или".

Параметры

string $relation
string|array $types
Closure $callback

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

Builder|QueriesRelationships

$this withCount(mixed $relations)

Добавить подзапросы для подсчета отношений.

Параметры

mixed $relations

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

$this

protected Builder|QueriesRelationships addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean)

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

Параметры

Builder $hasQuery
Relation $relation
string $operator
int $count
string $boolean

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

Builder|QueriesRelationships

Builder|QueriesRelationships mergeConstraintsFrom(Builder $from)

Объединить ограничения where из другого запроса в текущий запрос.

Параметры

Builder $from

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

Builder|QueriesRelationships

protected $this addWhereCountQuery(Builder $query, string $operator = '>=', int $count = 1, string $boolean = 'and')

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

Параметры

Builder $query
string $operator
int $count
string $boolean

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

$this

protected Relation getRelationWithoutConstraints(string $relation)

Получение базового экземпляра запроса для отношения "has relation".

Parameters

string $relation

Return Value

Relation

protected bool canUseExistsForExistenceCheck(string $operator, int $count)

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

Parameters

string $operator
int $count

Return Value

bool

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

void __construct(Builder $query)

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

Parameters

Builder $query

Return Value

void

Model|Builder make(array $attributes = [])

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

Parameters

array $attributes

Return Value

Model|Builder

$this withGlobalScope(string $identifier, Scope|Closure $scope)

Регистрация нового глобального scope.

Parameters

string $identifier
Scope|Closure $scope

Return Value

$this

$this withoutGlobalScope(Scope|string $scope)

Удаление зарегистрированного глобального scope.

Parameters

Scope|string $scope

Return Value

$this

$this withoutGlobalScopes(array $scopes = null)

Удаление всех или переданных зарегистрированных глобальных scope.

Parameters

array $scopes

Return Value

$this

array removedScopes()

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

Return Value

array

$this whereKey(mixed $id)

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

Parameters

mixed $id

Return Value

$this

$this whereKeyNot(mixed $id)

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

Parameters

mixed $id

Return Value

$this

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

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

Parameters

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

Return Value

$this

Model|Builder firstWhere(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

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

Parameters

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

Return Value

Model|Builder

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

Добавление условия "or where" в запрос.

Parameters

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

Return Value

Builder|Builder

$this latest(string|Expression $column = null)

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

Параметры

string|Expression $column

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

$this

$this oldest(string|Expression $column = null)

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

Параметры

string|Expression $column

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

$this

Collection hydrate(array $items)

Создать коллекцию моделей из простых массивов.

Параметры

array $items

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

Collection

Collection fromQuery(string $query, array $bindings = [])

Создать коллекцию моделей из необработанного запроса.

Параметры

string $query
array $bindings

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

Collection

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

Найти модель по её первичному ключу.

Параметры

mixed $id
array $columns

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

Model|Collection|Builder[]|Builder|null

Collection findMany(Arrayable|array $ids, array $columns = ['*'])

Найти несколько моделей по их первичным ключам.

Параметры

Arrayable|array $ids
array $columns

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

Collection

Model|Collection|Builder|Builder[] findOrFail(mixed $id, array $columns = ['*'])

Найти модель по её первичному ключу или выбросить исключение.

Параметры

mixed $id
array $columns

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

Model|Collection|Builder|Builder[]

Исключения

ModelNotFoundException

Model|Builder findOrNew(mixed $id, array $columns = ['*'])

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

Параметры

mixed $id
array $columns

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

Model|Builder

Model|Builder firstOrNew(array $attributes, array $values = [])

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

Параметры

array $attributes
array $values

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

Model|Builder

Model|Builder firstOrCreate(array $attributes, array $values = [])

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

Параметры

array $attributes
array $values

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

Model|Builder

Model|Builder updateOrCreate(array $attributes, array $values = [])

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

Параметры

array $attributes
array $values

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

Model|Builder

Model|Builder firstOrFail(array $columns = ['*'])

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

Параметры

array $columns

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

Model|Builder

Исключения

ModelNotFoundException

Model|Builder|mixed firstOr(Closure|array $columns = ['*'], Closure $callback = null)

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

Параметры

Closure|array $columns
Closure $callback

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

Model|Builder|mixed

mixed value(string|Expression $column)

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

Parameters

string|Expression $column

Return Value

mixed

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

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

Parameters

array|string $columns

Return Value

Collection|Builder[]

Model[]|Builder[] getModels(array|string $columns = ['*'])

Получить модели с загрузкой без eager loading.

Parameters

array|string $columns

Return Value

Model[]|Builder[]

array eagerLoadRelations(array $models)

Загрузить связи для моделей.

Parameters

array $models

Return Value

array

protected array eagerLoadRelation(array $models, string $name, Closure $constraints)

Жадная загрузка связи для набора моделей.

Parameters

array $models
string $name
Closure $constraints

Return Value

array

Relation getRelation(string $name)

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

Parameters

string $name

Return Value

Relation

protected array relationsNestedUnder(string $relation)

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

Parameters

string $relation

Return Value

array

protected bool isNestedUnder(string $relation, string $name)

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

Parameters

string $relation
string $name

Return Value

bool

LazyCollection cursor()

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

Return Value

LazyCollection

protected void enforceOrderBy()

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

Return Value

void

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

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

Parameters

string|Expression $column
string|null $key

Return Value

Collection

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

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

Parameters

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

Return Value

LengthAwarePaginator

Exceptions

InvalidArgumentException

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

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

Parameters

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

Return Value

Paginator

Model|$this create(array $attributes = [])

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

Parameters

array $attributes

Return Value

Model|$this

Model|$this forceCreate(array $attributes)

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

Parameters

array $attributes

Return Value

Model|$this

int update(array $values)

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

Parameters

array $values

Return Value

int

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

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

Parameters

string|Expression $column
float|int $amount
array $extra

Return Value

int

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

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

Parameters

string|Expression $column
float|int $amount
array $extra

Return Value

int

protected array addUpdatedAtColumn(array $values)

Добавить столбец "updated at" в массив значений.

Parameters

array $values

Return Value

array

mixed delete()

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

Return Value

mixed

mixed forceDelete()

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

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

Return Value

mixed

void onDelete(Closure $callback)

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

Parameters

Closure $callback

Return Value

void

Builder|mixed scopes(array|string $scopes)

Вызвать заданные локальные области видимости модели.

Parameters

array|string $scopes

Return Value

Builder|mixed

Builder applyScopes()

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

Return Value

Builder

protected mixed callScope(callable $scope, array $parameters = [])

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

Parameters

callable $scope
array $parameters

Return Value

mixed

protected void addNewWheresWithinGroup(Builder $query, int $originalWhereCount)

Вложить условия where, разделив их по заданному количеству where.

Parameters

Builder $query
int $originalWhereCount

Return Value

void

protected void groupWhereSliceForScope(Builder $query, array $whereSlice)

Разделить условия where по заданному смещению и добавить их в запрос как вложенное условие.

Parameters

Builder $query
array $whereSlice

Return Value

void

protected array createNestedWhere(array $whereSlice, string $boolean = 'and')

Создать массив where с вложенными условиями where.

Parameters

array $whereSlice
string $boolean

Return Value

array

$this with(mixed $relations)

Установить отношения, которые должны быть загружены с помощью eager loading.

Parameters

mixed $relations

Return Value

$this

$this without(mixed $relations)

Предотвратить загрузку указанных отношений с помощью eager loading.

Parameters

mixed $relations

Return Value

$this

Model|Builder newModelInstance(array $attributes = [])

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

Parameters

array $attributes

Return Value

Model|Builder

protected array parseWithRelations(array $relations)

Разбить список отношений на отдельные элементы.

Parameters

array $relations

Return Value

array

protected array createSelectWithConstraint(string $name)

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

Parameters

string $name

Return Value

array

protected array addNestedWiths(string $name, array $results)

Разбить вложенные отношения в отношении.

Parameters

string $name
array $results

Return Value

array

Builder getQuery()

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

Return Value

Builder

$this setQuery(Builder $query)

Установить экземпляр базового построителя запросов.

Parameters

Builder $query

Return Value

$this

Builder toBase()

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

Return Value

Builder

array getEagerLoads()

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

Return Value

array

$this setEagerLoads(array $eagerLoad)

Установить связи, которые загружаются усердно.

Parameters

array $eagerLoad

Return Value

$this

protected string defaultKeyName()

Получить имя ключа по умолчанию таблицы.

Return Value

string

Model|Builder getModel()

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

Return Value

Model|Builder

$this setModel(Model $model)

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

Parameters

Model $model

Return Value

$this

string qualifyColumn(string|Expression $column)

Квалифицировать заданное имя столбца таблицей модели.

Parameters

string|Expression $column

Return Value

string

Closure getMacro(string $name)

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

Parameters

string $name

Return Value

Closure

bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

static Closure getGlobalMacro(string $name)

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

Parameters

string $name

Return Value

Closure

static bool hasGlobalMacro(string $name)

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

Parameters

string $name

Return Value

bool

mixed __get(string $key)

Динамический доступ к прокси построителя.

Parameters

string $key

Return Value

mixed

Exceptions

Exception

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void registerMixin(string $mixin, bool $replace)

Зарегистрировать заданный mixin с построителем.

Parameters

string $mixin
bool $replace

Return Value

void

void __clone()

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

Return Value

void

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

Spec-Zone.ru

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