Relation

class Relation (View source)

Properties

protected Builder $query The Eloquent query builder instance.
protected Model $parent The parent model instance.
$related The related model instance.
static protected bool $constraints Indicates if the relation is adding constraints.

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.
static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.
array getKeys(array $models, string $key = null)

Get all of the primary keys for an array of models.
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.
mixed __call(string $method, array $parameters)

Handle dynamic method calls to the relationship.

Details

void __construct(Builder $query, Model $parent)

Create a new relation instance.

Parameters

Builder $query
Model $parent

Return Value

void

abstract void addConstraints()

Set the base constraints on the relation query.

Return Value

void

abstract void addEagerConstraints(array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

abstract array initRelation(array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

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

abstract mixed getResults()

Get the results of the relationship.

Return Value

mixed

Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

void touch()

Touch all of the related models for the relationship.

Return Value

void

int rawUpdate(array $attributes = array())

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

Builder getRelationCountQuery(Builder $query, Builder $parent)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parent

Return Value

Builder

static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

protected array getKeys(array $models, string $key = null)

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

Parameters

array $models
string $key

Return Value

array

Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

Model getParent()

Get the parent model of the relation.

Return Value

Model

string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

Model getRelated()

Get the related model of the relation.

Return Value

Model

string createdAt()

Get the name of the "created at" column.

Return Value

string

string updatedAt()

Get the name of the "updated at" column.

Return Value

string

string relatedUpdatedAt()

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

Return Value

string

string wrap(string $value)

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

Parameters

string $value

Return Value

string

mixed __call(string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Database/Eloquent/Relations/Relation.html