class HasManyThrough extends Relation (View source)
| ForwardsCalls | |
| Macroable |
| 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 |
| 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 database. | 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. | |
| static protected int | $selfJoinCount | The count of self joins. |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object. | 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 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 |
| 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. | |
| array | getKeys(array $models, string|null $key = null) Get all of the primary keys for an array of models. | 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 |
| 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 |
| string | whereInMethod(Model $model, string $key) Get the name of the "where in" method for eager loading. | 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 |
| 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|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. | |
| 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. | |
| 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. | |
| Generator | cursor() Get a generator for the given query. | |
| bool | each(callable $callback, int $count = 1000) Execute a callback over each item while chunking. | |
| 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 | getRelationCountHash() Get a relationship join table hash. | |
| 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. |
Forward a method call to the given object.
Throw a bad method call exception for the given method.
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new has many through relationship instance.
Run a callback with constraints disabled on the relation.
Set the base constraints on the relation query.
Set the constraints for an eager load of the relation.
Initialize the relation on a set of models.
Match the eagerly loaded results to their parents.
Get the results of the relationship.
Get the relationship for eager loading.
Execute the query as a "select" statement.
Touch all of the related models for the relationship.
Run a raw update against the base query.
Add the constraints for a relationship count query.
Add the constraints for a relationship query.
Get all of the primary keys for an array of models.
Get the underlying query for the relation.
Get the base query builder driving the Eloquent builder.
Get the parent model of the relation.
Get the fully qualified parent key name.
Get the related model of the relation.
Get the name of the "created at" column.
Get the name of the "updated at" column.
Get the name of the related model's "updated at" column.
Get the name of the "where in" method for eager loading.
Set or get the morph map for polymorphic relations.
Builds a table-keyed array from model class names.
Get the model associated with a custom polymorphic type.
Force a clone of the underlying query builder when cloning.
Set the join clause on the query.
Determine whether "through" parent of the relation uses Soft Deletes.
Indicate that trashed "through" parents should be included in the query.
Build model dictionary keyed by the relation's foreign key.
Get the first related model record matching the attributes or instantiate it.
Create or update a related record matching the attributes, and fill it with values.
Add a basic where clause to the query, and return the first result.
Execute the query and get the first related model.
Execute the query and get the first result or throw an exception.
Find a related model by its primary key.
Find multiple related models by their primary keys.
Find a related model by its primary key or throw an exception.
Get a paginator for the "select" statement.
Paginate the given query into a simple paginator.
Set the select clause for the relation query.
Chunk the results of the query.
Chunk the results of a query by comparing numeric IDs.
Get a generator for the given query.
Execute a callback over each item while chunking.
Prepare the query builder for query execution.
Add the constraints for a relationship query on the same table.
Add the constraints for a relationship query on the same table as the through parent.
Get a relationship join table hash.
Get the qualified foreign key on the related model.
Get the foreign key on the "through" model.
Get the qualified foreign key on the "through" model.
Get the foreign key on the related model.
Get the qualified foreign key on the related model.
Get the local key on the far parent model.
Get the qualified local key on the far parent model.
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/8.x/Illuminate/Database/Eloquent/Relations/HasManyThrough.html