W3cubDocs

/Laravel 5.1

HasManyThrough

class HasManyThrough extends Relation (View source)

Methods

void __construct( Builder $query, Model $farParent, Model $parent, string $firstKey, string $secondKey, string $localKey)

Create a new has many through relationship 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.

from Relation
void touch()

Touch all of the related models for the relationship.

from Relation
int rawUpdate( array $attributes = array())

Run a raw update against the base query.

from Relation
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.

from Relation
Builder getQuery()

Get the underlying query for the relation.

from Relation
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

from Relation
Model getParent()

Get the parent model of the relation.

from Relation
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

from Relation
Model getRelated()

Get the related model of the relation.

from Relation
string createdAt()

Get the name of the "created at" column.

from Relation
string updatedAt()

Get the name of the "updated at" column.

from Relation
string relatedUpdatedAt()

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

from Relation
string wrap( string $value)

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

from Relation
static array morphMap( array $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

from Relation
mixed __call( string $method, array $parameters)

Handle dynamic method calls to the relationship.

from Relation
void __clone()

Force a clone of the underlying query builder when cloning.

from Relation
bool parentSoftDeletes()

Determine whether close parent of the relation uses Soft Deletes.

mixed first( array $columns = array('*'))

Execute the query and get the first related model.

Model|HasManyThrough firstOrFail( array $columns = array('*'))

Execute the query and get the first result or throw an exception.

Model|Collection|null find( mixed $id, array $columns = array('*'))

Find a related model by its primary key.

Collection findMany( mixed $ids, array $columns = array('*'))

Find multiple related models by their primary keys.

Model|Collection findOrFail( mixed $id, array $columns = array('*'))

Find a related model by its primary key or throw an exception.

Collection get( array $columns = array('*'))

Execute the query as a "select" statement.

LengthAwarePaginator paginate( int $perPage = null, array $columns = array('*'), string $pageName = 'page', int $page = null)

Get a paginator for the "select" statement.

Paginator simplePaginate( int $perPage = null, array $columns = array('*'), string $pageName = 'page')

Paginate the given query into a simple paginator.

string getHasCompareKey()

Get the key for comparing against the parent key in "has" query.

string getForeignKey()

Get the qualified foreign key on the related model.

string getThroughKey()

Get the qualified foreign key on the "through" model.

Details

void __construct( Builder $query, Model $farParent, Model $parent, string $firstKey, string $secondKey, string $localKey)

Create a new has many through relationship instance.

Parameters

Builder $query
Model $farParent
Model $parent
string $firstKey
string $secondKey
string $localKey

Return Value

void

void addConstraints()

Set the base constraints on the relation query.

Return Value

void

void addEagerConstraints( array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

array initRelation( array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

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

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

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

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

mixed __call( string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

bool parentSoftDeletes()

Determine whether close parent of the relation uses Soft Deletes.

Return Value

bool

mixed first( array $columns = array('*'))

Execute the query and get the first related model.

Parameters

array $columns

Return Value

mixed

Model|HasManyThrough firstOrFail( array $columns = array('*'))

Execute the query and get the first result or throw an exception.

Parameters

array $columns

Return Value

Model|HasManyThrough

Exceptions

ModelNotFoundException

Model|Collection|null find( mixed $id, array $columns = array('*'))

Find a related model by its primary key.

Parameters

mixed $id
array $columns

Return Value

Model|Collection|null

Collection findMany( mixed $ids, array $columns = array('*'))

Find multiple related models by their primary keys.

Parameters

mixed $ids
array $columns

Return Value

Collection

Model|Collection findOrFail( mixed $id, array $columns = array('*'))

Find a related model by its primary key or throw an exception.

Parameters

mixed $id
array $columns

Return Value

Model|Collection

Exceptions

ModelNotFoundException

Collection get( array $columns = array('*'))

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

LengthAwarePaginator paginate( int $perPage = null, array $columns = array('*'), string $pageName = 'page', int $page = null)

Get a paginator for the "select" statement.

Parameters

int $perPage
array $columns
string $pageName
int $page

Return Value

LengthAwarePaginator

Paginator simplePaginate( int $perPage = null, array $columns = array('*'), string $pageName = 'page')

Paginate the given query into a simple paginator.

Parameters

int $perPage
array $columns
string $pageName

Return Value

Paginator

string getHasCompareKey()

Get the key for comparing against the parent key in "has" query.

Return Value

string

string getForeignKey()

Get the qualified foreign key on the related model.

Return Value

string

string getThroughKey()

Get the qualified foreign key on the "through" model.

Return Value

string

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