MorphTo
class MorphTo extends BelongsTo
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 Closure|array|bool | $withDefault | Indicates if a default model instance should be used. |
from SupportsDefaultModels |
| protected TDeclaringModel | $child | The child model instance of the relation. |
from BelongsTo |
| protected string | $foreignKey | The foreign key of the parent model. |
from BelongsTo |
| protected string|null | $ownerKey | The associated key on the parent model. |
|
| protected string | $relationName | The name of the relationship. |
from BelongsTo |
| protected string | $morphType | The type of the polymorphic relation. |
|
| protected TDeclaringModel> | $models | The models whose relations are being eager loaded. |
|
| protected array | $dictionary | All of the models keyed by ID. |
|
| protected array | $macroBuffer | A buffer of dynamic calls to query macros. |
|
| protected array | $morphableEagerLoads | A map of relations to load for each individual morph type. |
|
| protected array | $morphableEagerLoadCounts | A map of relationship counts to load for each individual morph type. |
|
| protected array | $morphableConstraints | A map of constraints to apply for each individual morph type. |
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.
Create a new morph to relationship instance.
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.
Touch all of the related models for the relationship.
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.
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.
Compare the parent key with the related key.
Get a dictionary key attribute - casting it to a string if necessary.
Return a new model instance in case the relationship does not exist.
Gather the keys from an array of related models.
Dissociate previously associated model from the given parent.
Add the constraints for a relationship query on the same table.
Determine if the related model has an auto-incrementing ID.
Get the fully qualified foreign key of the relationship.
Get the fully qualified associated key of the relationship.
Get all of the relation results for a type.
Gather all of the foreign keys for a given type.
Create a new model instance by type.
Match the results for a given type to their parents.
Get the foreign key "type" name.
Get the dictionary used by the relationship.
Specify which relationship counts to load for a given morph type.
Indicate that soft deleted models should be included in the results.
Indicate that soft deleted models should not be included in the results.
Indicate that only soft deleted models should be included in the results.
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 408
mixed
__call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
at line 73
__construct(Builder $query, Model $parent, string $foreignKey, string|null $ownerKey, string $type, string $relation)
Create a new morph to 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.
in
BelongsTo at line 82
void
addConstraints()
Set the base constraints on the relation query.
at line 80
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
in
BelongsTo at line 129
array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
at line 187
array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
in
BelongsTo at line 70
TResult
getResults()
Get the results of the relationship.
at line 117
Collection
getEager()
Get the results of the relationship.
Called via eager load method of Eloquent query builder.
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.
at line 254
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.
in
BelongsTo at line 218
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.
in
Relation at line 339
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
ComparesRelatedModels at line 15
bool
is(Model|null $model)
Determine if the model is the related instance of the relationship.
in
ComparesRelatedModels at line 34
bool
isNot(Model|null $model)
Determine if the model is not the related instance of the relationship.
in
ComparesRelatedModels at line 42
abstract mixed
getParentKey()
Get the value of the parent model's key.
in
ComparesRelatedModels at line 47
abstract protected mixed
getRelatedKeyFrom(Model $model)
Get the value of the model's related key.
in
ComparesRelatedModels at line 52
protected bool
compareKeys(mixed $parentKey, mixed $relatedKey)
Compare the parent key with the related key.
in
InteractsWithDictionary at line 19
protected mixed
getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary.
at line 262
protected Model
newRelatedInstanceFor(Model $parent)
Make a new related instance for the given model.
in
SupportsDefaultModels at line 29
SupportsDefaultModels
withDefault(Closure|array|bool $callback = true)
Return a new model instance in case the relationship does not exist.
in
SupportsDefaultModels at line 39
protected Model|null
getDefaultFor(Model $parent)
Get the default value for this relation.
in
BelongsTo at line 111
protected array
getEagerModelKeys(array $models)
Gather the keys from an array of related models.
at line 217
Model
associate(Model|int|string|null $model)
Associate the model instance to the given parent.
at line 244
Model
dissociate()
Dissociate previously associated model from the given parent.
in
BelongsTo at line 238
Builder
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
in
BelongsTo at line 256
protected bool
relationHasIncrementingId()
Determine if the related model has an auto-incrementing ID.
in
BelongsTo at line 286
string
getForeignKeyName()
Get the foreign key of the relationship.
in
BelongsTo at line 294
string
getQualifiedForeignKeyName()
Get the fully qualified foreign key of the relationship.
in
BelongsTo at line 310
string|null
getOwnerKeyName()
Get the associated key of the relationship.
at line 395
string
getQualifiedOwnerKeyName()
Get the fully qualified associated key of the relationship.
in
BelongsTo at line 338
protected mixed
getForeignKeyFrom(Model $model)
Get the value of the model's foreign key.
in
BelongsTo at line 348
string
getRelationName()
Get the name of the relationship.
at line 92
protected void
buildDictionary(Collection $models)
Build a dictionary with the models.
at line 131
protected Collection
getResultsByType(string $type)
Get all of the relation results for a type.
at line 162
protected array
gatherKeysByType(string $type, string $keyType)
Gather all of the foreign keys for a given type.
at line 176
Model
createModelByType(string $type)
Create a new model instance by type.
at line 198
protected void
matchToMorphParents(string $type, Collection $results)
Match the results for a given type to their parents.
at line 271
string
getMorphType()
Get the foreign key "type" name.
at line 279
array
getDictionary()
Get the dictionary used by the relationship.
at line 289
MorphTo
morphWith(array $with)
Specify which relations to load for a given morph type.
at line 304
MorphTo
morphWithCount(array $withCount)
Specify which relationship counts to load for a given morph type.
at line 319
MorphTo
constrain(array $callbacks)
Specify constraints on the query for a given morph type.
at line 334
MorphTo
withTrashed()
Indicate that soft deleted models should be included in the results.
at line 351
MorphTo
withoutTrashed()
Indicate that soft deleted models should not be included in the results.
at line 368
MorphTo
onlyTrashed()
Indicate that only soft deleted models should be included in the results.