Relation
abstract class Relation implements Builder mixin TRelatedModel>
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. |
|
| protected TDeclaringModel | $parent | The parent model instance. |
|
| protected TRelatedModel | $related | The related model instance. |
|
| protected bool | $eagerKeysWereEmpty | Indicates whether the eagerly loaded relation should implicitly return an empty collection. |
|
| static array<int|Model>> | $morphMap | An array to map morph names to their class names in the database. |
|
| static protected bool | $requireMorphMap | Prevents morph relationships without a morph map. |
|
| static protected int | $selfJoinCount | The count of self joins. |
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.
Handle dynamic method calls to the relationship.
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 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 and get the first result if it's the sole matching record.
Execute the query as a "select" statement.
Touch all of the related models for the relationship.
Update related keys, splitting unbounded queries at the statement binding limit.
Run a raw update against the base query.
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 base query builder driving the Eloquent builder.
Get the fully-qualified parent key name.
Get the related model of the relation.
Get the class name of the related model.
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.
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.
Flush all static state.
Force a clone of the underlying query builder when cloning.
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 30
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 44
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 61
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 72
static void
flushMacros()
Flush the existing macros.
Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 83
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
at line 650
mixed
__call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
at line 112
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
at line 125
static mixed
noConstraintsForRelation(Closure $callback)
Run a callback without constraints while preserving them for nested relation attributes.
at line 138
static protected mixed
withoutConstraints(Closure $callback, bool $constraintsForNestedRelations)
Run a callback with the configured relation constraints.
at line 165
static mixed
withConstraints(Closure $callback)
Run a callback with constraints enabled on the relation.
at line 186
static mixed
withConstraintsForNestedRelation(Closure $callback)
Run a callback with constraints when resolving a nested relation attribute.
at line 196
static bool
shouldAddConstraints()
Determine if constraints should be added to the relation query.
at line 204
abstract void
addConstraints()
Set the base constraints on the relation query.
at line 211
abstract void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
at line 219
abstract array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
at line 228
abstract array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
at line 235
abstract TResult
getResults()
Get the results of the relationship.
at line 242
Collection
getEager()
Get the relationship for eager loading.
at line 257
Model
sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
at line 279
Collection
get(array $columns = ['*'])
Execute the query as a "select" statement.
at line 287
void
touch()
Touch all of the related models for the relationship.
at line 305
protected void
updateRelatedKeys(Builder $query, string $column, Collection $keys, array $values)
Update related keys, splitting unbounded queries at the statement binding limit.
at line 329
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
at line 341
Builder
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
at line 359
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.
at line 371
string
getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
at line 382
protected array
getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
at line 394
protected Builder
getRelationQuery()
Get the query builder that will contain the relationship constraints.
at line 404
Builder
getQuery()
Get the underlying query for the relation.
at line 412
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
at line 420
Builder
toBase()
Get a base query builder instance.
at line 430
Model
getParent()
Get the parent model of the relation.
at line 438
string
getQualifiedParentKeyName()
Get the fully-qualified parent key name.
at line 448
Model
getRelated()
Get the related model of the relation.
at line 456
Relation
withCasts(array $casts)
Apply query-time casts to the related model instance.
at line 471
string
getRelatedClass()
Get the class name of the related model.
at line 479
string
createdAt()
Get the name of the "created at" column.
at line 487
string
updatedAt()
Get the name of the "updated at" column.
at line 495
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
at line 505
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.
at line 517
protected string
whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
at line 531
static void
requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings.
The flag persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.
at line 540
static bool
requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
at line 554
static array
enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
Sets both worker-wide morph state (requireMorphMap + morphMap) shared by every coroutine.
at line 571
static array
morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
A given map persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.
at line 591
static protected array|null
buildMorphMapFromModels(array|null $models = null)
Build a table-keyed array from model class names.
at line 607
static string|null
getMorphedModel(int|string|null $alias)
Get the model associated with a custom polymorphic type.
at line 621
static int|string
getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
at line 631
Relation
clone()
Clone the relationship.
at line 639
static void
flushState()
Flush all static state.
at line 662
void
__clone()
Force a clone of the underlying query builder when cloning.