Relation

# __construct ( Builder $query , Model $parent ) : void

Create a new relation instance.

Parameters

• $query Builder
• $parent Model

# noConstraints ( Closure $callback ) : mixed

Run a callback with constraints disabled on the relation.

Parameters

• $callback Closure

# addConstraints ( ) : void

Set the base constraints on the relation query.

# addEagerConstraints ( array $models ) : void

Set the constraints for an eager load of the relation.

Parameters

• $models array

# initRelation ( array $models , $relation ) : array

Initialize the relation on a set of models.

Parameters

• $models array
• $relation string

# match ( array $models , Illuminate\...\Collection $results , $relation ) : array

Match the eagerly loaded results to their parents.

Parameters

• $models array
• $results Illuminate\...\Collection
• $relation string

# getResults ( ) : mixed

Get the results of the relationship.

# getEager ( ) : Illuminate\...\Collection

Get the relationship for eager loading.

# sole ( $columns ) : Model

Execute the query and get the first result if it's the sole matching record.

Parameters

• $columns array|string

# get ( $columns ) : Illuminate\...\Collection

Execute the query as a "select" statement.

Parameters

• $columns array

# touch ( ) : void

Touch all of the related models for the relationship.

# rawUpdate ( array $attributes ) : int

Run a raw update against the base query.

Parameters

• $attributes array

# getRelationExistenceCountQuery ( Builder $query , Builder $parentQuery ) : Builder

Add the constraints for a relationship count query.

Parameters

• $query Builder
• $parentQuery Builder

# getRelationExistenceQuery ( Builder $query , Builder $parentQuery , $columns ) : Builder

Add the constraints for an internal relationship existence query.

Parameters

• $query Builder
• $parentQuery Builder
• $columns array|mixed

# getRelationCountHash ( $incrementJoinCount ) : string

Get a relationship join table hash.

Parameters

• $incrementJoinCount bool

# getKeys ( array $models , $key ) : array

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

Parameters

• $models array
• $key string|null

# getRelationQuery ( ) : Builder

Get the query builder that will contain the relationship constraints.

# getQuery ( ) : Builder

Get the underlying query for the relation.

# getBaseQuery ( ) : Builder

Get the base query builder driving the Eloquent builder.

# toBase ( ) : Builder

Get a base query builder instance.

# getParent ( ) : Model

Get the parent model of the relation.

# getQualifiedParentKeyName ( ) : string

Get the fully qualified parent key name.

# getRelated ( ) : Model

Get the related model of the relation.

# createdAt ( ) : string

Get the name of the "created at" column.

# updatedAt ( ) : string

Get the name of the "updated at" column.

# relatedUpdatedAt ( ) : string

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

# whereInEager ( string $whereIn , string $key , array $modelKeys , $query ) : void

Add a whereIn eager constraint for the given set of model keys to be loaded.

Parameters

• $whereIn string
• $key string
• $modelKeys array
• $query Builder

# whereInMethod ( Model $model , $key ) : string

Get the name of the "where in" method for eager loading.

Parameters

• $model Model
• $key string

# requireMorphMap ( $requireMorphMap ) : void

Prevent polymorphic relationships from being used without model mappings.

Parameters

• $requireMorphMap bool

# requiresMorphMap ( ) : bool

Determine if polymorphic relationships require explicit model mapping.

# enforceMorphMap ( array $map , $merge ) : array

Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.

Parameters

• $map array
• $merge bool

# morphMap ( array $map , $merge ) : array

Set or get the morph map for polymorphic relations.

Parameters

• $map array|null
• $merge bool

# buildMorphMapFromModels ( array $models ) : array|null

Builds a table-keyed array from model class names.

Parameters

• $models string[]|null

# getMorphedModel ( $alias ) : string|null

Get the model associated with a custom polymorphic type.

Parameters

• $alias string

# __call ( $method , $parameters ) : mixed

Handle dynamic method calls to the relationship.

Parameters

• $method string
• $parameters array

# __clone ( ) : void

Force a clone of the underlying query builder when cloning.