Spec-Zone.ru › Laravel 5.8

Builder

класс 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 Удаленные глобальные области видимости.

Методы

bool chunk(int $count, callable $callback)

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

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

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

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

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

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

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

из BuildsQueries
Builder tap(callable $callback)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из QueriesRelationships
Builder|QueriesRelationships orDoesntHave(string $relation)

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

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

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

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

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

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

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

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

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

из 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 make(array $attributes = [])

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

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

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

$this withoutGlobalScope(Scope|string $scope)

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

$this withoutGlobalScopes(array $scopes = null)

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

array removedScopes()

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

$this whereKey(mixed $id)

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

$this whereKeyNot(mixed $id)

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

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

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

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

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

$this latest(string $column = null)

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

$this oldest(string $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 $column)

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

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

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

Model[]|Builder[] getModels(array $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)

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

Generator cursor()

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

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

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

void enforceOrderBy()

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

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

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

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

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

Paginator simplePaginate(int $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 $column, float|int $amount = 1, array $extra = [])

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

int decrement(string $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 $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)

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

$this without(mixed $relations)

Запретить загрузку указанных отношений с нетерпением.

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

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

$this setEagerLoads(array $eagerLoad)

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

Model|Builder getModel()

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

$this setModel(Model $model)

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

string qualifyColumn(string $column)

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

Closure getMacro(string $name)

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

mixed __get(string $key)

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

mixed __call(string $method, array $parameters)

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

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

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

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

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

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

Параметры

array $columns

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

Model|object|BuildsQueries|null
END_OF_DOCUMENT_MARKER

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

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

Parameters

mixed $value
callable $callback
callable|null $default

Return Value

mixed|$this

Builder tap(callable $callback)

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

Parameters

callable $callback

Return Value

Builder

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

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

Parameters

mixed $value
callable $callback
callable|null $default

Return Value

mixed|$this

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

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

string $relation
string $operator
int $count

Return Value

Builder|QueriesRelationships

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

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

Parameters

string $relation
string $boolean
Closure $callback

Return Value

Builder|QueriesRelationships

Builder|QueriesRelationships orDoesntHave(string $relation)

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

Parameters

string $relation

Return Value

Builder|QueriesRelationships

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

string $relation
Closure $callback

Return Value

Builder|QueriesRelationships

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

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

Parameters

string $relation
Closure $callback

Return Value

Builder|QueriesRelationships

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

MorphTo $relation
string $type

Return Value

BelongsTo

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

string $relation
string|array $types

Return Value

Builder|QueriesRelationships

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

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

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

Parameters

string $relation
string|array $types
Closure $callback

Return Value

Builder|QueriesRelationships

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

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

Parameters

string $relation
string|array $types
Closure $callback

Return Value

Builder|QueriesRelationships

$this withCount(mixed $relations)

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

Parameters

mixed $relations

Return Value

$this

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

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

Parameters

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

Return Value

Builder|QueriesRelationships

Builder|QueriesRelationships mergeConstraintsFrom(Builder $from)

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

Parameters

Builder $from

Return Value

Builder|QueriesRelationships

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

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

Parameters

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

Return Value

$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 make(array $attributes = [])

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

Параметры

array $attributes

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

Model

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

Зарегистрировать новый глобальный scope.

Параметры

string $identifier
Scope|Closure $scope

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

$this

$this withoutGlobalScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

$this

$this withoutGlobalScopes(array $scopes = null)

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

Параметры

array $scopes

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

$this

array removedScopes()

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

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

array

$this whereKey(mixed $id)

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

Параметры

mixed $id

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

$this

$this whereKeyNot(mixed $id)

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

Параметры

mixed $id

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

$this

$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

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

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

Параметры

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

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

Builder|Builder

$this latest(string $column = null)

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

Параметры

string $column

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

$this

$this oldest(string $column = null)

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

Параметры

string $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 = ['*'])

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

Parameters

mixed $id
array $columns

Return Value

Model|Builder

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

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

Parameters

array $attributes
array $values

Return Value

Model|Builder

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

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

Parameters

array $attributes
array $values

Return Value

Model|Builder

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

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

Parameters

array $attributes
array $values

Return Value

Model|Builder

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

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

Parameters

array $columns

Return Value

Model|Builder

Exceptions

ModelNotFoundException

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

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

Parameters

Closure|array $columns
Closure $callback

Return Value

Model|Builder|mixed

mixed value(string $column)

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

Parameters

string $column

Return Value

mixed

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

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

Parameters

array $columns

Return Value

Collection|Builder[]

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

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

Parameters

array $columns

Return Value

Model[]|Builder[]

array eagerLoadRelations(array $models)

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

Parameters

array $models

Return Value

array

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

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

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

Generator cursor()

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

Return Value

Generator

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

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

Параметры

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

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

bool

protected void enforceOrderBy()

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

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

void

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

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

Параметры

string $column
string|null $key

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

Collection

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

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

Параметры

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

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

LengthAwarePaginator

Исключения

InvalidArgumentException

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

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

Параметры

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

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

Paginator

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

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

Параметры

array $attributes

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

Model|$this

Model|$this forceCreate(array $attributes)

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

Параметры

array $attributes

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

Model|$this

int update(array $values)

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

Параметры

array $values

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

int

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

protected array addUpdatedAtColumn(array $values)

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

Параметры

array $values

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

array

mixed delete()

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

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

mixed

mixed forceDelete()

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

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

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

mixed

void onDelete(Closure $callback)

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

Параметры

Closure $callback

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

void

Builder|mixed scopes(array $scopes)

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

Параметры

array $scopes

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

Builder|mixed

Builder applyScopes()

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

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

Builder

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

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

Параметры

callable $scope
array $parameters

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

mixed

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

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

Параметры

Builder $query
int $originalWhereCount

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

void

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

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

Параметры

Builder $query
array $whereSlice

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

void

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

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

Параметры

array $whereSlice
string $boolean

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

array

$this with(mixed $relations)

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

Параметры

mixed $relations

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

$this

$this without(mixed $relations)

Предотвратить загрузку указанных отношений eagerly.

Параметры

mixed $relations

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

$this

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

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

Параметры

array $attributes

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

Model|Builder

protected array parseWithRelations(array $relations)

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

Параметры

array $relations

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

array

protected array createSelectWithConstraint(string $name)

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

Параметры

string $name

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

array

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

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

Параметры

string $name
array $results

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

array

Builder getQuery()

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

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

Builder

$this setQuery(Builder $query)

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

Параметры

Builder $query

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

$this

Builder toBase()

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

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

Builder

array getEagerLoads()

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

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

array

$this setEagerLoads(array $eagerLoad)

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

Параметры

array $eagerLoad

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

$this

Model|Builder getModel()

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

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

Model|Builder

$this setModel(Model $model)

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

Параметры

Model $model

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

$this

string qualifyColumn(string $column)

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

Параметры

string $column

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

string

Closure getMacro(string $name)

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

Параметры

string $name

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

Closure

mixed __get(string $key)

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

Параметры

string $key

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

mixed

Исключения

Exception

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __clone()

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

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

void

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

Spec-Zone.ru

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