MorphTo (Database\Eloquent\Relations)
MorphTo
class MorphTo extends BelongsTo (View source)
Methods
void | __construct( Builder $query, Model $parent, string $foreignKey, string $otherKey, string $type, string $relation) Create a new morph to relationship instance. | |
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. | |
Collection | getEager() Get the results of the relationship. | |
void | touch() Touch all of the related models for the relationship. | from Relation |
int | rawUpdate( array $attributes = array()) Run a raw update against the base query. | from Relation |
Builder | getRelationCountQuery( Builder $query, Builder $parent) Add the constraints for a relationship count query. | from BelongsTo |
static mixed | noConstraints( Closure $callback) Run a callback with constraints disabled on the relation. | 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 | wrap( string $value) Wrap the given value with the parent query's grammar. | from Relation |
static array | morphMap( array $map = null, bool $merge = true) Set or get the morph map for polymorphic relations. | from Relation |
mixed | __call( string $method, array $parameters) Handle dynamic method calls to the relationship. | from Relation |
void | __clone() Force a clone of the underlying query builder when cloning. | from Relation |
Builder | getRelationCountQueryForSelfRelation( Builder $query, Builder $parent) Add the constraints for a relationship count query on the same table. | from BelongsTo |
string | getRelationCountHash() Get a relationship join table hash. | from BelongsTo |
Model | associate( Model|int $model) Associate the model instance to the given parent. | |
Model | dissociate() Dissociate previously associated model from the given parent. | |
mixed | update( array $attributes) Update the parent model on the relationship. | from BelongsTo |
string | getForeignKey() Get the foreign key of the relationship. | from BelongsTo |
string | getQualifiedForeignKey() Get the fully qualified foreign key of the relationship. | from BelongsTo |
string | getOtherKey() Get the associated key of the relationship. | from BelongsTo |
string | getQualifiedOtherKeyName() Get the fully qualified associated key of the relationship. | from BelongsTo |
Model | createModelByType( string $type) Create a new model instance by type. | |
string | getMorphType() Get the foreign key "type" name. | |
array | getDictionary() Get the dictionary used by the relationship. | |
$this | withTrashed() Fetch soft-deleted model instances with query. |
Details
void __construct( Builder $query, Model $parent, string $foreignKey, string $otherKey, string $type, string $relation)
Create a new morph to relationship instance.
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.
void touch()
Touch all of the related models for the relationship.
int rawUpdate( array $attributes = array())
Run a raw update against the base query.
Builder getRelationCountQuery( Builder $query, Builder $parent)
Add the constraints for a relationship count query.
static mixed noConstraints( Closure $callback)
Run a callback with constraints disabled on the relation.
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.
string wrap( string $value)
Wrap the given value with the parent query's grammar.
static array morphMap( array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
mixed __call( string $method, array $parameters)
Handle dynamic method calls to the relationship.
void __clone()
Force a clone of the underlying query builder when cloning.
Builder getRelationCountQueryForSelfRelation( Builder $query, Builder $parent)
Add the constraints for a relationship count query on the same table.
string getRelationCountHash()
Get a relationship join table hash.
Model dissociate()
Dissociate previously associated model from the given parent.
mixed update( array $attributes)
Update the parent model on the relationship.
string getForeignKey()
Get the foreign key of the relationship.
string getQualifiedForeignKey()
Get the fully qualified foreign key of the relationship.
string getOtherKey()
Get the associated key of the relationship.
string getQualifiedOtherKeyName()
Get the fully qualified associated key of the relationship.
Model createModelByType( string $type)
Create a new model instance by type.
string getMorphType()
Get the foreign key "type" name.
array getDictionary()
Get the dictionary used by the relationship.
$this withTrashed()
Fetch soft-deleted model instances with query.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Database/Eloquent/Relations/MorphTo.html