class HasManyThrough extends Relation (View source)

Properties

protected Builder $query

The Eloquent query builder instance.

from  Relation
protected Model $parent

The parent model instance.

from  Relation
$related

The related model instance.

from  Relation
static protected bool $constraints

Indicates if the relation is adding constraints.

from  Relation
protected Model $farParent

The distance parent model instance.

protected string $firstKey

The near key on the relationship.

protected string $secondKey

The far key on the relationship.

Methods

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

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

static mixed
noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

from  Relation
array
getKeys(array $models, string $key = null)

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

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
mixed
__call(string $method, array $parameters)

Handle dynamic method calls to the relationship.

from  Relation
void
setJoin(Builder $query = null)

Set the join clause on the query.

array
buildDictionary(Collection $results)

Build model dictionary keyed by the relation's foreign key.

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

Execute the query as a "select" statement.

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

Set the select clause for the relation query.

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

Get a paginator for the "select" statement.

string
getHasCompareKey()

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

Details

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

Create a new has many relationship instance.

Parameters

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

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

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

protected void setJoin(Builder $query = null)

Set the join clause on the query.

Parameters

Builder $query

Return Value

void

protected array buildDictionary(Collection $results)

Build model dictionary keyed by the relation's foreign key.

Parameters

Collection $results

Return Value

array

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

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

protected BelongsToMany getSelectColumns(array $columns = array('*'))

Set the select clause for the relation query.

Parameters

array $columns

Return Value

BelongsToMany

Paginator paginate(int $perPage = null, array $columns = array('*'))

Get a paginator for the "select" statement.

Parameters

int $perPage
array $columns

Return Value

Paginator

string getHasCompareKey()

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

Return Value

string