HasMany
class HasMany extends HasOneOrMany
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 string|null | $inverseRelationship | The name of the inverse relationship. |
from SupportsInverseRelations |
| protected string | $foreignKey | The foreign key of the parent model. |
from HasOneOrMany |
| protected string | $localKey | The local key of the parent model. |
from HasOneOrMany |
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 one or many 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.
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.
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.
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
Guess the name of the inverse relationship.
Get the possible inverse relations for the parent model.
Set the inverse relation on all models in a collection.
Set the inverse relation on a model.
Get the name of the inverse relationship.
Remove the chaperone / inverse relationship for this query.
Remove the chaperone / inverse relationship for this query.
Create and return an un-saved instance of the related model.
Create and return an un-saved instance of the related models.
Match the eagerly loaded results to their single parents.
Match the eagerly loaded results to their many parents.
Match the eagerly loaded results to their many parents.
Get the value of a relationship by one or many type.
Find a model by its primary key or return a new instance of the related model.
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.
Insert new records or update the existing ones.
Attach a collection of models to the parent instance.
Attach a collection of models to the parent instance without raising any events to the parent model.
Create a new instance of the related model without raising any events to the parent model.
Create a new instance of the related model. Allow mass-assignment.
Create a new instance of the related model with mass assignment without raising model events.
Create a Collection of new instances of the related model.
Create a Collection of new instances of the related model without raising any events to the parent model.
Create a Collection of new instances of the related model, allowing mass-assignment.
Create a Collection of new instances of the related model, allowing mass-assignment and without raising any events to the parent model.
Add the constraints for a relationship query on the same table.
Get the key for comparing against the parent key in "has" query.
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
HasOneOrMany at line 45
__construct(Builder $query, Model $parent, string $foreignKey, string $localKey)
Create a new has one or many 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
HasOneOrMany at line 85
void
addConstraints()
Set the base constraints on the relation query.
in
HasOneOrMany at line 96
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
at line 47
array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
at line 56
array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
at line 40
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
Relation at line 277
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
HasOneOrMany at line 483
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
HasOneOrMany at line 558
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
SupportsInverseRelations at line 27
SupportsInverseRelations
inverse(string|null $relation = null)
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
Alias of "chaperone".
in
SupportsInverseRelations at line 37
SupportsInverseRelations
chaperone(string|null $relation = null)
Instruct Eloquent to link the related models back to the parent after the relationship query has run.
in
SupportsInverseRelations at line 61
protected string|null
guessInverseRelation()
Guess the name of the inverse relationship.
in
SupportsInverseRelations at line 74
protected array
getPossibleInverseRelations()
Get the possible inverse relations for the parent model.
in
SupportsInverseRelations at line 92
protected mixed
applyInverseRelationToCollection(mixed $models, Model|null $parent = null)
Set the inverse relation on all models in a collection.
in
SupportsInverseRelations at line 107
protected Model
applyInverseRelationToModel(Model $model, Model|null $parent = null)
Set the inverse relation on a model.
in
SupportsInverseRelations at line 121
string|null
getInverseRelationship()
Get the name of the inverse relationship.
in
SupportsInverseRelations at line 133
SupportsInverseRelations
withoutInverse()
Remove the chaperone / inverse relationship for this query.
Alias of "withoutChaperone".
in
SupportsInverseRelations at line 143
SupportsInverseRelations
withoutChaperone()
Remove the chaperone / inverse relationship for this query.
in
HasOneOrMany at line 58
Model
make(array $attributes = [])
Create and return an un-saved instance of the related model.
in
HasOneOrMany at line 71
Collection
makeMany(iterable $records)
Create and return an un-saved instance of the related models.
in
HasOneOrMany at line 115
array
matchOne(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their single parents.
in
HasOneOrMany at line 127
array
matchMany(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their many parents.
in
HasOneOrMany at line 139
protected array
matchOneOrMany(array $models, Collection $results, string $relation, string $type)
Match the eagerly loaded results to their many parents.
in
HasOneOrMany at line 167
protected mixed
getRelationValue(array $dictionary, int|string $key, string $type)
Get the value of a relationship by one or many type.
in
HasOneOrMany at line 180
protected array
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
in
HasOneOrMany at line 210
Collection|Model
findOrNew(mixed $id, array $columns = ['*'])
Find a model by its primary key or return a new instance of the related model.
in
HasOneOrMany at line 227
Model
firstOrNew(array $attributes = [], Closure|array $values = [])
Get the first related model record matching the attributes or instantiate it.
in
HasOneOrMany at line 244
Model
firstOrCreate(array $attributes = [], Closure|array $values = [])
Get the first record matching the attributes. If the record is not found, create it.
in
HasOneOrMany at line 263
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
HasOneOrMany at line 280
Model
updateOrCreate(array $attributes, Closure|array $values = [])
Create or update a related record matching the attributes, and fill it with values.
in
HasOneOrMany at line 292
int
upsert(array $values, array|string $uniqueBy, array|null $update = null)
Insert new records or update the existing ones.
in
HasOneOrMany at line 311
Model|false
save(Model $model)
Attach a model instance to the parent model.
in
HasOneOrMany at line 324
Model|false
saveQuietly(Model $model)
Attach a model instance without raising any events to the parent model.
in
HasOneOrMany at line 339
iterable
saveMany(iterable $models)
Attach a collection of models to the parent instance.
in
HasOneOrMany at line 356
iterable
saveManyQuietly(iterable $models)
Attach a collection of models to the parent instance without raising any events to the parent model.
in
HasOneOrMany at line 368
Model
create(array $attributes = [])
Create a new instance of the related model.
in
HasOneOrMany at line 384
Model
createQuietly(array $attributes = [])
Create a new instance of the related model without raising any events to the parent model.
in
HasOneOrMany at line 394
Model
forceCreate(array $attributes = [])
Create a new instance of the related model. Allow mass-assignment.
in
HasOneOrMany at line 406
Model
forceCreateQuietly(array $attributes = [])
Create a new instance of the related model with mass assignment without raising model events.
in
HasOneOrMany at line 416
Collection
createMany(iterable $records)
Create a Collection of new instances of the related model.
in
HasOneOrMany at line 432
Collection
createManyQuietly(iterable $records)
Create a Collection of new instances of the related model without raising any events to the parent model.
in
HasOneOrMany at line 442
Collection
forceCreateMany(iterable $records)
Create a Collection of new instances of the related model, allowing mass-assignment.
in
HasOneOrMany at line 458
Collection
forceCreateManyQuietly(iterable $records)
Create a Collection of new instances of the related model, allowing mass-assignment and without raising any events to the parent model.
in
HasOneOrMany at line 468
protected void
setForeignAttributesForCreate(Model $model)
Set the foreign ID for creating a related model.
in
HasOneOrMany at line 499
Builder
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
in
HasOneOrMany at line 518
HasOneOrMany
take(int $value)
Alias to set the "limit" value of the query.
in
HasOneOrMany at line 528
HasOneOrMany
limit(int $value)
Set the "limit" value of the query.
in
HasOneOrMany at line 542
string
getExistenceCompareKey()
Get the key for comparing against the parent key in "has" query.
in
HasOneOrMany at line 550
mixed
getParentKey()
Get the key value of the parent's local key.
in
HasOneOrMany at line 566
string
getForeignKeyName()
Get the plain foreign key.
in
HasOneOrMany at line 576
string
getQualifiedForeignKeyName()
Get the foreign key for the relationship.
in
HasOneOrMany at line 584
string
getLocalKeyName()
Get the local key for the relationship.
at line 23
HasOne
one()
Convert the relationship to a "has one" relationship.