HasManyThrough
class HasManyThrough extends HasOneOrManyThrough
Traits
Constants
| protected CONSTRAINTS_CONTEXT_KEY |
The context key for storing whether constraints are enabled. |
| protected NESTED_CONSTRAINTS_CONTEXT_KEY |
The context key for enabling constraints on nested relation attributes. |
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 array<int|Model>> | $morphMap | An array to map morph names to their class 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
Forward a method call to the given object.
Forward a method call to the given object, returning $this if the forwarded call returned itself.
Throw a bad method call exception for the given method.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new has many through relationship instance.
Run a callback without constraints while preserving them for nested relation attributes.
Run a callback with the configured relation constraints.
Run a callback with constraints when resolving a nested relation attribute.
Determine if constraints should be added to 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.
Execute the query and get the first result if it's the sole matching record.
Execute the query as a "select" statement.
Add the constraints for a relationship count query.
Add the constraints for an internal relationship existence query.
Get a relationship join table hash.
Get all of the primary keys for an array of models.
Get the query builder that will contain the relationship constraints.
Get the fully-qualified parent key name.
Add a whereIn eager constraint for the given set of model keys to be loaded.
Prevent polymorphic relationships from being used without model mappings.
Determine if polymorphic relationships require explicit model mapping.
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
Set or get the morph map for polymorphic relations.
Build a table-keyed array from model class names.
Get the model associated with a custom polymorphic type.
Get the alias associated with a custom polymorphic class.
Get a dictionary key attribute - casting it to a string if necessary.
Determine whether "through" parent of the relation uses Soft Deletes.
Indicate that trashed "through" parents should be included in the query.
Get the first related model record matching the attributes or instantiate it.
Get the first record matching the attributes. If the record is not found, create it.
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
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.
Execute the query and get the first result or call a callback.
Find a related model by its primary key.
Find a sole 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.
Find a related model by its primary key or call a callback.
Get a paginator for the "select" statement.
Paginate the given query into a simple paginator.
Paginate the given query into a cursor paginator.
Set the select clause for the relation query.
Chunk the results of a query by comparing numeric IDs.
Chunk the results of a query by comparing IDs in descending order.
Execute a callback over each item while chunking by ID.
Execute a callback over each item while chunking.
Query lazily, by chunks of the given size.
Query lazily, by chunking the results of a query by comparing IDs.
Query lazily, by chunking the results of a query by comparing IDs in descending order.
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.
Alias to set the "limit" value of the query.
Get the qualified foreign key on the related model.
Get the qualified foreign key on the "through" model.
Get the qualified foreign key on the related model.
Get the qualified local key on the far parent model.
Get the local key on the intermediary model.
Convert the relationship to a "has one through" relationship.
Details
in
ForwardsCalls at line 22
protected mixed
forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
in
ForwardsCalls at line 52
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.
in
ForwardsCalls at line 66
static protected never
throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
in
Macroable at line 28
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 41
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 57
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 68
static void
flushMacros()
Flush the existing macros.
Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 78
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 103
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
in
HasOneOrManyThrough at line 78
__construct(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Create a new has many through relationship instance.
in
Relation at line 110
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
in
Relation at line 123
static mixed
noConstraintsForRelation(Closure $callback)
Run a callback without constraints while preserving them for nested relation attributes.
in
Relation at line 136
static protected mixed
withoutConstraints(Closure $callback, bool $constraintsForNestedRelations)
Run a callback with the configured relation constraints.
in
Relation at line 163
static mixed
withConstraints(Closure $callback)
Run a callback with constraints enabled on the relation.
in
Relation at line 184
static mixed
withConstraintsForNestedRelation(Closure $callback)
Run a callback with constraints when resolving a nested relation attribute.
in
Relation at line 194
static bool
shouldAddConstraints()
Determine if constraints should be added to the relation query.
in
HasOneOrManyThrough at line 93
void
addConstraints()
Set the base constraints on the relation query.
in
HasOneOrManyThrough at line 154
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
at line 41
array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
at line 50
array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
at line 71
TResult
getResults()
Get the results of the relationship.
in
Relation at line 240
Collection
getEager()
Get the relationship for eager loading.
in
Relation at line 255
Model
sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
in
HasOneOrManyThrough at line 450
Collection
get(array $columns = ['*'])
Execute the query as a "select" statement.
in
Relation at line 285
void
touch()
Touch all of the related models for the relationship.
in
Relation at line 299
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
in
Relation at line 311
Builder
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
in
HasOneOrManyThrough at line 641
Builder
getRelationExistenceQuery(Builder $query, Builder $parentQuery, mixed $columns = ['*'])
Add the constraints for an internal relationship existence query.
Essentially, these queries compare on column names like whereColumn.
in
Relation at line 343
string
getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
in
Relation at line 354
protected array
getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
in
Relation at line 366
protected Builder
getRelationQuery()
Get the query builder that will contain the relationship constraints.
in
Relation at line 384
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
in
HasOneOrManyThrough at line 129
string
getQualifiedParentKeyName()
Get the fully-qualified parent key name.
in
Relation at line 430
string
getRelatedClass()
Get the class name of the related model.
in
Relation at line 438
string
createdAt()
Get the name of the "created at" column.
in
Relation at line 446
string
updatedAt()
Get the name of the "updated at" column.
in
Relation at line 454
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
in
Relation at line 464
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.
in
Relation at line 476
protected string
whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
in
Relation at line 490
static void
requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings.
Boot-only. The flag persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.
in
Relation at line 498
static bool
requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
in
Relation at line 512
static array
enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
Boot-only. Sets both worker-wide morph state (requireMorphMap + morphMap) shared by every coroutine.
in
Relation at line 529
static array
morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
Boot-only when setting. The map persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.
in
Relation at line 548
static protected array|null
buildMorphMapFromModels(array|null $models = null)
Build a table-keyed array from model class names.
in
Relation at line 564
static string|null
getMorphedModel(int|string|null $alias)
Get the model associated with a custom polymorphic type.
in
Relation at line 578
static int|string
getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
in
Relation at line 588
static void
flushState()
Flush all static state.
in
Relation at line 611
void
__clone()
Force a clone of the underlying query builder when cloning.
in
InteractsWithDictionary at line 19
protected int|string|null
getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary.
in
HasOneOrManyThrough at line 111
protected void
performJoin(Builder|null $query = null)
Set the join clause on the query.
in
HasOneOrManyThrough at line 137
bool
throughParentSoftDeletes()
Determine whether "through" parent of the relation uses Soft Deletes.
in
HasOneOrManyThrough at line 147
HasOneOrManyThrough
withTrashedParents()
Indicate that trashed "through" parents should be included in the query.
in
HasOneOrManyThrough at line 172
protected array
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
in
HasOneOrManyThrough at line 198
Model
firstOrNew(array $attributes = [], Closure|array $values = [])
Get the first related model record matching the attributes or instantiate it.
in
HasOneOrManyThrough at line 213
Model
firstOrCreate(array $attributes = [], Closure|array $values = [])
Get the first record matching the attributes. If the record is not found, create it.
in
HasOneOrManyThrough at line 232
Model
createOrFirst(array $attributes = [], Closure|array $values = [])
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
in
HasOneOrManyThrough at line 249
Model
updateOrCreate(array $attributes, Closure|array $values = [])
Create or update a related record matching the attributes, and fill it with values.
in
HasOneOrManyThrough at line 263
Model|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.
in
HasOneOrManyThrough at line 273
Model|null
first(array $columns = ['*'])
Execute the query and get the first related model.
in
HasOneOrManyThrough at line 287
Model
firstOrFail(array $columns = ['*'])
Execute the query and get the first result or throw an exception.
in
HasOneOrManyThrough at line 305
mixed
firstOr(Closure|array $columns = ['*'], Closure|null $callback = null)
Execute the query and get the first result or call a callback.
in
HasOneOrManyThrough at line 325
Collection|Model|null
find(mixed $id, array $columns = ['*'])
Find a related model by its primary key.
in
HasOneOrManyThrough at line 346
Model
findSole(mixed $id, array $columns = ['*'])
Find a sole related model by its primary key.
in
HasOneOrManyThrough at line 361
Collection
findMany(Arrayable|array $ids, array $columns = ['*'])
Find multiple related models by their primary keys.
in
HasOneOrManyThrough at line 382
Collection|Model
findOrFail(mixed $id, array $columns = ['*'])
Find a related model by its primary key or throw an exception.
in
HasOneOrManyThrough at line 418
mixed
findOr(mixed $id, Closure|array|string $columns = ['*'], Closure|null $callback = null)
Find a related model by its primary key or call a callback.
in
HasOneOrManyThrough at line 473
mixed
paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Get a paginator for the "select" statement.
in
HasOneOrManyThrough at line 485
mixed
simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Paginate the given query into a simple paginator.
in
HasOneOrManyThrough at line 497
mixed
cursorPaginate(int|null $perPage = null, array $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)
Paginate the given query into a cursor paginator.
in
HasOneOrManyThrough at line 511
protected array
shouldSelect(array $columns = ['*'])
Set the select clause for the relation query.
in
HasOneOrManyThrough at line 523
bool
chunk(int $count, callable $callback)
Chunk the results of the query.
in
HasOneOrManyThrough at line 531
bool
chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing numeric IDs.
in
HasOneOrManyThrough at line 543
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.
in
HasOneOrManyThrough at line 555
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.
in
HasOneOrManyThrough at line 569
mixed
cursor()
Get a generator for the given query.
in
HasOneOrManyThrough at line 577
bool
each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking.
in
HasOneOrManyThrough at line 593
mixed
lazy(int $chunkSize = 1000)
Query lazily, by chunks of the given size.
in
HasOneOrManyThrough at line 603
mixed
lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs.
in
HasOneOrManyThrough at line 617
mixed
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.
in
HasOneOrManyThrough at line 631
protected Builder
prepareQueryBuilder(array $columns = ['*'])
Prepare the query builder for query execution.
in
HasOneOrManyThrough at line 670
Builder
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
in
HasOneOrManyThrough at line 697
Builder
getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, mixed $columns = ['*'])
Add the constraints for a relationship query on the same table as the through parent.
in
HasOneOrManyThrough at line 720
HasOneOrManyThrough
take(int $value)
Alias to set the "limit" value of the query.
in
HasOneOrManyThrough at line 730
HasOneOrManyThrough
limit(int $value)
Set the "limit" value of the query.
in
HasOneOrManyThrough at line 752
string
getQualifiedFarKeyName()
Get the qualified foreign key on the related model.
in
HasOneOrManyThrough at line 760
string
getFirstKeyName()
Get the foreign key on the "through" model.
in
HasOneOrManyThrough at line 768
string
getQualifiedFirstKeyName()
Get the qualified foreign key on the "through" model.
in
HasOneOrManyThrough at line 776
string
getForeignKeyName()
Get the foreign key on the related model.
in
HasOneOrManyThrough at line 784
string
getQualifiedForeignKeyName()
Get the qualified foreign key on the related model.
in
HasOneOrManyThrough at line 792
string
getLocalKeyName()
Get the local key on the far parent model.
in
HasOneOrManyThrough at line 800
string
getQualifiedLocalKeyName()
Get the qualified local key on the far parent model.
in
HasOneOrManyThrough at line 808
string
getSecondLocalKeyName()
Get the local key on the intermediary model.
at line 28
HasOneThrough
one()
Convert the relationship to a "has one through" relationship.