HasManyThrough
class HasManyThrough extends Relation (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Builder | $query | The Eloquent query builder instance. |
from Relation |
| protected Model | $parent | The parent model instance. |
from Relation |
| protected Model | $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 Model | $throughParent | The "through" parent model instance. |
|
| protected Model | $farParent | The far parent model instance. |
|
| protected string | $firstKey | The near key on the relationship. |
|
| protected string | $secondKey | The far key on the relationship. |
|
| protected string | $localKey | The local key on the relationship. |
|
| protected string | $secondLocalKey | The local key on the intermediary model. |
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. |
|
| 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. |
|
| void | addEagerConstraints(array $models) Set the constraints for an eager load of the relation. |
|
| array | initRelation(array $models, string $relation) Initialize the relation on a set of models. |
|
| array | match(array $models, Collection $results, string $relation) Match the eagerly loaded results to their parents. |
|
| mixed | getResults() Get the results of the relationship. |
|
| Collection | getEager() Get the relationship for eager loading. |
from Relation |
| Model | sole(array|string $columns = ['*']) Execute the query and get the first result if it's the sole matching record. |
from Relation |
| Collection | get(array $columns = ['*']) Execute the query as a "select" statement. |
|
| 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 |
| Builder | getRelationExistenceCountQuery(Builder $query, Builder $parentQuery) Add the constraints for a relationship count query. |
from Relation |
| Builder | getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query. |
|
| string | getRelationCountHash(bool $incrementJoinCount = true) Get a relationship join table hash. |
from Relation |
| array | getKeys(array $models, string|null $key = null) Get all of the primary keys for an array of models. |
from Relation |
| Builder | getRelationQuery() Get the query builder that will contain the relationship constraints. |
from Relation |
| Builder | 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 |
| Model | getParent() Get the parent model of the relation. |
from Relation |
| string | getQualifiedParentKeyName() Get the fully qualified parent key name. |
|
| Model | 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 $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 $map = null, bool $merge = true) Set or get the morph map for polymorphic relations. |
from Relation |
| static array|null | buildMorphMapFromModels(array $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 |
| 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 |
| HasOneThrough | one() Convert the relationship to a "has one through" relationship. |
|
| void | performJoin(Builder $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. |
|
| array | buildDictionary(Collection $results) Build model dictionary keyed by the relation's foreign key. |
|
| Model | firstOrNew(array $attributes) Get the first related model record matching the attributes or instantiate it. |
|
| Model | updateOrCreate(array $attributes, array $values = []) Create or update a related record matching the attributes, and fill it with values. |
|
| Model|HasManyThrough | 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. |
|
| mixed | first(array $columns = ['*']) Execute the query and get the first related model. |
|
| Model|HasManyThrough | firstOrFail(array $columns = ['*']) Execute the query and get the first result or throw an exception. |
|
| Model|HasManyThrough|mixed | firstOr(Closure|array $columns = ['*'], Closure $callback = null) Execute the query and get the first result or call a callback. |
|
| Model|Collection|null | find(mixed $id, array $columns = ['*']) Find a related model by its primary key. |
|
| Collection | findMany(Arrayable|array $ids, array $columns = ['*']) Find multiple related models by their primary keys. |
|
| Model|Collection | findOrFail(mixed $id, array $columns = ['*']) Find a related model by its primary key or throw an exception. |
|
| Model|Collection|mixed | findOr(mixed $id, Closure|array $columns = ['*'], Closure $callback = null) Find a related model by its primary key or call a callback. |
|
| 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. |
|
| 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. |
|
| LazyCollection | cursor() Get a generator for the given query. |
|
| bool | each(callable $callback, int $count = 1000) Execute a callback over each item while chunking. |
|
| LazyCollection | lazy(int $chunkSize = 1000) Query lazily, by chunks of the given size. |
|
| LazyCollection | lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null) Query lazily, by chunking the results of a query by comparing IDs. |
|
| Builder | prepareQueryBuilder(array $columns = ['*']) Prepare the query builder for query execution. |
|
| Builder | getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query on the same table. |
|
| Builder | getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query on the same table as the through parent. |
|
| 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. |
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)
Set the constraints for an eager load of the relation.
array initRelation(array $models, string $relation)
Initialize the relation on a set of models.
array match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
mixed getResults()
Get the results of the relationship.
Collection getEager()
Get the relationship for eager loading.
Model sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
Collection get(array $columns = ['*'])
Execute the query as a "select" statement.
void touch()
Touch all of the related models for the relationship.
int rawUpdate(array $attributes = [])
Run a raw update against the base query.
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query.
string getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
protected array getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
protected Builder getRelationQuery()
Get the query builder that will contain the relationship constraints.
Builder 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.
Model getParent()
Get the parent model of the relation.
string getQualifiedParentKeyName()
Get the fully qualified parent key name.
Model 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 $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 $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array $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.
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.
HasOneThrough one()
Convert the relationship to a "has one through" relationship.
protected void performJoin(Builder $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 array buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
Model firstOrNew(array $attributes)
Get the first related model record matching the attributes or instantiate it.
Model updateOrCreate(array $attributes, array $values = [])
Create or update a related record matching the attributes, and fill it with values.
Model|HasManyThrough 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.
mixed first(array $columns = ['*'])
Execute the query and get the first related model.
Model|HasManyThrough firstOrFail(array $columns = ['*'])
Execute the query and get the first result or throw an exception.
Model|HasManyThrough|mixed firstOr(Closure|array $columns = ['*'], Closure $callback = null)
Execute the query and get the first result or call a callback.
Model|Collection|null find(mixed $id, array $columns = ['*'])
Find a related model by its primary key.
Collection findMany(Arrayable|array $ids, array $columns = ['*'])
Find multiple related models by their primary keys.
Model|Collection findOrFail(mixed $id, array $columns = ['*'])
Find a related model by its primary key or throw an exception.
Model|Collection|mixed findOr(mixed $id, Closure|array $columns = ['*'], Closure $callback = null)
Find a related model by its primary key or call a callback.
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.
LazyCollection cursor()
Get a generator for the given query.
bool each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking.
LazyCollection lazy(int $chunkSize = 1000)
Query lazily, by chunks of the given size.
LazyCollection lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs.
protected Builder prepareQueryBuilder(array $columns = ['*'])
Prepare the query builder for query execution.
Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
Builder getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table as the through parent.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Eloquent/Relations/HasManyThrough.html