Documentation

Relation extends Relation
in package

Application

Umbrella class for Laravel.

Relation::morphMap([ 'posts' => 'App\Post', 'videos' => 'App\Video', ]);

$morphMap : array<string|int, mixed>: An array to map class names to their morph names in database.
$constraints : bool: Indicates if the relation is adding constraints.
$macros : array<string|int, mixed>: The registered string macros.
$parent : Model: The parent model instance.
$query : Builder: The Eloquent query builder instance.
$related : Model: The related model instance.
__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 relation instance.
addConstraints() : void: Set the base constraints on the relation query.
addEagerConstraints() : void: Set the constraints for an eager load of the relation.
createdAt() : string: Get the name of the "created at" column.
get() : Collection: Execute the query as a "select" statement.
getBaseQuery() : Builder: Get the base query builder driving the Eloquent builder.
getEager() : Collection: Get the relationship for eager loading.
getMorphedModel() : string|null: Get the model associated with a custom polymorphic type.
getParent() : Model: Get the parent model of the relation.
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.
getRelationExistenceCountQuery() : Builder: Add the constraints for a relationship count query.
getRelationExistenceQuery() : Builder: Add the constraints for an internal relationship existence query.
getResults() : mixed: Get the results of the relationship.
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.
touch() : void: Touch all of the related models for the relationship.
updatedAt() : string: Get the name of the "updated at" column.
buildMorphMapFromModels() : array<string|int, mixed>|null: Builds a table-keyed array from model class names.
getKeys() : array<string|int, mixed>: Get all of the primary keys for an array of models.

$morphMap

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


    public
    static    array<string|int, mixed>
    $morphMap
     = []

$constraints

Indicates if the relation is adding constraints.


    protected
    static    bool
    $constraints
     = true

$macros

The registered string macros.


    protected
    static    array<string|int, mixed>
    $macros
     = []

$parent

The parent model instance.


    protected
        Model
    $parent

$query

The Eloquent query builder instance.


    protected
        Builder
    $query

$related

The related model instance.


    protected
        Model
    $related

__call()

Dynamically handle calls to the class.


    public
                __call(string $method, array<string|int, mixed> $parameters) : mixed

Parameters

$method : string
$parameters : array<string|int, mixed>

Return values

mixed —

__callStatic()

Dynamically handle calls to the class.


    public
            static    __callStatic(string $method, array<string|int, mixed> $parameters) : mixed

Parameters

$method : string
$parameters : array<string|int, mixed>

Return values

mixed —

__clone()

Force a clone of the underlying query builder when cloning.


    public
                __clone() : void

Return values

void —

__construct()

Create a new relation instance.


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

Parameters

$query : Builder
$parent : Model

Return values

void —

addConstraints()

Set the base constraints on the relation query.


    public
    abstract            addConstraints() : void

Return values

void —

addEagerConstraints()

Set the constraints for an eager load of the relation.


    public
    abstract            addEagerConstraints(array<string|int, mixed> $models) : void

Parameters

$models : array<string|int, mixed>

Return values

void —

createdAt()

Get the name of the "created at" column.


    public
                createdAt() : string

Return values

string —

get()

Execute the query as a "select" statement.


    public
                get([array<string|int, mixed> $columns = ['*'] ]) : Collection

Parameters

$columns : array<string|int, mixed> = ['*']

Return values

Collection —

getBaseQuery()

Get the base query builder driving the Eloquent builder.


    public
                getBaseQuery() : Builder

Return values

Builder —

getEager()

Get the relationship for eager loading.


    public
                getEager() : Collection

Return values

Collection —

getMorphedModel()

Get the model associated with a custom polymorphic type.


    public
            static    getMorphedModel(string $alias) : string|null

Parameters

$alias : string

Return values

string|null —

getParent()

Get the parent model of the relation.


    public
                getParent() : Model

Return values

Model —

getQualifiedParentKeyName()

Get the fully qualified parent key name.


    public
                getQualifiedParentKeyName() : string

Return values

string —

getQuery()

Get the underlying query for the relation.


    public
                getQuery() : Builder

Return values

Builder —

getRelated()

Get the related model of the relation.


    public
                getRelated() : Model

Return values

Model —

getRelationExistenceCountQuery()

Add the constraints for a relationship count query.


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

Parameters

$query : Builder
$parentQuery : Builder

Return values

Builder —

getRelationExistenceQuery()

Add the constraints for an internal relationship existence query.


    public
                getRelationExistenceQuery(Builder $query, Builder $parentQuery[, array<string|int, mixed>|mixed $columns = ['*'] ]) : Builder

Essentially, these queries compare on column names like whereColumn.

Parameters

$query : Builder
$parentQuery : Builder
$columns : array<string|int, mixed>|mixed = ['*']

Return values

Builder —

getResults()

Get the results of the relationship.


    public
    abstract            getResults() : mixed

Return values

mixed —

hasMacro()

Checks if macro is registered.


    public
            static    hasMacro(string $name) : bool

Parameters

$name : string

Return values

bool —

initRelation()

Initialize the relation on a set of models.


    public
    abstract            initRelation(array<string|int, mixed> $models, string $relation) : array<string|int, mixed>

Parameters

$models : array<string|int, mixed>
$relation : string

Return values

array<string|int, mixed> —

macro()


    public
            static    macro(string $name, object|callable $macro) : void

Parameters

$name : string
$macro : object|callable

Return values

void —

match()

Match the eagerly loaded results to their parents.


    public
    abstract            match(array<string|int, mixed> $models, Collection $results, string $relation) : array<string|int, mixed>

Parameters

$models : array<string|int, mixed>
$results : Collection
$relation : string

Return values

array<string|int, mixed> —

mixin()

Mix another object into the class.


    public
            static    mixin(object $mixin) : void

Parameters

$mixin : object

Return values

void —

morphMap()

Set or get the morph map for polymorphic relations.


    public
            static    morphMap([array<string|int, mixed>|null $map = null ][, bool $merge = true ]) : array<string|int, mixed>

Parameters

$map : array<string|int, mixed>|null = null
$merge : bool = true

Return values

array<string|int, mixed> —

noConstraints()

Run a callback with constraints disabled on the relation.


    public
            static    noConstraints(Closure $callback) : mixed

Parameters

$callback : Closure

Return values

mixed —

rawUpdate()

Run a raw update against the base query.


    public
                rawUpdate([array<string|int, mixed> $attributes = [] ]) : int

Parameters

$attributes : array<string|int, mixed> = []

Return values

int —

relatedUpdatedAt()

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


    public
                relatedUpdatedAt() : string

Return values

string —

touch()

Touch all of the related models for the relationship.


    public
                touch() : void

Return values

void —

updatedAt()

Get the name of the "updated at" column.


    public
                updatedAt() : string

Return values

string —

buildMorphMapFromModels()

Builds a table-keyed array from model class names.


    protected
            static    buildMorphMapFromModels([array<string|int, string>|null $models = null ]) : array<string|int, mixed>|null

Parameters

$models : array<string|int, string>|null = null

Return values

array<string|int, mixed>|null —

getKeys()

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


    protected
                getKeys(array<string|int, mixed> $models[, string $key = null ]) : array<string|int, mixed>

Parameters

$models : array<string|int, mixed>
$key : string = null

Return values

array<string|int, mixed> —