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.

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
getRelationCountQuery( Builder $query, Builder $parent)

Add the constraints for a relationship count query.

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

from Relation
getQuery()

Get the underlying query for the relation.

from Relation
getBaseQuery()

Get the base query builder driving the Eloquent builder.

from Relation
getParent()

Get the parent model of the relation.

from Relation
string
getQualifiedParentKeyName()

Get the fully qualified parent key name.

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

firstOrFail( array $columns = array('*'))

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

find( mixed $id, array $columns = array('*'))

Find a related model by its primary key.

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

Find multiple related models by their primary keys.

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

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

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

Execute the query as a "select" statement.

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

Get a paginator for the "select" statement.

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

at line line 53
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

at line line 68
void addConstraints()

Set the base constraints on the relation query.

Return Value

void

at line line 137
void addEagerConstraints( array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

at line line 151
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 168
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 215
mixed getResults()

Get the results of the relationship.

Return Value

mixed

in Relation at line line 111
Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

in Relation at line line 121
void touch()

Touch all of the related models for the relationship.

Return Value

void

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

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

in Relation 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 89
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

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

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

in Relation at line line 212
Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

in Relation at line line 222
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

in Relation at line line 232
Model getParent()

Get the parent model of the relation.

Return Value

Model

in Relation at line line 242
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

in Relation at line line 252
Model getRelated()

Get the related model of the relation.

Return Value

Model

in Relation at line line 262
string createdAt()

Get the name of the "created at" column.

Return Value

string

in Relation at line line 272
string updatedAt()

Get the name of the "updated at" column.

Return Value

string

in Relation at line line 282
string relatedUpdatedAt()

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

Return Value

string

in Relation at line line 293
string wrap( string $value)

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

Parameters

string $value

Return Value

string

in Relation 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

in Relation 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

in Relation at line line 358
void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

at line line 126
bool parentSoftDeletes()

Determine whether close parent of the relation uses Soft Deletes.

Return Value

bool

at line line 226
mixed first( array $columns = array('*'))

Execute the query and get the first related model.

Parameters

array $columns

Return Value

mixed

at line line 241
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

at line line 257
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

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

Find multiple related models by their primary keys.

Parameters

mixed $ids
array $columns

Return Value

Collection

at line line 295
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

at line line 316
Collection get( array $columns = array('*'))

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

at line line 363
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

at line line 378
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

at line line 390
string getHasCompareKey()

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

Return Value

string

at line line 400
string getForeignKey()

Get the qualified foreign key on the related model.

Return Value

string

at line line 410
string getThroughKey()

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

Return Value

string