MorphTo
class MorphTo extends BelongsTo (View source)
Traits
| InteractsWithDictionary | |
| ComparesRelatedModels | |
| InteractsWithDictionary | |
| SupportsDefaultModels | |
| ForwardsCalls | |
| Macroable |
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 protected bool | $constraints | Indicates if the relation is adding constraints. | from Relation |
| static array | $morphMap | An array to map class names to their morph 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 | $ownerKey | The associated key on the parent model. | from BelongsTo |
| 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
| mixed | forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object. | from ForwardsCalls |
| mixed | forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object, returning $this if the forwarded call returned itself. | from ForwardsCalls |
| static void | throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method. | from ForwardsCalls |
| static void | macro(string $name, object|callable $macro)
Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name)
Checks if macro is registered. | from Macroable |
| static void | flushMacros()
Flush the existing macros. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| mixed | __call(string $method, array $parameters)
Handle dynamic method calls to the relationship. | |
| void | __construct(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)
Create a new morph to relationship instance. | |
| static mixed | noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation. | from Relation |
| void | addConstraints()
Set the base constraints on the relation query. | from BelongsTo |
| void | addEagerConstraints(array $models) No description | |
| TDeclaringModel> | initRelation(array $models, string $relation) No description | from BelongsTo |
| TDeclaringModel> | match(array $models, Collection $results, string $relation) No description | |
| TResult | getResults() No description | from BelongsTo |
| TRelatedModel> | getEager()
Get the results of the relationship. | |
| TRelatedModel | sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record. | from Relation |
| TRelatedModel> | get(array $columns = ['*'])
Execute the query as a "select" statement. | from Relation |
| void | touch()
Touch all of the related models for the relationship. | |
| int | rawUpdate(array $attributes = [])
Run a raw update against the base query. | from Relation |
| TRelatedModel> | getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query. | from Relation |
| TRelatedModel> | getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) No description | from BelongsTo |
| string | getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash. | from Relation |
| array<int,int|string> | getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models. | from Relation |
| TRelatedModel> | getRelationQuery()
Get the query builder that will contain the relationship constraints. | from Relation |
| TRelatedModel> | getQuery()
Get the underlying query for the relation. | from Relation |
| Builder | getBaseQuery()
Get the base query builder driving the Eloquent builder. | from Relation |
| Builder | toBase()
Get a base query builder instance. | from Relation |
| TDeclaringModel | getParent()
Get the parent model of the relation. | from Relation |
| string | getQualifiedParentKeyName()
Get the fully qualified parent key name. | from Relation |
| TRelatedModel | getRelated()
Get the related model of the relation. | from Relation |
| string | createdAt()
Get the name of the "created at" column. | from Relation |
| string | updatedAt()
Get the name of the "updated at" column. | from Relation |
| string | relatedUpdatedAt()
Get the name of the related model's "updated at" column. | from Relation |
| 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. | from Relation |
| string | whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading. | from Relation |
| static void | requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings. | from Relation |
| static bool | requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping. | from Relation |
| static array | enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped. | from Relation |
| static array | morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations. | from Relation |
| static array|null | buildMorphMapFromModels(array|null $models = null)
Builds a table-keyed array from model class names. | from Relation |
| static string|null | getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type. | from Relation |
| static int|string | getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class. | from Relation |
| void | __clone()
Force a clone of the underlying query builder when cloning. | from Relation |
| bool | is(Model|null $model)
Determine if the model is the related instance of the relationship. | from ComparesRelatedModels |
| bool | isNot(Model|null $model)
Determine if the model is not the related instance of the relationship. | from ComparesRelatedModels |
| mixed | getParentKey()
Get the value of the parent model's key. | from ComparesRelatedModels |
| mixed | getRelatedKeyFrom(Model $model)
Get the value of the model's related key. | from ComparesRelatedModels |
| bool | compareKeys(mixed $parentKey, mixed $relatedKey)
Compare the parent key with the related key. | from ComparesRelatedModels |
| mixed | getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary. | from InteractsWithDictionary |
| TRelatedModel | newRelatedInstanceFor(Model $parent) No description | |
| $this | withDefault(Closure|array|bool $callback = true)
Return a new model instance in case the relationship does not exist. | from SupportsDefaultModels |
| Model|null | getDefaultFor(Model $parent)
Get the default value for this relation. | from SupportsDefaultModels |
| array | getEagerModelKeys(array $models)
Gather the keys from an array of related models. | from BelongsTo |
| TDeclaringModel | associate(TRelatedModel|int|string|null $model)
Associate the model instance to the given parent. | |
| TDeclaringModel | dissociate()
Dissociate previously associated model from the given parent. | |
| TDeclaringModel | disassociate()
Alias of "dissociate" method. | from BelongsTo |
| TRelatedModel> | getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table. | from BelongsTo |
| bool | relationHasIncrementingId()
Determine if the related model has an auto-incrementing ID. | from BelongsTo |
| TDeclaringModel | getChild()
Get the child of the relationship. | from BelongsTo |
| string | getForeignKeyName()
Get the foreign key of the relationship. | from BelongsTo |
| string | getQualifiedForeignKeyName()
Get the fully qualified foreign key of the relationship. | from BelongsTo |
| string | getOwnerKeyName()
Get the associated key of the relationship. | from BelongsTo |
| string | getQualifiedOwnerKeyName()
Get the fully qualified associated key of the relationship. | from BelongsTo |
| mixed | getForeignKeyFrom(Model $model)
Get the value of the model's foreign key. | from BelongsTo |
| string | getRelationName()
Get the name of the relationship. | from BelongsTo |
| void | buildDictionary(Collection $models)
Build a dictionary with the models. | |
| TRelatedModel> | getResultsByType(string $type)
Get all of the relation results for a type. | |
| array | gatherKeysByType(string $type, string $keyType)
Gather all of the foreign keys for a given type. | |
| TRelatedModel | createModelByType(string $type)
Create a new model instance by type. | |
| void | matchToMorphParents(string $type, Collection $results)
Match the results for a given type to their parents. | |
| string | getMorphType()
Get the foreign key "type" name. | |
| array | getDictionary()
Get the dictionary used by the relationship. | |
| $this | morphWith(array $with)
Specify which relations to load for a given morph type. | |
| $this | morphWithCount(array $withCount)
Specify which relationship counts to load for a given morph type. | |
| $this | constrain(array $callbacks)
Specify constraints on the query for a given morph type. | |
| $this | withTrashed()
Indicate that soft deleted models should be included in the results. | |
| $this | withoutTrashed()
Indicate that soft deleted models should not be included in the results. | |
| $this | onlyTrashed()
Indicate that only soft deleted models should be included in the results. | |
| TRelatedModel> | replayMacros(Builder $query)
Replay stored macro calls on the actual related instance. |
Details
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
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.
static protected void throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
static void flushMacros()
Flush the existing macros.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
void __construct(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)
Create a new morph to relationship instance.
static mixed noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
void addConstraints()
Set the base constraints on the relation query.
void addEagerConstraints(array $models)
No description
TDeclaringModel> initRelation(array $models, string $relation)
No description
TDeclaringModel> match(array $models, Collection $results, string $relation)
No description
TResult getResults()
No description
TRelatedModel> getEager()
Get the results of the relationship.
Called via eager load method of Eloquent query builder.
TRelatedModel sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
TRelatedModel> get(array $columns = ['*'])
Execute the query as a "select" statement.
void touch()
Touch all of the related models for the relationship.
int rawUpdate(array $attributes = [])
Run a raw update against the base query.
TRelatedModel> getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
TRelatedModel> getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
No description
string getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
protected array<int,int|string> getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
protected TRelatedModel> getRelationQuery()
Get the query builder that will contain the relationship constraints.
TRelatedModel> getQuery()
Get the underlying query for the relation.
Builder getBaseQuery()
Get the base query builder driving the Eloquent builder.
Builder toBase()
Get a base query builder instance.
TDeclaringModel getParent()
Get the parent model of the relation.
string getQualifiedParentKeyName()
Get the fully qualified parent key name.
TRelatedModel getRelated()
Get the related model of the relation.
string createdAt()
Get the name of the "created at" column.
string updatedAt()
Get the name of the "updated at" column.
string relatedUpdatedAt()
Get the name of the related model's "updated at" column.
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.
protected string whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
static void requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings.
static bool requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
static array enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
static array morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array|null $models = null)
Builds a table-keyed array from model class names.
static string|null getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
static int|string getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
void __clone()
Force a clone of the underlying query builder when cloning.
bool is(Model|null $model)
Determine if the model is the related instance of the relationship.
bool isNot(Model|null $model)
Determine if the model is not the related instance of the relationship.
abstract mixed getParentKey()
Get the value of the parent model's key.
abstract protected mixed getRelatedKeyFrom(Model $model)
Get the value of the model's related key.
protected bool compareKeys(mixed $parentKey, mixed $relatedKey)
Compare the parent key with the related key.
protected mixed getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary.
protected TRelatedModel newRelatedInstanceFor(Model $parent)
No description
$this withDefault(Closure|array|bool $callback = true)
Return a new model instance in case the relationship does not exist.
protected array getEagerModelKeys(array $models)
Gather the keys from an array of related models.
TDeclaringModel associate(TRelatedModel|int|string|null $model)
Associate the model instance to the given parent.
TDeclaringModel dissociate()
Dissociate previously associated model from the given parent.
TDeclaringModel disassociate()
Alias of "dissociate" method.
TRelatedModel> getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
protected bool relationHasIncrementingId()
Determine if the related model has an auto-incrementing ID.
TDeclaringModel getChild()
Get the child of the relationship.
string getForeignKeyName()
Get the foreign key of the relationship.
string getQualifiedForeignKeyName()
Get the fully qualified foreign key of the relationship.
string getOwnerKeyName()
Get the associated key of the relationship.
string getQualifiedOwnerKeyName()
Get the fully qualified associated key of the relationship.
protected mixed getForeignKeyFrom(Model $model)
Get the value of the model's foreign key.
string getRelationName()
Get the name of the relationship.
protected void buildDictionary(Collection $models)
Build a dictionary with the models.
protected TRelatedModel> getResultsByType(string $type)
Get all of the relation results for a type.
protected array gatherKeysByType(string $type, string $keyType)
Gather all of the foreign keys for a given type.
TRelatedModel createModelByType(string $type)
Create a new model instance by type.
protected void matchToMorphParents(string $type, Collection $results)
Match the results for a given type to their parents.
string getMorphType()
Get the foreign key "type" name.
array getDictionary()
Get the dictionary used by the relationship.
$this morphWith(array $with)
Specify which relations to load for a given morph type.
$this morphWithCount(array $withCount)
Specify which relationship counts to load for a given morph type.
$this constrain(array $callbacks)
Specify constraints on the query for a given morph type.
$this withTrashed()
Indicate that soft deleted models should be included in the results.
$this withoutTrashed()
Indicate that soft deleted models should not be included in the results.
$this onlyTrashed()
Indicate that only soft deleted models should be included in the results.
protected TRelatedModel> replayMacros(Builder $query)
Replay stored macro calls on the actual related instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Eloquent/Relations/MorphTo.html
