Relation
class Relation (View source)
Properties
| protected Builder | $query | The Eloquent query builder instance. | |
| protected Model | $parent | The parent model instance. | |
| protected Model | $related | The related model instance. | |
| static protected bool | $constraints | Indicates if the relation is adding constraints. | |
| static protected array | $morphMap | An array to map class names to their morph names in database. |
Methods
| void | __construct(Builder $query, Model $parent) Create a new relation 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 = []) Run a raw update against the base query. | |
| Builder | getRelationCountQuery(Builder $query, Builder $parent) Add the constraints for a relationship count query. | |
| Builder | getRelationQuery(Builder $query, Builder $parent, array|mixed $columns = ['*']) Add the constraints for a relationship query. | |
| static mixed | noConstraints(Closure $callback) Run a callback with constraints disabled on the relation. | |
| 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. | |
| static array | morphMap(array $map = null, bool $merge = true) Set or get the morph map for polymorphic relations. | |
| static array|null | buildMorphMapFromModels(array $models = null) Builds a table-keyed array from model class names. | |
| mixed | __call(string $method, array $parameters) Handle dynamic method calls to the relationship. | |
| void | __clone() Force a clone of the underlying query builder when cloning. |
Details
abstract void addConstraints()
Set the base constraints on the relation query.
abstract void addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
abstract array initRelation(array $models, string $relation)
Initialize the relation on a set of models.
abstract array match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
abstract 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 = [])
Run a raw update against the base query.
Builder getRelationCountQuery(Builder $query, Builder $parent)
Add the constraints for a relationship count query.
Builder getRelationQuery(Builder $query, Builder $parent, array|mixed $columns = ['*'])
Add the constraints for a relationship 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.
static array morphMap(array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array $models = null)
Builds a table-keyed array from model class names.
mixed __call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
void __clone()
Force a clone of the underlying query builder when cloning.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Eloquent/Relations/Relation.html