HasManyThrough
class HasManyThrough extends HasOneOrManyThrough (View source)
Traits
| InteractsWithDictionary | |
| InteractsWithDictionary | |
| ForwardsCalls | |
| Macroable |
Properties
| static protected array | $macros | The registered string macros. | from Macroable |
| protected TRelatedModel> | $query | The Eloquent query builder instance. | from Relation |
| protected TDeclaringModel | $parent | The parent model instance. | from Relation |
| protected TRelatedModel | $related | The related model instance. | from Relation |
| protected bool | $eagerKeysWereEmpty | Indicates whether the eagerly loaded relation should implicitly return an empty collection. | from Relation |
| static protected bool | $constraints | Indicates if the relation is adding constraints. | from Relation |
| static array | $morphMap | An array to map class names to their morph names in the database. | from Relation |
| static protected bool | $requireMorphMap | Prevents morph relationships without a morph map. | from Relation |
| static protected int | $selfJoinCount | The count of self joins. | from Relation |
| protected TIntermediateModel | $throughParent | The "through" parent model instance. | from HasOneOrManyThrough |
| protected TDeclaringModel | $farParent | The far parent model instance. | from HasOneOrManyThrough |
| protected string | $firstKey | The near key on the relationship. | from HasOneOrManyThrough |
| protected string | $secondKey | The far key on the relationship. | from HasOneOrManyThrough |
| protected string | $localKey | The local key on the relationship. | from HasOneOrManyThrough |
| protected string | $secondLocalKey | The local key on the intermediary model. | from HasOneOrManyThrough |
Methods
| mixed | forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object. | from ForwardsCalls |
| mixed | forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object, returning $this if the forwarded call returned itself. | from ForwardsCalls |
| static void | throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method. | from ForwardsCalls |
| static void | macro(string $name, object|callable $macro)
Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name)
Checks if macro is registered. | from Macroable |
| static void | flushMacros()
Flush the existing macros. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| mixed | __call(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| void | __construct(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Create a new has many through relationship instance. | from HasOneOrManyThrough |
| static mixed | noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation. | from Relation |
| void | addConstraints()
Set the base constraints on the relation query. | from HasOneOrManyThrough |
| void | addEagerConstraints(array $models) No description | from HasOneOrManyThrough |
| TDeclaringModel> | initRelation(array $models, string $relation) No description | |
| TDeclaringModel> | match(array $models, Collection $results, string $relation) No description | |
| TResult | getResults() No description | |
| TRelatedModel> | getEager()
Get the relationship for eager loading. | from Relation |
| TRelatedModel | sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record. | from Relation |
| TRelatedModel> | get(array $columns = ['*']) No description | from HasOneOrManyThrough |
| void | touch()
Touch all of the related models for the relationship. | from Relation |
| int | rawUpdate(array $attributes = [])
Run a raw update against the base query. | from Relation |
| TRelatedModel> | getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query. | from Relation |
| TRelatedModel> | getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) No description | from HasOneOrManyThrough |
| string | getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash. | from Relation |
| array<int,int|string> | getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models. | from Relation |
| TRelatedModel> | getRelationQuery()
Get the query builder that will contain the relationship constraints. | from Relation |
| TRelatedModel> | getQuery()
Get the underlying query for the relation. | from Relation |
| Builder | getBaseQuery()
Get the base query builder driving the Eloquent builder. | from Relation |
| Builder | toBase()
Get a base query builder instance. | from Relation |
| TDeclaringModel | getParent()
Get the parent model of the relation. | from Relation |
| string | getQualifiedParentKeyName()
Get the fully qualified parent key name. | from HasOneOrManyThrough |
| TRelatedModel | getRelated()
Get the related model of the relation. | from Relation |
| string | createdAt()
Get the name of the "created at" column. | from Relation |
| string | updatedAt()
Get the name of the "updated at" column. | from Relation |
| string | relatedUpdatedAt()
Get the name of the related model's "updated at" column. | from Relation |
| void | whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)
Add a whereIn eager constraint for the given set of model keys to be loaded. | from Relation |
| string | whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading. | from Relation |
| static void | requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings. | from Relation |
| static bool | requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping. | from Relation |
| static array | enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped. | from Relation |
| static array | morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations. | from Relation |
| static array|null | buildMorphMapFromModels(array|null $models = null)
Builds a table-keyed array from model class names. | from Relation |
| static string|null | getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type. | from Relation |
| static int|string | getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class. | from Relation |
| void | __clone()
Force a clone of the underlying query builder when cloning. | from Relation |
| mixed | getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary. | from InteractsWithDictionary |
| void | performJoin(Builder|null $query = null)
Set the join clause on the query. | from HasOneOrManyThrough |
| bool | throughParentSoftDeletes()
Determine whether "through" parent of the relation uses Soft Deletes. | from HasOneOrManyThrough |
| $this | withTrashedParents()
Indicate that trashed "through" parents should be included in the query. | from HasOneOrManyThrough |
| TRelatedModel[][] | buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key. | from HasOneOrManyThrough |
| TRelatedModel | firstOrNew(array $attributes = [], array $values = [])
Get the first related model record matching the attributes or instantiate it. | from HasOneOrManyThrough |
| TRelatedModel | firstOrCreate(array $attributes = [], array $values = [])
Get the first record matching the attributes. If the record is not found, create it. | from HasOneOrManyThrough |
| TRelatedModel | createOrFirst(array $attributes = [], array $values = [])
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record. | from HasOneOrManyThrough |
| TRelatedModel | updateOrCreate(array $attributes, array $values = [])
Create or update a related record matching the attributes, and fill it with values. | from HasOneOrManyThrough |
| TRelatedModel|null | firstWhere(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a basic where clause to the query, and return the first result. | from HasOneOrManyThrough |
| TRelatedModel|null | first(array $columns = ['*'])
Execute the query and get the first related model. | from HasOneOrManyThrough |
| TRelatedModel | firstOrFail(array $columns = ['*'])
Execute the query and get the first result or throw an exception. | from HasOneOrManyThrough |
| firstOr($columns = ['*'], Closure|null $callback = null) No description | from HasOneOrManyThrough | |
| find(mixed $id, array $columns = ['*'])
Find a related model by its primary key. | from HasOneOrManyThrough | |
| TRelatedModel> | findMany(Arrayable|array $ids, array $columns = ['*'])
Find multiple related models by their primary keys. | from HasOneOrManyThrough |
| findOrFail(mixed $id, array $columns = ['*'])
Find a related model by its primary key or throw an exception. | from HasOneOrManyThrough | |
| findOr($id, $columns = ['*'], Closure|null $callback = null) No description | from HasOneOrManyThrough | |
| LengthAwarePaginator | paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int $page = null)
Get a paginator for the "select" statement. | from HasOneOrManyThrough |
| Paginator | simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Paginate the given query into a simple paginator. | from HasOneOrManyThrough |
| CursorPaginator | cursorPaginate(int|null $perPage = null, array $columns = ['*'], string $cursorName = 'cursor', string|null $cursor = null)
Paginate the given query into a cursor paginator. | from HasOneOrManyThrough |
| array | shouldSelect(array $columns = ['*'])
Set the select clause for the relation query. | from HasOneOrManyThrough |
| bool | chunk(int $count, callable $callback)
Chunk the results of the query. | from HasOneOrManyThrough |
| bool | chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing numeric IDs. | from HasOneOrManyThrough |
| bool | chunkByIdDesc(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing IDs in descending order. | from HasOneOrManyThrough |
| bool | eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)
Execute a callback over each item while chunking by ID. | from HasOneOrManyThrough |
| TRelatedModel> | cursor()
Get a generator for the given query. | from HasOneOrManyThrough |
| bool | each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking. | from HasOneOrManyThrough |
| TRelatedModel> | lazy(int $chunkSize = 1000)
Query lazily, by chunks of the given size. | from HasOneOrManyThrough |
| TRelatedModel> | lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs. | from HasOneOrManyThrough |
| TRelatedModel> | lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs in descending order. | from HasOneOrManyThrough |
| TRelatedModel> | prepareQueryBuilder(array $columns = ['*'])
Prepare the query builder for query execution. | from HasOneOrManyThrough |
| TRelatedModel> | getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table. | from HasOneOrManyThrough |
| TRelatedModel> | getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table as the through parent. | from HasOneOrManyThrough |
| $this | take(int $value)
Alias to set the "limit" value of the query. | from HasOneOrManyThrough |
| $this | limit(int $value)
Set the "limit" value of the query. | from HasOneOrManyThrough |
| string | getQualifiedFarKeyName()
Get the qualified foreign key on the related model. | from HasOneOrManyThrough |
| string | getFirstKeyName()
Get the foreign key on the "through" model. | from HasOneOrManyThrough |
| string | getQualifiedFirstKeyName()
Get the qualified foreign key on the "through" model. | from HasOneOrManyThrough |
| string | getForeignKeyName()
Get the foreign key on the related model. | from HasOneOrManyThrough |
| string | getQualifiedForeignKeyName()
Get the qualified foreign key on the related model. | from HasOneOrManyThrough |
| string | getLocalKeyName()
Get the local key on the far parent model. | from HasOneOrManyThrough |
| string | getQualifiedLocalKeyName()
Get the qualified local key on the far parent model. | from HasOneOrManyThrough |
| string | getSecondLocalKeyName()
Get the local key on the intermediary model. | from HasOneOrManyThrough |
| one() No description |
Details
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object, returning $this if the forwarded call returned itself.
static protected void throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
static void flushMacros()
Flush the existing macros.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
void __construct(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Create a new has many through relationship instance.
static mixed noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
void addConstraints()
Set the base constraints on the relation query.
void addEagerConstraints(array $models)
No description
TDeclaringModel> initRelation(array $models, string $relation)
No description
TDeclaringModel> match(array $models, Collection $results, string $relation)
No description
TResult getResults()
No description
TRelatedModel> getEager()
Get the relationship for eager loading.
TRelatedModel sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
TRelatedModel> get(array $columns = ['*'])
No description
void touch()
Touch all of the related models for the relationship.
int rawUpdate(array $attributes = [])
Run a raw update against the base query.
TRelatedModel> getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
TRelatedModel> getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
No description
string getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
protected array<int,int|string> getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
protected TRelatedModel> getRelationQuery()
Get the query builder that will contain the relationship constraints.
TRelatedModel> getQuery()
Get the underlying query for the relation.
Builder getBaseQuery()
Get the base query builder driving the Eloquent builder.
Builder toBase()
Get a base query builder instance.
TDeclaringModel getParent()
Get the parent model of the relation.
string getQualifiedParentKeyName()
Get the fully qualified parent key name.
TRelatedModel getRelated()
Get the related model of the relation.
string createdAt()
Get the name of the "created at" column.
string updatedAt()
Get the name of the "updated at" column.
string relatedUpdatedAt()
Get the name of the related model's "updated at" column.
protected void whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)
Add a whereIn eager constraint for the given set of model keys to be loaded.
protected string whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
static void requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings.
static bool requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
static array enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
static array morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array|null $models = null)
Builds a table-keyed array from model class names.
static string|null getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
static int|string getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
void __clone()
Force a clone of the underlying query builder when cloning.
protected mixed getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary.
protected void performJoin(Builder|null $query = null)
Set the join clause on the query.
bool throughParentSoftDeletes()
Determine whether "through" parent of the relation uses Soft Deletes.
$this withTrashedParents()
Indicate that trashed "through" parents should be included in the query.
protected TRelatedModel[][] buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
TRelatedModel firstOrNew(array $attributes = [], array $values = [])
Get the first related model record matching the attributes or instantiate it.
TRelatedModel firstOrCreate(array $attributes = [], array $values = [])
Get the first record matching the attributes. If the record is not found, create it.
TRelatedModel createOrFirst(array $attributes = [], array $values = [])
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
TRelatedModel updateOrCreate(array $attributes, array $values = [])
Create or update a related record matching the attributes, and fill it with values.
TRelatedModel|null firstWhere(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a basic where clause to the query, and return the first result.
TRelatedModel|null first(array $columns = ['*'])
Execute the query and get the first related model.
TRelatedModel firstOrFail(array $columns = ['*'])
Execute the query and get the first result or throw an exception.
firstOr($columns = ['*'], Closure|null $callback = null)
No description
find(mixed $id, array $columns = ['*'])
Find a related model by its primary key.
TRelatedModel> findMany(Arrayable|array $ids, array $columns = ['*'])
Find multiple related models by their primary keys.
findOrFail(mixed $id, array $columns = ['*'])
Find a related model by its primary key or throw an exception.
findOr($id, $columns = ['*'], Closure|null $callback = null)
No description
LengthAwarePaginator paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int $page = null)
Get a paginator for the "select" statement.
Paginator simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Paginate the given query into a simple paginator.
CursorPaginator cursorPaginate(int|null $perPage = null, array $columns = ['*'], string $cursorName = 'cursor', string|null $cursor = null)
Paginate the given query into a cursor paginator.
protected array shouldSelect(array $columns = ['*'])
Set the select clause for the relation query.
bool chunk(int $count, callable $callback)
Chunk the results of the query.
bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing numeric IDs.
bool chunkByIdDesc(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing IDs in descending order.
bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)
Execute a callback over each item while chunking by ID.
TRelatedModel> cursor()
Get a generator for the given query.
bool each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking.
TRelatedModel> lazy(int $chunkSize = 1000)
Query lazily, by chunks of the given size.
TRelatedModel> lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs.
TRelatedModel> lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs in descending order.
protected TRelatedModel> prepareQueryBuilder(array $columns = ['*'])
Prepare the query builder for query execution.
TRelatedModel> getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
TRelatedModel> getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table as the through parent.
$this take(int $value)
Alias to set the "limit" value of the query.
$this limit(int $value)
Set the "limit" value of the query.
string getQualifiedFarKeyName()
Get the qualified foreign key on the related model.
string getFirstKeyName()
Get the foreign key on the "through" model.
string getQualifiedFirstKeyName()
Get the qualified foreign key on the "through" model.
string getForeignKeyName()
Get the foreign key on the related model.
string getQualifiedForeignKeyName()
Get the qualified foreign key on the related model.
string getLocalKeyName()
Get the local key on the far parent model.
string getQualifiedLocalKeyName()
Get the qualified local key on the far parent model.
string getSecondLocalKeyName()
Get the local key on the intermediary model.
one()
No description
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Eloquent/Relations/HasManyThrough.html