HasOneOrMany
abstract class HasOneOrMany extends Relation
Traits
Constants
| protected CONSTRAINTS_CONTEXT_KEY |
The context key for storing whether constraints are enabled. |
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 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. |
|
| protected string | $localKey | The local key of the parent model. |
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.
Determine if constraints should be added to the relation query.
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.
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.
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.
Builds 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 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.
Alias to set the "limit" value of the query.
Set the "limit" value of the query.
Get the key for comparing against the parent key in "has" query.
Get the key value of the parent's local key.
Get the plain foreign key.
Get the foreign key for the relationship.
Get the local key for the 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.
at line 44
__construct(Builder $query, Model $parent, string $foreignKey, string $localKey)
Create a new has one or many relationship instance.
in
Relation at line 105
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
in
Relation at line 124
static bool
shouldAddConstraints()
Determine if constraints should be added to the relation query.
at line 84
void
addConstraints()
Set the base constraints on the relation query.
at line 95
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
in
Relation at line 147
abstract array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
in
Relation at line 156
abstract array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
in
Relation at line 163
abstract TResult
getResults()
Get the results of the relationship.
in
Relation at line 170
Collection
getEager()
Get the relationship for eager loading.
in
Relation at line 185
Model
sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
in
Relation at line 208
Collection
get(array $columns = ['*'])
Execute the query as a "select" statement.
in
Relation at line 216
void
touch()
Touch all of the related models for the relationship.
in
Relation at line 230
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
in
Relation at line 242
Builder
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
at line 466
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 272
string
getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
in
Relation at line 283
protected array
getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
in
Relation at line 295
protected Builder
getRelationQuery()
Get the query builder that will contain the relationship constraints.
in
Relation at line 313
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
at line 540
string
getQualifiedParentKeyName()
Get the fully qualified parent key name.
in
Relation at line 357
string
createdAt()
Get the name of the "created at" column.
in
Relation at line 365
string
updatedAt()
Get the name of the "updated at" column.
in
Relation at line 373
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
in
Relation at line 383
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 395
protected string
whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
in
Relation at line 409
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 417
static bool
requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
in
Relation at line 430
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 447
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 466
static protected array|null
buildMorphMapFromModels(array|null $models = null)
Builds a table-keyed array from model class names.
in
Relation at line 483
static string|null
getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
in
Relation at line 493
static int|string
getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
in
Relation at line 501
static void
flushState()
Flush all static state.
in
Relation at line 524
void
__clone()
Force a clone of the underlying query builder when cloning.
in
InteractsWithDictionary at line 19
protected mixed
getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary.
in
SupportsInverseRelations at line 26
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 36
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 60
protected string|null
guessInverseRelation()
Guess the name of the inverse relationship.
in
SupportsInverseRelations at line 73
protected array
getPossibleInverseRelations()
Get the possible inverse relations for the parent model.
in
SupportsInverseRelations at line 91
protected mixed
applyInverseRelationToCollection(mixed $models, Model|null $parent = null)
Set the inverse relation on all models in a collection.
in
SupportsInverseRelations at line 106
protected Model
applyInverseRelationToModel(Model $model, Model|null $parent = null)
Set the inverse relation on a model.
in
SupportsInverseRelations at line 120
string|null
getInverseRelationship()
Get the name of the inverse relationship.
in
SupportsInverseRelations at line 132
SupportsInverseRelations
withoutInverse()
Remove the chaperone / inverse relationship for this query.
Alias of "withoutChaperone".
in
SupportsInverseRelations at line 142
SupportsInverseRelations
withoutChaperone()
Remove the chaperone / inverse relationship for this query.
at line 57
Model
make(array $attributes = [])
Create and return an un-saved instance of the related model.
at line 70
Collection
makeMany(iterable $records)
Create and return an un-saved instance of the related models.
at line 114
array
matchOne(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their single parents.
at line 126
array
matchMany(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their many parents.
at line 138
protected array
matchOneOrMany(array $models, Collection $results, string $relation, string $type)
Match the eagerly loaded results to their many parents.
at line 166
protected mixed
getRelationValue(array $dictionary, int|string $key, string $type)
Get the value of a relationship by one or many type.
at line 179
protected array
buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
at line 205
Collection|Model
findOrNew(mixed $id, array $columns = ['*'])
Find a model by its primary key or return a new instance of the related model.
at line 221
Model
firstOrNew(array $attributes = [], Closure|array $values = [])
Get the first related model record matching the attributes or instantiate it.
at line 237
Model
firstOrCreate(array $attributes = [], Closure|array $values = [])
Get the first record matching the attributes. If the record is not found, create it.
at line 251
Model
createOrFirst(array $attributes = [], Closure|array $values = [])
Attempt to create the record. If a unique constraint violation occurs, attempt to find the matching record.
at line 267
Model
updateOrCreate(array $attributes, Closure|array $values = [])
Create or update a related record matching the attributes, and fill it with values.
at line 279
int
upsert(array $values, array|string $uniqueBy, array|null $update = null)
Insert new records or update the existing ones.
at line 311
Model|false
saveQuietly(Model $model)
Attach a model instance without raising any events to the parent model.
at line 324
iterable
saveMany(iterable $models)
Attach a collection of models to the parent instance.
at line 339
iterable
saveManyQuietly(iterable $models)
Attach a collection of models to the parent instance without raising any events to the parent model.
at line 351
Model
create(array $attributes = [])
Create a new instance of the related model.
at line 367
Model
createQuietly(array $attributes = [])
Create a new instance of the related model without raising any events to the parent model.
at line 377
Model
forceCreate(array $attributes = [])
Create a new instance of the related model. Allow mass-assignment.
at line 389
Model
forceCreateQuietly(array $attributes = [])
Create a new instance of the related model with mass assignment without raising model events.
at line 399
Collection
createMany(iterable $records)
Create a Collection of new instances of the related model.
at line 415
Collection
createManyQuietly(iterable $records)
Create a Collection of new instances of the related model without raising any events to the parent model.
at line 425
Collection
forceCreateMany(iterable $records)
Create a Collection of new instances of the related model, allowing mass-assignment.
at line 441
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.
at line 451
protected void
setForeignAttributesForCreate(Model $model)
Set the foreign ID for creating a related model.
at line 482
Builder
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
at line 500
HasOneOrMany
take(int $value)
Alias to set the "limit" value of the query.
at line 510
HasOneOrMany
limit(int $value)
Set the "limit" value of the query.
at line 524
string
getExistenceCompareKey()
Get the key for comparing against the parent key in "has" query.
at line 532
mixed
getParentKey()
Get the key value of the parent's local key.
at line 548
string
getForeignKeyName()
Get the plain foreign key.
at line 558
string
getQualifiedForeignKeyName()
Get the foreign key for the relationship.
at line 566
string
getLocalKeyName()
Get the local key for the relationship.