1. class
  2. Illuminate
  3. Database
  4. Eloquent
  5. Relations
  6. Relation

Relation

class Relation (View source)

Methods

void
__construct( Builder $query, Model $parent)

Create a new relation 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 relationship for eager loading.

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.

Builder
getRelationQuery( Builder $query, Builder $parent, array|mixed $columns = array('*'))

Add the constraints for a relationship 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.

Details

at line line 56
void __construct( Builder $query, Model $parent)

Create a new relation instance.

Parameters

Builder $query
Model $parent

Return Value

void

at line line 70
abstract void addConstraints()

Set the base constraints on the relation query.

Return Value

void

at line line 78
abstract void addEagerConstraints( array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

at line line 87
abstract array initRelation( array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

at line line 97
abstract array match( array $models, Collection $results, string $relation)

Match the eagerly loaded results to their parents.

Parameters

array $models
Collection $results
string $relation

Return Value

array

at line line 104
abstract mixed getResults()

Get the results of the relationship.

Return Value

mixed

at line line 111
Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

at line line 121
void touch()

Touch all of the related models for the relationship.

Return Value

void

at line line 134
int rawUpdate( array $attributes = array())

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

at line line 146
Builder getRelationCountQuery( Builder $query, Builder $parent)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parent

Return Value

Builder

at line line 159
Builder getRelationQuery( Builder $query, Builder $parent, array|mixed $columns = array('*'))

Add the constraints for a relationship query.

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

at line line 174
static mixed noConstraints( Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

at line line 212
Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

at line line 222
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

at line line 232
Model getParent()

Get the parent model of the relation.

Return Value

Model

at line line 242
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

at line line 252
Model getRelated()

Get the related model of the relation.

Return Value

Model

at line line 262
string createdAt()

Get the name of the "created at" column.

Return Value

string

at line line 272
string updatedAt()

Get the name of the "updated at" column.

Return Value

string

at line line 282
string relatedUpdatedAt()

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

Return Value

string

at line line 293
string wrap( string $value)

Wrap the given value with the parent query's grammar.

Parameters

string $value

Return Value

string

at line line 305
static array morphMap( array $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

Parameters

array $map
bool $merge

Return Value

array

at line line 342
mixed __call( string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

at line line 358
void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void