MorphTo
class MorphTo extends BelongsTo (View source)
Traits
| SupportsDefaultModels | |
| ForwardsCalls | |
| Macroable |
Properties
| static protected array | $macros | The registered string macros. | from Macroable |
| protected Builder | $query | The Eloquent query builder instance. | from Relation |
| protected Model | $parent | The parent model instance. | from Relation |
| protected Model | $related | The related model instance. | 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 database. | from Relation |
| protected Closure|array|bool | $withDefault | Indicates if a default model instance should be used. | from SupportsDefaultModels |
| protected Model | $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 |
| static protected int | $selfJoinCount | The count of self joins. | from BelongsTo |
| protected string | $morphType | The type of the polymorphic relation. | |
| protected Collection | $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. |
Methods
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object. | 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 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) Set the constraints for an eager load of the relation. | |
| array | initRelation(array $models, string $relation) Initialize the relation on a set of models. | from BelongsTo |
| array | match(array $models, Collection $results, string $relation) Match the eagerly loaded results to their parents. | |
| mixed | getResults() Get the results of the relationship. | from BelongsTo |
| Collection | getEager() Get the results of the relationship. | |
| Collection | 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 |
| Builder | getRelationExistenceCountQuery(Builder $query, Builder $parentQuery) Add the constraints for a relationship count query. | from Relation |
| Builder | getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query. | from BelongsTo |
| array | getKeys(array $models, string|null $key = null) Get all of the primary keys for an array of models. | from Relation |
| Builder | getQuery() Get the underlying query for the relation. | from Relation |
| Builder | getBaseQuery() Get the base query builder driving the Eloquent builder. | from Relation |
| Model | getParent() Get the parent model of the relation. | from Relation |
| string | getQualifiedParentKeyName() Get the fully qualified parent key name. | from Relation |
| Model | 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 |
| string | whereInMethod(Model $model, string $key) Get the name of the "where in" method for eager loading. | from Relation |
| static array | morphMap(array $map = null, bool $merge = true) Set or get the morph map for polymorphic relations. | from Relation |
| static array|null | buildMorphMapFromModels(array $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 |
| void | __clone() Force a clone of the underlying query builder when cloning. | from Relation |
| Model | newRelatedInstanceFor(Model $parent) Make a new related instance for the given model. | |
| $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 |
| Model | associate(Model|int|string $model) Associate the model instance to the given parent. | |
| Model | dissociate() Dissociate previously associated model from the given parent. | |
| Builder | getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*']) Add the constraints for a relationship query on the same table. | from BelongsTo |
| string | getRelationCountHash() Get a relationship join table hash. | from BelongsTo |
| bool | relationHasIncrementingId() Determine if the related model has an auto-incrementing ID. | from BelongsTo |
| Model | 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 |
| string | getRelationName() Get the name of the relationship. | from BelongsTo |
| void | buildDictionary(Collection $models) Build a dictionary with the models. | |
| Collection | getResultsByType(string $type) Get all of the relation results for a type. | |
| array | gatherKeysByType(string $type) Gather all of the foreign keys for a given type. | |
| Model | 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. | |
| MorphTo | morphWith(array $with) Specify which relations to load for a given morph type. | |
| MorphTo | morphWithCount(array $withCount) Specify which relationship counts to load for a given morph type. | |
| Builder | 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.
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 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)
Set the constraints for an eager load of the relation.
array initRelation(array $models, string $relation)
Initialize the relation on a set of models.
array match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
mixed getResults()
Get the results of the relationship.
Collection getEager()
Get the results of the relationship.
Called via eager load method of Eloquent query builder.
Collection 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.
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query.
protected array getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
Builder getQuery()
Get the underlying query for the relation.
Builder getBaseQuery()
Get the base query builder driving the Eloquent builder.
Model getParent()
Get the parent model of the relation.
string getQualifiedParentKeyName()
Get the fully qualified parent key name.
Model 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 string whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
static array morphMap(array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array $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.
void __clone()
Force a clone of the underlying query builder when cloning.
protected Model newRelatedInstanceFor(Model $parent)
Make a new related instance for the given model.
$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.
Model dissociate()
Dissociate previously associated model from the given parent.
Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
string getRelationCountHash()
Get a relationship join table hash.
protected bool relationHasIncrementingId()
Determine if the related model has an auto-incrementing ID.
Model 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.
string getRelationName()
Get the name of the relationship.
protected void buildDictionary(Collection $models)
Build a dictionary with the models.
protected Collection getResultsByType(string $type)
Get all of the relation results for a type.
protected array gatherKeysByType(string $type)
Gather all of the foreign keys for a given type.
Model 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.
MorphTo morphWith(array $with)
Specify which relations to load for a given morph type.
MorphTo morphWithCount(array $withCount)
Specify which relationship counts to load for a given morph type.
protected Builder 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/7.x/Illuminate/Database/Eloquent/Relations/MorphTo.html