Documentation

MorphTo extends MorphTo

in package

• Application

Uses DefinedConstraints

Table of Contents

$morphMap  : array<string|int, mixed>

An array to map class names to their morph names in database.

$child  : mixed

The child model instance of the relation.

$constraints  : bool

Indicates if the relation is adding constraints.

$dictionary  : array<string|int, mixed>

All of the models keyed by ID.

$foreignKey  : string

The foreign key of the parent model.

$macroBuffer  : array<string|int, mixed>

A buffer of dynamic calls to query macros.

$macros  : array<string|int, mixed>

The registered string macros.

$models  : Collection

The models whose relations are being eager loaded.

$morphType  : string

The type of the polymorphic relation.

$ownerKey  : string

The associated key on the parent model.

$parent  : Model

The parent model instance.

$query  : Builder

The Eloquent query builder instance.

$related  : Model

The related model instance.

$relation  : string

The name of the relationship.

$relationName  : string

$selfJoinCount  : int

The count of self joins.

$withDefault  : Closure|array<string|int, mixed>|bool

Indicates if a default model instance should be used.

__call()  : mixed

Dynamically handle calls to the class.

__callStatic()  : mixed

Dynamically handle calls to the class.

__clone()  : void

Force a clone of the underlying query builder when cloning.

__construct()  : void

Create a new morph to relationship instance.

addConstraints()  : void

Set the base constraints on the relation query.

addDefinedConstraints()  : void

Set the defined constraints on the relation query.

addDefinedConstraintsToQuery()  : mixed

Add query based constraints.

addDefinedConstraintsToRelation()  : mixed

Add relation based constraints.

addEagerConstraints()  : void

Set the constraints for an eager load of the relation.

associate()  : Model

Associate the model instance to the given parent.

createdAt()  : string

Get the name of the "created at" column.

createModelByType()  : Model

Create a new model instance by type.

dissociate()  : Model

Dissociate previously associated model from the given parent.

get()  : Collection

Execute the query as a "select" statement.

getBaseQuery()  : Builder

Get the base query builder driving the Eloquent builder.

getDictionary()  : array<string|int, mixed>

Get the dictionary used by the relationship.

getEager()  : Collection

Get the relationship for eager loading.

getForeignKey()  : string

Get the foreign key of the relationship.

getMorphedModel()  : string|null

Get the model associated with a custom polymorphic type.

getMorphType()  : string

Get the foreign key "type" name.

getOwnerKey()  : string

Get the associated key of the relationship.

getParent()  : Model

Get the parent model of the relation.

getQualifiedForeignKey()  : string

Get the fully qualified foreign key of the relationship.

getQualifiedOwnerKeyName()  : string

Get the fully qualified associated key of the relationship.

getQualifiedParentKeyName()  : string

Get the fully qualified parent key name.

getQuery()  : Builder

Get the underlying query for the relation.

getRelated()  : Model

Get the related model of the relation.

getRelation()  : string

Get the name of the relationship.

getRelationCountHash()  : string

Get a relationship join table hash.

getRelationExistenceCountQuery()  : Builder

Add the constraints for a relationship count query.

getRelationExistenceQuery()  : Builder

Add the constraints for an internal relationship existence query.

getRelationExistenceQueryForSelfRelation()  : Builder

Add the constraints for a relationship query on the same table.

getResults()  : mixed

Get the results of the relationship.

getSimpleValue()  : mixed

Helper for getting this relationship simple value, generally useful with form values.

hasMacro()  : bool

Checks if macro is registered.

initRelation()  : array<string|int, mixed>

Initialize the relation on a set of models.

macro()  : void

Register a custom macro.

match()  : array<string|int, mixed>

Match the eagerly loaded results to their parents.

mixin()  : void

Mix another object into the class.

morphMap()  : array<string|int, mixed>

Set or get the morph map for polymorphic relations.

noConstraints()  : mixed

Run a callback with constraints disabled on the relation.

rawUpdate()  : int

Run a raw update against the base query.

relatedUpdatedAt()  : string

Get the name of the related model's "updated at" column.

setSimpleValue()  : mixed

Helper for setting this relationship using various expected values. For example, $model->relation = $value;

touch()  : void

Touch all of the related models for the relationship.

update()  : mixed

Update the parent model on the relationship.

updatedAt()  : string

Get the name of the "updated at" column.

withDefault()  : $this

Return a new model instance in case the relationship does not exist.

buildDictionary()  : void

Build a dictionary with the models.

buildMorphMapFromModels()  : array<string|int, mixed>|null

Builds a table-keyed array from model class names.

gatherKeysByType()  : array<string|int, mixed>

Gather all of the foreign keys for a given type.

getDefaultFor()  : Model|null

Get the default value for this relation.

getEagerModelKeys()  : array<string|int, mixed>

Gather the keys from an array of related models.

getKeys()  : array<string|int, mixed>

Get all of the primary keys for an array of models.

getResultsByType()  : Collection

Get all of the relation results for a type.

matchToMorphParents()  : void

Match the results for a given type to their parents.

newRelatedInstanceFor()  : Model

Make a new related instance for the given model.

relationHasIncrementingId()  : bool

Determine if the related model has an auto-incrementing ID.

replayMacros()  : Builder

Replay stored macro calls on the actual related instance.