| Methods |
public
|
__construct(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string|class-string<TRelatedModel> $table,
string $foreignPivotKey,
string $relatedPivotKey,
string $parentKey,
string $relatedKey,
string|null $relationName = null,
): void
Create a new belongs to many relationship instance.
Create a new belongs to many relationship instance.
Overrides
Overriden by
|
#
|
protected
|
resolveTableName(string $table): string
Attempt to resolve the intermediate table name from the given string.
Attempt to resolve the intermediate table name from the given string.
|
#
|
public
|
addConstraints(): void
Set the base constraints on the relation query.
Set the base constraints on the relation query.
Implements
|
#
|
protected
|
performJoin(Builder<TRelatedModel>|null $query = null): $this
Set the join clause for the relation query.
Set the join clause for the relation query.
|
#
|
protected
|
addWhereConstraints(): $this
Set the where clause for the relation query.
Set the where clause for the relation query.
Overriden by
|
#
|
public
|
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
Set the constraints for an eager load of the relation.
Overriden by
Implements
|
#
|
public
|
initRelation(array $models, $relation)
Initialize the relation on a set of models.
Initialize the relation on a set of models.
Implements
|
#
|
public
|
match(array $models, Collection $results, $relation)
Match the eagerly loaded results to their parents.
Match the eagerly loaded results to their parents.
Implements
|
#
|
protected
|
buildDictionary(Collection<int, TRelatedModel> $results): array<array<string, TRelatedModel>>
Build model dictionary keyed by the relation's foreign key.
Build model dictionary keyed by the relation's foreign key.
|
#
|
public
|
getPivotClass(): class-string<TPivotModel>
Get the class being used for pivot models.
Get the class being used for pivot models.
|
#
|
public
|
using(class-string<TPivotModel> $class): $this
Specify the custom pivot model to use for the relationship.
Specify the custom pivot model to use for the relationship.
|
#
|
public
|
as(string $accessor): $this
Specify the custom pivot accessor to use for the relationship.
Specify the custom pivot accessor to use for the relationship.
|
#
|
public
|
wherePivot(string|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and'): $this
Set a where clause for a pivot table column.
Set a where clause for a pivot table column.
|
#
|
public
|
wherePivotBetween(string|Expression $column, array $values, string $boolean = 'and', bool $not = false): $this
Set a "where between" clause for a pivot table column.
Set a "where between" clause for a pivot table column.
|
#
|
public
|
orWherePivotBetween(string|Expression $column, array $values): $this
Set a "or where between" clause for a pivot table column.
Set a "or where between" clause for a pivot table column.
|
#
|
public
|
wherePivotNotBetween(string|Expression $column, array $values, string $boolean = 'and'): $this
Set a "where pivot not between" clause for a pivot table column.
Set a "where pivot not between" clause for a pivot table column.
|
#
|
public
|
orWherePivotNotBetween(string|Expression $column, array $values): $this
Set a "or where not between" clause for a pivot table column.
Set a "or where not between" clause for a pivot table column.
|
#
|
public
|
wherePivotIn(string|Expression $column, mixed $values, string $boolean = 'and', bool $not = false): $this
Set a "where in" clause for a pivot table column.
Set a "where in" clause for a pivot table column.
|
#
|
public
|
orWherePivot(string|Expression $column, mixed $operator = null, mixed $value = null): $this
Set an "or where" clause for a pivot table column.
Set an "or where" clause for a pivot table column.
|
#
|
public
|
withPivotValue(string|Expression|array<string, string> $column, mixed $value = null): $this
Set a where clause for a pivot table column.
Set a where clause for a pivot table column.
In addition, new pivot records will receive this value.
Throws
|
#
|
public
|
orWherePivotIn(string $column, mixed $values): $this
Set an "or where in" clause for a pivot table column.
Set an "or where in" clause for a pivot table column.
|
#
|
public
|
wherePivotNotIn(string|Expression $column, mixed $values, string $boolean = 'and'): $this
Set a "where not in" clause for a pivot table column.
Set a "where not in" clause for a pivot table column.
|
#
|
public
|
orWherePivotNotIn(string $column, mixed $values): $this
Set an "or where not in" clause for a pivot table column.
Set an "or where not in" clause for a pivot table column.
|
#
|
public
|
wherePivotNull(string|Expression $column, string $boolean = 'and', bool $not = false): $this
Set a "where null" clause for a pivot table column.
Set a "where null" clause for a pivot table column.
|
#
|
public
|
wherePivotNotNull(string|Expression $column, string $boolean = 'and'): $this
Set a "where not null" clause for a pivot table column.
Set a "where not null" clause for a pivot table column.
|
#
|
public
|
orWherePivotNull(string|Expression $column, bool $not = false): $this
Set a "or where null" clause for a pivot table column.
Set a "or where null" clause for a pivot table column.
|
#
|
public
|
orWherePivotNotNull(string|Expression $column): $this
Set a "or where not null" clause for a pivot table column.
Set a "or where not null" clause for a pivot table column.
|
#
|
public
|
orderByPivot(string|Expression $column, string $direction = 'asc'): $this
Add an "order by" clause for a pivot table column.
Add an "order by" clause for a pivot table column.
|
#
|
public
|
findOrNew(
mixed $id,
array $columns = ['*'],
): ($id is Arrayable<array-key, mixed>|array<mixed> ? Collection<int, TRelatedModel> : TRelatedModel)
Find a related model by its primary key or return a new instance of the related model.
Find a related model by its primary key or return a new instance of the related model.
|
#
|
public
|
firstOrNew(array $attributes = [], array $values = []): TRelatedModel
Get the first related model record matching the attributes or instantiate it.
Get the first related model record matching the attributes or instantiate it.
|
#
|
public
|
firstOrCreate(array $attributes = [], array $values = [], array $joining = [], bool $touch = true): TRelatedModel
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 = [], array $joining = [], bool $touch = true): TRelatedModel
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 = [], array $joining = [], bool $touch = true): TRelatedModel
Create or update a related record matching the attributes, and fill it with values.
Create or update a related record matching the attributes, and fill it with values.
|
#
|
public
|
find(
mixed $id,
array $columns = ['*'],
): ($id is Arrayable<array-key, mixed>|array<mixed> ? Collection<int, TRelatedModel> : TRelatedModel|null)
Find a related model by its primary key.
Find a related model by its primary key.
|
#
|
public
|
findSole(mixed $id, array $columns = ['*']): TRelatedModel
Find a sole related model by its primary key.
Find a sole related model by its primary key.
Throws
|
#
|
public
|
findMany(Arrayable|array $ids, array $columns = ['*']): Collection<int, TRelatedModel>
Find multiple related models by their primary keys.
Find multiple related models by their primary keys.
|
#
|
public
|
findOrFail(
mixed $id,
array $columns = ['*'],
): ($id is Arrayable<array-key, mixed>|array<mixed> ? Collection<int, TRelatedModel> : TRelatedModel)
Find a related model by its primary key or throw an exception.
Find a related model by its primary key or throw an exception.
Throws
|
#
|
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, TRelatedModel>|TValue : TRelatedModel|TValue)
Find a related model by its primary key or call a callback.
Find a related model by its primary key or call a callback.
|
#
|
public
|
firstWhere(
Closure|string|array $column,
mixed $operator = null,
mixed $value = null,
string $boolean = 'and',
): TRelatedModel|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
|
first(array $columns = ['*']): TRelatedModel|null
Execute the query and get the first result.
Execute the query and get the first result.
|
#
|
public
|
firstOrFail(array $columns = ['*']): TRelatedModel
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,
): TRelatedModel|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
|
getResults()
Get the results of the relationship.
Get the results of the relationship.
Implements
|
#
|
public
|
get($columns = ['*'])
Execute the query as a "select" statement.
Execute the query as a "select" statement.
Overrides
|
#
|
protected
|
shouldSelect(array $columns = ['*']): array
Get the select columns for the relation query.
Get the select columns for the relation query.
|
#
|
protected
|
aliasedPivotColumns(): array
Get the pivot columns for the relation.
Get the pivot columns for the relation.
"pivot_" is prefixed at each column for easy removal later.
Overriden by
|
#
|
public
|
paginate(
int|null $perPage = null,
array $columns = ['*'],
string $pageName = 'page',
int|null $page = null,
): LengthAwarePaginator
Get a paginator for the "select" statement.
Get a paginator for the "select" statement.
|
#
|
public
|
simplePaginate(
int|null $perPage = null,
array $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 $columns = ['*'],
string $cursorName = 'cursor',
string|null $cursor = null,
): CursorPaginator
Paginate the given query into a cursor paginator.
Paginate the given query into a cursor paginator.
|
#
|
public
|
chunk(int $count, callable $callback): bool
Chunk the results of the query.
Chunk the results of the query.
|
#
|
public
|
chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null): bool
Chunk the results of a query by comparing numeric IDs.
Chunk the results of a query by comparing numeric IDs.
|
#
|
public
|
chunkByIdDesc(int $count, callable $callback, string|null $column = null, string|null $alias = null): bool
Chunk the results of a query by comparing IDs in descending order.
Chunk the results of a query by comparing IDs in descending order.
|
#
|
public
|
eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null): bool
Execute a callback over each item while chunking by ID.
Execute a callback over each item while chunking by ID.
|
#
|
public
|
orderedChunkById(
int $count,
callable $callback,
string|null $column = null,
string|null $alias = null,
bool $descending = false,
): bool
Chunk the results of a query by comparing IDs in a given order.
Chunk the results of a query by comparing IDs in a given order.
|
#
|
public
|
each(callable $callback, int $count = 1000): bool
Execute a callback over each item while chunking.
Execute a callback over each item while chunking.
|
#
|
public
|
lazy(int $chunkSize = 1000): LazyCollection<int, TRelatedModel>
Query lazily, by chunks of the given size.
Query lazily, by chunks of the given size.
|
#
|
public
|
lazyById(
int $chunkSize = 1000,
string|null $column = null,
string|null $alias = null,
): LazyCollection<int, TRelatedModel>
Query lazily, by chunking the results of a query by comparing IDs.
Query lazily, by chunking the results of a query by comparing IDs.
|
#
|
public
|
lazyByIdDesc(
int $chunkSize = 1000,
string|null $column = null,
string|null $alias = null,
): LazyCollection<int, TRelatedModel>
Query lazily, by chunking the results of a query by comparing IDs in descending order.
Query lazily, by chunking the results of a query by comparing IDs in descending order.
|
#
|
public
|
cursor(): LazyCollection<int, TRelatedModel>
Get a lazy collection for the given query.
Get a lazy collection for the given query.
|
#
|
protected
|
prepareQueryBuilder(): Builder<TRelatedModel>
Prepare the query builder for query execution.
Prepare the query builder for query execution.
|
#
|
protected
|
hydratePivotRelation(array<int, TRelatedModel> $models): void
Hydrate the pivot table relationship on the models.
Hydrate the pivot table relationship on the models.
|
#
|
protected
|
migratePivotAttributes(TRelatedModel $model): array
Get the pivot attributes from a model.
Get the pivot attributes from a model.
|
#
|
public
|
touchIfTouching(): void
If we're touching the parent model, touch.
If we're touching the parent model, touch.
|
#
|
protected
|
touchingParent(): bool
Determine if we should touch the parent on sync.
Determine if we should touch the parent on sync.
|
#
|
protected
|
guessInverseRelation(): string
Attempt to guess the name of the inverse of the relation.
Attempt to guess the name of the inverse of the relation.
|
#
|
public
|
touch(): void
Touch all of the related models for the relationship.
Touch all of the related models for the relationship.
E.g.: Touch all roles associated with this user.
Overrides
|
#
|
public
|
allRelatedIds(): Collection<int, int|string>
Get all of the IDs for the related models.
Get all of the IDs for the related models.
|
#
|
public
|
save(TRelatedModel $model, array $pivotAttributes = [], bool $touch = true): TRelatedModel
Save a new model and attach it to the parent model.
Save a new model and attach it to the parent model.
|
#
|
public
|
saveQuietly(TRelatedModel $model, array $pivotAttributes = [], bool $touch = true): TRelatedModel
Save a new model without raising any events and attach it to the parent model.
Save a new model without raising any events and attach it to the parent model.
|
#
|
public
|
saveMany<TContainer is Collection<array-key, TRelatedModel>|array<array-key, TRelatedModel>>(
TContainer $models,
array $pivotAttributes = [],
): TContainer
Save an array of new models and attach them to the parent model.
Save an array of new models and attach them to the parent model.
|
#
|
public
|
saveManyQuietly<TContainer is Collection<array-key, TRelatedModel>|array<array-key, TRelatedModel>>(
TContainer $models,
array $pivotAttributes = [],
): TContainer
Save an array of new models without raising any events and attach them to the parent model.
Save an array of new models without raising any events and attach them to the parent model.
|
#
|
public
|
create(array $attributes = [], array $joining = [], bool $touch = true): TRelatedModel
Create a new instance of the related model.
Create a new instance of the related model.
|
#
|
public
|
createMany(iterable $records, array $joinings = []): array<int, TRelatedModel>
Create an array of new instances of the related models.
Create an array of new instances of the related models.
|
#
|
public
|
getRelationExistenceQuery(Builder $query, Builder $parentQuery, $columns = ['*'])
Add the constraints for an internal relationship existence query.
Add the constraints for an internal relationship existence query.
Essentially, these queries compare on column names like whereColumn.
Overrides
Overriden by
|
#
|
public
|
getRelationExistenceQueryForSelfJoin(
Builder<TRelatedModel> $query,
Builder<TDeclaringModel> $parentQuery,
array|mixed $columns = ['*'],
): Builder<TRelatedModel>
Add the constraints for a relationship query on the same table.
Add the constraints for a relationship query on the same table.
|
#
|
public
|
take(int $value): $this
Alias to set the "limit" value of the query.
Alias to set the "limit" value of the query.
|
#
|
public
|
limit(int $value): $this
Set the "limit" value of the query.
Set the "limit" value of the query.
|
#
|
public
|
getExistenceCompareKey(): string
Get the key for comparing against the parent key in "has" query.
Get the key for comparing against the parent key in "has" query.
|
#
|
public
|
withTimestamps(mixed $createdAt = null, mixed $updatedAt = null): $this
Specify that the pivot table has creation and update timestamps.
Specify that the pivot table has creation and update timestamps.
|
#
|
public
|
createdAt(): string
Get the name of the "created at" column.
Get the name of the "created at" column.
Overrides
|
#
|
public
|
updatedAt(): string
Get the name of the "updated at" column.
Get the name of the "updated at" column.
Overrides
|
#
|
public
|
getForeignPivotKeyName(): string
Get the foreign key for the relation.
Get the foreign key for the relation.
|
#
|
public
|
getQualifiedForeignPivotKeyName(): string
Get the fully qualified foreign key for the relation.
Get the fully qualified foreign key for the relation.
|
#
|
public
|
getRelatedPivotKeyName(): string
Get the "related key" for the relation.
Get the "related key" for the relation.
|
#
|
public
|
getQualifiedRelatedPivotKeyName(): string
Get the fully qualified "related key" for the relation.
Get the fully qualified "related key" for the relation.
|
#
|
public
|
getParentKeyName(): string
Get the parent key for the relationship.
Get the parent key for the relationship.
|
#
|
public
|
getQualifiedParentKeyName(): string
Get the fully qualified parent key name for the relation.
Get the fully qualified parent key name for the relation.
Overrides
|
#
|
public
|
getRelatedKeyName(): string
Get the related key for the relationship.
Get the related key for the relationship.
|
#
|
public
|
getQualifiedRelatedKeyName(): string
Get the fully qualified related key name for the relation.
Get the fully qualified related key name for the relation.
|
#
|
public
|
getTable(): string
Get the intermediate table for the relationship.
Get the intermediate table for the relationship.
|
#
|
public
|
getRelationName(): string
Get the relationship name for the relationship.
Get the relationship name for the relationship.
|
#
|
public
|
getPivotAccessor(): string
Get the name of the pivot accessor for this relationship.
Get the name of the pivot accessor for this relationship.
|
#
|
public
|
getPivotColumns(): array
Get the pivot columns for this relationship.
Get the pivot columns for this relationship.
|
#
|
public
|
qualifyPivotColumn(string|Expression $column): string|Expression
Qualify the given column name by the pivot table.
Qualify the given column name by the pivot table.
|
#
|