| Methods |
public
|
__construct(Builder $query): void
Create a new Eloquent query builder instance.
Create a new Eloquent query builder instance.
|
#
|
public
|
make(array $attributes = []): TModel
Create and return an un-saved model instance.
Create and return an un-saved model instance.
|
#
|
public
|
withGlobalScope(string $identifier, Scope|Closure $scope): $this
Register a new global scope.
Register a new global scope.
|
#
|
public
|
withoutGlobalScope(Scope|string $scope): $this
Remove a registered global scope.
Remove a registered global scope.
|
#
|
public
|
withoutGlobalScopes(array|null $scopes = null): $this
Remove all or passed registered global scopes.
Remove all or passed registered global scopes.
|
#
|
public
|
removedScopes(): array
Get an array of global scopes that were removed from the query.
Get an array of global scopes that were removed from the query.
|
#
|
public
|
whereKey(mixed $id): $this
Add a where clause on the primary key to the query.
Add a where clause on the primary key to the query.
|
#
|
public
|
whereKeyNot(mixed $id): $this
Add a where clause on the primary key to the query.
Add a where clause on the primary key to the query.
|
#
|
public
|
where(
(Closure(static): mixed)|string|array|Expression $column,
mixed $operator = null,
mixed $value = null,
string $boolean = 'and',
): $this
Add a basic where clause to the query.
Add a basic where clause to the query.
|
#
|
public
|
firstWhere(
(Closure(static): mixed)|string|array|Expression $column,
mixed $operator = null,
mixed $value = null,
string $boolean = 'and',
): TModel|null
Add a basic where clause to the query, and return the first result.
Add a basic where clause to the query, and return the first result.
|
#
|
public
|
orWhere((Closure(static): mixed)|array|string|Expression $column, mixed $operator = null, mixed $value = null): $this
Add an "or where" clause to the query.
Add an "or where" clause to the query.
|
#
|
public
|
whereNot(
(Closure(static): mixed)|string|array|Expression $column,
mixed $operator = null,
mixed $value = null,
string $boolean = 'and',
): $this
Add a basic "where not" clause to the query.
Add a basic "where not" clause to the query.
|
#
|
public
|
orWhereNot((Closure(static): mixed)|array|string|Expression $column, mixed $operator = null, mixed $value = null): $this
Add an "or where not" clause to the query.
Add an "or where not" clause to the query.
|
#
|
public
|
latest(string|Expression $column = null): $this
Add an "order by" clause for a timestamp to the query.
Add an "order by" clause for a timestamp to the query.
|
#
|
public
|
oldest(string|Expression $column = null): $this
Add an "order by" clause for a timestamp to the query.
Add an "order by" clause for a timestamp to the query.
|
#
|
public
|
hydrate(array $items): Collection<int, TModel>
Create a collection of models from plain arrays.
Create a collection of models from plain arrays.
|
#
|
public
|
fromQuery(string $query, array $bindings = []): Collection<int, TModel>
Create a collection of models from a raw query.
Create a collection of models from a raw query.
|
#
|
public
|
find(
mixed $id,
array|string $columns = ['*'],
): ($id is Arrayable<array-key, mixed>|array<mixed> ? Collection<int, TModel> : TModel|null)
Find a model by its primary key.
Find a model by its primary key.
|
#
|
public
|
findSole(mixed $id, array|string $columns = ['*']): TModel
Find a sole model by its primary key.
Find a sole model by its primary key.
Throws
|
#
|
public
|
findMany(Arrayable|array $ids, array|string $columns = ['*']): Collection<int, TModel>
Find multiple models by their primary keys.
Find multiple models by their primary keys.
|
#
|
public
|
findOrFail(
mixed $id,
array|string $columns = ['*'],
): ($id is Arrayable<array-key, mixed>|array<mixed> ? Collection<int, TModel> : TModel)
Find a model by its primary key or throw an exception.
Find a model by its primary key or throw an exception.
Throws
|
#
|
public
|
findOrNew(
mixed $id,
array|string $columns = ['*'],
): ($id is Arrayable<array-key, mixed>|array<mixed> ? Collection<int, TModel> : TModel)
Find a model by its primary key or return fresh model instance.
Find a model by its primary key or return fresh model instance.
|
#
|
public
|
findOr<TValue>(
mixed $id,
(Closure(): TValue)|list<string>|string $columns = ['*'],
(Closure(): TValue)|null $callback = null,
): ($id is Arrayable<array-key, mixed>|array<mixed> ? Collection<int, TModel> : TModel|TValue)
Find a model by its primary key or call a callback.
Find a model by its primary key or call a callback.
|
#
|
public
|
firstOrNew(array $attributes = [], array $values = []): TModel
Get the first record matching the attributes or instantiate it.
Get the first record matching the attributes or instantiate it.
|
#
|
public
|
firstOrCreate(array $attributes = [], array $values = []): TModel
Get the first record matching the attributes. If the record is not found, create it.
Get the first record matching the attributes. If the record is not found, create it.
|
#
|
public
|
createOrFirst(array $attributes = [], array $values = []): TModel
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
|
#
|
public
|
updateOrCreate(array $attributes, array $values = []): TModel
Create or update a record matching the attributes, and fill it with values.
Create or update a record matching the attributes, and fill it with values.
|
#
|
public
|
incrementOrCreate(
array $attributes,
string $column = 'count',
int|float $default = 1,
int|float $step = 1,
array $extra = [],
): TModel
Create a record matching the attributes, or increment the existing record.
Create a record matching the attributes, or increment the existing record.
|
#
|
public
|
firstOrFail(array|string $columns = ['*']): TModel
Execute the query and get the first result or throw an exception.
Execute the query and get the first result or throw an exception.
Throws
|
#
|
public
|
firstOr<TValue>(
(Closure(): TValue)|list<string> $columns = ['*'],
(Closure(): TValue)|null $callback = null,
): TModel|TValue
Execute the query and get the first result or call a callback.
Execute the query and get the first result or call a callback.
|
#
|
public
|
sole(array|string $columns = ['*']): TModel
Execute the query and get the first result if it's the sole matching record.
Execute the query and get the first result if it's the sole matching record.
Throws
|
#
|
public
|
value(string|Expression $column): mixed
Get a single column's value from the first result of a query.
Get a single column's value from the first result of a query.
|
#
|
public
|
soleValue(string|Expression $column): mixed
Get a single column's value from the first result of a query if it's the sole matching record.
Get a single column's value from the first result of a query if it's the sole matching record.
Throws
|
#
|
public
|
valueOrFail(string|Expression $column): mixed
Get a single column's value from the first result of the query or throw an exception.
Get a single column's value from the first result of the query or throw an exception.
Throws
|
#
|
public
|
get(array|string $columns = ['*']): Collection<int, TModel>
Execute the query as a "select" statement.
Execute the query as a "select" statement.
|
#
|
public
|
getModels(array|string $columns = ['*']): array<int, TModel>
Get the hydrated models without eager loading.
Get the hydrated models without eager loading.
|
#
|
public
|
eagerLoadRelations(array<int, TModel> $models): array<int, TModel>
Eager load the relationships for the models.
Eager load the relationships for the models.
|
#
|
protected
|
eagerLoadRelation(array $models, string $name, Closure $constraints): array
Eagerly load the relationship on a set of models.
Eagerly load the relationship on a set of models.
|
#
|
public
|
getRelation(string $name): Relation<Model, TModel, *>
Get the relation instance for the given relation name.
Get the relation instance for the given relation name.
|
#
|
protected
|
relationsNestedUnder(string $relation): array
Get the deeply nested relations for a given top-level relation.
Get the deeply nested relations for a given top-level relation.
|
#
|
protected
|
isNestedUnder(string $relation, string $name): bool
Determine if the relationship is nested.
Determine if the relationship is nested.
|
#
|
public
|
afterQuery(Closure $callback): $this
Register a closure to be invoked after the query is executed.
Register a closure to be invoked after the query is executed.
|
#
|
public
|
applyAfterQueryCallbacks(mixed $result): mixed
Invoke the "after query" modification callbacks.
Invoke the "after query" modification callbacks.
|
#
|
public
|
cursor(): LazyCollection<int, TModel>
Get a lazy collection for the given query.
Get a lazy collection for the given query.
|
#
|
protected
|
enforceOrderBy(): void
Add a generic "order by" clause if the query doesn't already have one.
Add a generic "order by" clause if the query doesn't already have one.
|
#
|
public
|
pluck(string|Expression $column, string|null $key = null): Collection<array-key, mixed>
Get a collection with the values of a given column.
Get a collection with the values of a given column.
|
#
|
public
|
paginate(
int|null|Closure $perPage = null,
array|string $columns = ['*'],
string $pageName = 'page',
int|null $page = null,
Closure|int|null $total = null,
): LengthAwarePaginator
Paginate the given query.
Paginate the given query.
Throws
|
#
|
public
|
simplePaginate(
int|null $perPage = null,
array|string $columns = ['*'],
string $pageName = 'page',
int|null $page = null,
): Paginator
Paginate the given query into a simple paginator.
Paginate the given query into a simple paginator.
|
#
|
public
|
cursorPaginate(
int|null $perPage = null,
array|string $columns = ['*'],
string $cursorName = 'cursor',
Cursor|string|null $cursor = null,
): CursorPaginator
Paginate the given query into a cursor paginator.
Paginate the given query into a cursor paginator.
|
#
|
protected
|
ensureOrderForCursorPagination(bool $shouldReverse = false): Collection
Ensure the proper order by required for cursor pagination.
Ensure the proper order by required for cursor pagination.
|
#
|
public
|
create(array $attributes = []): TModel
Save a new model and return the instance.
Save a new model and return the instance.
|
#
|
public
|
createQuietly(array $attributes = []): TModel
Save a new model and return the instance without raising model events.
Save a new model and return the instance without raising model events.
|
#
|
public
|
forceCreate(array $attributes): TModel
Save a new model and return the instance. Allow mass-assignment.
Save a new model and return the instance. Allow mass-assignment.
|
#
|
public
|
forceCreateQuietly(array $attributes = []): TModel
Save a new model instance with mass assignment without raising model events.
Save a new model instance with mass assignment without raising model events.
|
#
|
public
|
update(array $values): int
Update records in the database.
Update records in the database.
|
#
|
public
|
upsert(array $values, array|string $uniqueBy, array|null $update = null): int
Insert new records or update the existing ones.
Insert new records or update the existing ones.
|
#
|
public
|
touch(string|null $column = null): int|false
Update the column's update timestamp.
Update the column's update timestamp.
|
#
|
public
|
increment(string|Expression $column, float|int $amount = 1, array $extra = []): int
Increment a column's value by a given amount.
Increment a column's value by a given amount.
|
#
|
public
|
decrement(string|Expression $column, float|int $amount = 1, array $extra = []): int
Decrement a column's value by a given amount.
Decrement a column's value by a given amount.
|
#
|
protected
|
addUpdatedAtColumn(array $values): array
Add the "updated at" column to an array of values.
Add the "updated at" column to an array of values.
|
#
|
protected
|
addUniqueIdsToUpsertValues(array $values): array
Add unique IDs to the inserted values.
Add unique IDs to the inserted values.
|
#
|
protected
|
addTimestampsToUpsertValues(array $values): array
Add timestamps to the inserted values.
Add timestamps to the inserted values.
|
#
|
protected
|
addUpdatedAtToUpsertColumns(array $update): array
Add the "updated at" column to the updated columns.
Add the "updated at" column to the updated columns.
|
#
|
public
|
delete(): mixed
Delete records from the database.
Delete records from the database.
|
#
|
public
|
forceDelete(): mixed
Run the default delete function on the builder.
Run the default delete function on the builder.
Since we do not apply scopes here, the row will actually be deleted.
|
#
|
public
|
onDelete(Closure $callback): void
Register a replacement for the default delete function.
Register a replacement for the default delete function.
|
#
|
public
|
hasNamedScope(string $scope): bool
Determine if the given model has a scope.
Determine if the given model has a scope.
|
#
|
public
|
scopes(array|string $scopes): static|mixed
Call the given local model scopes.
Call the given local model scopes.
|
#
|
public
|
applyScopes(): static
Apply the scopes to the Eloquent builder instance and return it.
Apply the scopes to the Eloquent builder instance and return it.
|
#
|
protected
|
callScope(callable $scope, array $parameters = []): mixed
Apply the given scope on the current builder instance.
Apply the given scope on the current builder instance.
|
#
|
protected
|
callNamedScope(string $scope, array $parameters = []): mixed
Apply the given named scope on the current builder instance.
Apply the given named scope on the current builder instance.
|
#
|
protected
|
addNewWheresWithinGroup(Builder $query, int $originalWhereCount): void
Nest where conditions by slicing them at the given where count.
Nest where conditions by slicing them at the given where count.
|
#
|
protected
|
groupWhereSliceForScope(Builder $query, array $whereSlice): void
Slice where conditions at the given offset and add them to the query as a nested condition.
Slice where conditions at the given offset and add them to the query as a nested condition.
|
#
|
protected
|
createNestedWhere(array $whereSlice, string $boolean = 'and'): array
Create a where array with nested where conditions.
Create a where array with nested where conditions.
|
#
|
public
|
with(
array<array-key, array|(Closure(Relation<*, *, *>): mixed)|string>|string $relations,
(Closure(Relation<*, *, *>): mixed)|string|null $callback = null,
): $this
Specify relationships that should be eager loaded.
Specify relationships that should be eager loaded.
|
#
|
public
|
without(mixed $relations): $this
Prevent the specified relations from being eager loaded.
Prevent the specified relations from being eager loaded.
|
#
|
public
|
withOnly(array<array-key, array|(Closure(Relation<*, *, *>): mixed)|string>|string $relations): $this
Set the relationships that should be eager loaded while removing any previously added eager loading specifications.
Set the relationships that should be eager loaded while removing any previously added eager loading specifications.
|
#
|
public
|
newModelInstance(array $attributes = []): TModel
Create a new instance of the model being queried.
Create a new instance of the model being queried.
|
#
|
protected
|
parseWithRelations(array $relations): array
Parse a list of relations into individuals.
Parse a list of relations into individuals.
|
#
|
protected
|
prepareNestedWithRelationships(array $relations, string $prefix = ''): array
Prepare nested with relationships.
Prepare nested with relationships.
|
#
|
protected
|
combineConstraints(array $constraints): Closure
Combine an array of constraints into a single constraint.
Combine an array of constraints into a single constraint.
|
#
|
protected
|
parseNameAndAttributeSelectionConstraint(string $name): array
Parse the attribute select constraints from the name.
Parse the attribute select constraints from the name.
|
#
|
protected
|
createSelectWithConstraint(string $name): array
Create a constraint to select the given columns for the relation.
Create a constraint to select the given columns for the relation.
|
#
|
protected
|
addNestedWiths(string $name, array $results): array
Parse the nested relationships in a relation.
Parse the nested relationships in a relation.
|
#
|
public
|
withAttributes(Expression|array|string $attributes, mixed $value = null): $this
Specify attributes that should be added to any new models created by this builder.
Specify attributes that should be added to any new models created by this builder.
The given key / value pairs will also be added as where conditions to the query.
|
#
|
public
|
withCasts(array $casts): $this
Apply query-time casts to the model instance.
Apply query-time casts to the model instance.
|
#
|
public
|
withSavepointIfNeeded<TModelValue>(Closure(): TModelValue $scope): TModelValue
Execute the given Closure within a transaction savepoint if needed.
Execute the given Closure within a transaction savepoint if needed.
|
#
|
protected
|
getUnionBuilders(): Collection
Get the Eloquent builder instances that are used in the union of the query.
Get the Eloquent builder instances that are used in the union of the query.
|
#
|
public
|
getQuery(): Builder
Get the underlying query builder instance.
Get the underlying query builder instance.
|
#
|
public
|
setQuery(Builder $query): $this
Set the underlying query builder instance.
Set the underlying query builder instance.
|
#
|
public
|
toBase(): Builder
Get a base query builder instance.
Get a base query builder instance.
|
#
|
public
|
getEagerLoads(): array
Get the relationships being eagerly loaded.
Get the relationships being eagerly loaded.
|
#
|
public
|
setEagerLoads(array $eagerLoad): $this
Set the relationships being eagerly loaded.
Set the relationships being eagerly loaded.
|
#
|
public
|
withoutEagerLoad(array $relations): $this
Indicate that the given relationships should not be eagerly loaded.
Indicate that the given relationships should not be eagerly loaded.
|
#
|
public
|
withoutEagerLoads(): $this
Flush the relationships being eagerly loaded.
Flush the relationships being eagerly loaded.
|
#
|
public
|
getLimit(): mixed
Get the "limit" value from the query or null if it's not set.
Get the "limit" value from the query or null if it's not set.
|
#
|
public
|
getOffset(): mixed
Get the "offset" value from the query or null if it's not set.
Get the "offset" value from the query or null if it's not set.
|
#
|
protected
|
defaultKeyName(): string
Get the default key name of the table.
Get the default key name of the table.
|
#
|
public
|
getModel(): TModel
Get the model instance being queried.
Get the model instance being queried.
|
#
|
public
|
setModel<TModelNew is Model>(TModelNew $model): static<TModelNew>
Set a model instance for the model being queried.
Set a model instance for the model being queried.
|
#
|
public
|
qualifyColumn(string|Expression $column): string
Qualify the given column name by the model's table.
Qualify the given column name by the model's table.
|
#
|
public
|
qualifyColumns(array|Expression $columns): array
Qualify the given columns with the model's table.
Qualify the given columns with the model's table.
|
#
|
public
|
getMacro(string $name): Closure
Get the given macro by name.
Get the given macro by name.
|
#
|
public
|
hasMacro(string $name): bool
Checks if a macro is registered.
Checks if a macro is registered.
|
#
|
public
static
|
getGlobalMacro(string $name): Closure
Get the given global macro by name.
Get the given global macro by name.
|
#
|
public
static
|
hasGlobalMacro(string $name): bool
Checks if a global macro is registered.
Checks if a global macro is registered.
|
#
|
public
|
__get(string $key): mixed
Dynamically access builder proxies.
Dynamically access builder proxies.
Throws
|
#
|
public
|
__call(string $method, array $parameters): mixed
Dynamically handle calls into the query instance.
Dynamically handle calls into the query instance.
|
#
|
public
static
|
__callStatic(string $method, array $parameters): mixed
Dynamically handle calls into the query instance.
Dynamically handle calls into the query instance.
Throws
|
#
|
protected
static
|
registerMixin(string $mixin, bool $replace): void
Register the given mixin with the builder.
Register the given mixin with the builder.
|
#
|
public
|
clone(): static
Clone the Eloquent query builder.
Clone the Eloquent query builder.
|
#
|
public
|
onClone(Closure $callback): $this
Register a closure to be invoked on a clone.
Register a closure to be invoked on a clone.
|
#
|
public
|
__clone(): void
Force a clone of the underlying query builder when cloning.
Force a clone of the underlying query builder when cloning.
|
#
|