class HasManyThrough extends Relation (View source)

Traits

Properties

static protected array $macros The registered string macros. from Macroable
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
static array $morphMap An array to map class names to their morph names in database. from Relation
protected Model $throughParent The "through" parent model instance.
protected Model $farParent The far parent model instance.
protected string $firstKey The near key on the relationship.
protected string $secondKey The far key on the relationship.
protected string $localKey The local key on the relationship.
protected string $secondLocalKey The local key on the intermediary model.
static protected int $selfJoinCount The count of self joins.

Methods

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

static void
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

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

Dynamically handle calls to the class.

from Macroable
void
__construct(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Create a new has many through relationship instance.

static mixed
noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

from Relation
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
get(array $columns = ['*'])

Execute the query as a "select" statement.

void
touch()

Touch all of the related models for the relationship.

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

Run a raw update against the base query.

from Relation
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

from Relation
getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query.

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.

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
whereInMethod(Model $model, string $key)

Get the name of the "where in" method for eager loading.

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

Set or get the morph map for polymorphic relations.

from Relation
static array|null
buildMorphMapFromModels(array $models = null)

Builds a table-keyed array from model class names.

from Relation
static string|null
getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

from Relation
void
__clone()

Force a clone of the underlying query builder when cloning.

from Relation
void
performJoin(Builder $query = null)

Set the join clause on the query.

bool
throughParentSoftDeletes()

Determine whether "through" parent of the relation uses Soft Deletes.

array
buildDictionary(Collection $results)

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

firstOrNew(array $attributes)

Get the first related model record matching the attributes or instantiate it.

updateOrCreate(array $attributes, array $values = [])

Create or update a related record matching the attributes, and fill it with values.

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

Execute the query and get the first related model.

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

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

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

Find a related model by its primary key.

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

Find multiple related models by their primary keys.

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

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

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

Get a paginator for the "select" statement.

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

Paginate the given query into a simple paginator.

array
shouldSelect(array $columns = ['*'])

Set the select clause for the relation query.

bool
chunk(int $count, callable $callback)

Chunk the results of the query.

bool
chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

Chunk the results of a query by comparing numeric IDs.

cursor()

Get a generator for the given query.

bool
each(callable $callback, int $count = 1000)

Execute a callback over each item while chunking.

prepareQueryBuilder(array $columns = ['*'])

Prepare the query builder for query execution.

getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table.

getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table as the through parent.

string
getRelationCountHash()

Get a relationship join table hash.

string
getQualifiedFarKeyName()

Get the qualified foreign key on the related model.

string
getFirstKeyName()

Get the foreign key on the "through" model.

string
getQualifiedFirstKeyName()

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

string
getForeignKeyName()

Get the foreign key on the related model.

string
getQualifiedForeignKeyName()

Get the qualified foreign key on the related model.

string
getLocalKeyName()

Get the local key on the far parent model.

string
getQualifiedLocalKeyName()

Get the qualified local key on the far parent model.

string
getSecondLocalKeyName()

Get the local key on the intermediary model.

Details

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new has many through relationship instance.

Parameters

Builder $query
Model $farParent
Model $throughParent
string $firstKey
string $secondKey
string $localKey
string $secondLocalKey

Return Value

void

static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

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

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

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

Collection

void touch()

Touch all of the related models for the relationship.

Return Value

void

int rawUpdate(array $attributes = [])

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parentQuery

Return Value

Builder

Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

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

protected string whereInMethod(Model $model, string $key)

Get the name of the "where in" method for eager loading.

Parameters

Model $model
string $key

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

static protected array|null buildMorphMapFromModels(array $models = null)

Builds a table-keyed array from model class names.

Parameters

array $models

Return Value

array|null

static string|null getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

Parameters

string $alias

Return Value

string|null

void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

protected void performJoin(Builder $query = null)

Set the join clause on the query.

Parameters

Builder $query

Return Value

void

bool throughParentSoftDeletes()

Determine whether "through" parent of the relation uses Soft Deletes.

Return Value

bool

protected array buildDictionary(Collection $results)

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

Parameters

Collection $results

Return Value

array

Model firstOrNew(array $attributes)

Get the first related model record matching the attributes or instantiate it.

Parameters

array $attributes

Return Value

Model

Model updateOrCreate(array $attributes, array $values = [])

Create or update a related record matching the attributes, and fill it with values.

Parameters

array $attributes
array $values

Return Value

Model

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

Execute the query and get the first related model.

Parameters

array $columns

Return Value

mixed

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

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 = ['*'])

Find a related model by its primary key.

Parameters

mixed $id
array $columns

Return Value

Model|Collection|null

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

Find multiple related models by their primary keys.

Parameters

mixed $ids
array $columns

Return Value

Collection

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

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

Parameters

mixed $id
array $columns

Return Value

Model|Collection

Exceptions

ModelNotFoundException

LengthAwarePaginator paginate(int $perPage = null, array $columns = ['*'], 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 = ['*'], string $pageName = 'page', int|null $page = null)

Paginate the given query into a simple paginator.

Parameters

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

Return Value

Paginator

protected array shouldSelect(array $columns = ['*'])

Set the select clause for the relation query.

Parameters

array $columns

Return Value

array

bool chunk(int $count, callable $callback)

Chunk the results of the query.

Parameters

int $count
callable $callback

Return Value

bool

bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

Chunk the results of a query by comparing numeric IDs.

Parameters

int $count
callable $callback
string|null $column
string|null $alias

Return Value

bool

Generator cursor()

Get a generator for the given query.

Return Value

Generator

bool each(callable $callback, int $count = 1000)

Execute a callback over each item while chunking.

Parameters

callable $callback
int $count

Return Value

bool

protected Builder prepareQueryBuilder(array $columns = ['*'])

Prepare the query builder for query execution.

Parameters

array $columns

Return Value

Builder

Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

Builder getRelationExistenceQueryForThroughSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table as the through parent.

Parameters

Builder $query
Builder $parentQuery
array|mixed $columns

Return Value

Builder

string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

string getQualifiedFarKeyName()

Get the qualified foreign key on the related model.

Return Value

string

string getFirstKeyName()

Get the foreign key on the "through" model.

Return Value

string

string getQualifiedFirstKeyName()

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

Return Value

string

string getForeignKeyName()

Get the foreign key on the related model.

Return Value

string

string getQualifiedForeignKeyName()

Get the qualified foreign key on the related model.

Return Value

string

string getLocalKeyName()

Get the local key on the far parent model.

Return Value

string

string getQualifiedLocalKeyName()

Get the qualified local key on the far parent model.

Return Value

string

string getSecondLocalKeyName()

Get the local key on the intermediary model.

Return Value

string