Relation
abstract class Relation implements Builder mixin TRelatedModel>
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. |
|
| 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 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.
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.
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 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.
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.
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 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.
at line 512
mixed
__call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
at line 105
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
at line 124
static bool
shouldAddConstraints()
Determine if constraints should be added to the relation query.
at line 132
abstract void
addConstraints()
Set the base constraints on the relation query.
at line 139
abstract void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
at line 147
abstract array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
at line 156
abstract array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
at line 163
abstract TResult
getResults()
Get the results of the relationship.
at line 170
Collection
getEager()
Get the relationship for eager loading.
at line 185
Model
sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
at line 208
Collection
get(array $columns = ['*'])
Execute the query as a "select" statement.
at line 216
void
touch()
Touch all of the related models for the relationship.
at line 230
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
at line 242
Builder
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
at line 260
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 272
string
getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
at line 283
protected array
getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
at line 295
protected Builder
getRelationQuery()
Get the query builder that will contain the relationship constraints.
at line 305
Builder
getQuery()
Get the underlying query for the relation.
at line 313
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
at line 321
Builder
toBase()
Get a base query builder instance.
at line 331
Model
getParent()
Get the parent model of the relation.
at line 339
string
getQualifiedParentKeyName()
Get the fully qualified parent key name.
at line 349
Model
getRelated()
Get the related model of the relation.
at line 357
string
createdAt()
Get the name of the "created at" column.
at line 365
string
updatedAt()
Get the name of the "updated at" column.
at line 373
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
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.
at line 395
protected string
whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
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.
at line 417
static bool
requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
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.
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.
at line 466
static protected array|null
buildMorphMapFromModels(array|null $models = null)
Builds a table-keyed array from model class names.
at line 483
static string|null
getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
at line 493
static int|string
getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
at line 501
static void
flushState()
Flush all static state.
at line 524
void
__clone()
Force a clone of the underlying query builder when cloning.