HasManyThrough
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 |
| protected Model | $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. | |
| 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 |
| array | getKeys(array $models, string $key = null) Get all of the primary keys for an array of models. | 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 |
| 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. | |
| Collection | get(array $columns = array('*')) Execute the query as a "select" statement. | |
| BelongsToMany | getSelectColumns(array $columns = array('*')) Set the select clause for the relation query. | |
| Paginator | 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.
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.
protected 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.
protected void setJoin(Builder $query = null)
Set the join clause on the query.
protected array buildDictionary(Collection $results)
Build model dictionary keyed by the relation's foreign key.
Collection get(array $columns = array('*'))
Execute the query as a "select" statement.
protected BelongsToMany getSelectColumns(array $columns = array('*'))
Set the select clause for the relation query.
Paginator 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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Database/Eloquent/Relations/HasManyThrough.html