BelongsTo

class BelongsTo 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
static protected array $morphMap An array to map class names to their morph names in database. from Relation
protected string $foreignKey The foreign key of the parent model.
protected string $otherKey The associated key on the parent model.
protected string $relation The name of the relationship.
static protected int $selfJoinCount The count of self joins.

Methods

void __construct(Builder $query, Model $parent, string $foreignKey, string $otherKey, string $relation)

Create a new belongs to 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 = [])

Run a raw update against the base query.

 from Relation
Builder getRelationCountQuery(Builder $query, Builder $parent)

Add the constraints for a relationship count query.

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

 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
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
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
Builder getRelationQueryForSelfRelation(Builder $query, Builder $parent, array|mixed $columns = ['*'])

Add the constraints for a relationship query on the same table.
string getRelationCountHash()

Get a relationship join table hash.
array getEagerModelKeys(array $models)

Gather the keys from an array of related models.
Model associate(Model|int $model)

Associate the model instance to the given parent.
Model dissociate()

Dissociate previously associated model from the given parent.
mixed update(array $attributes)

Update the parent model on the relationship.
string getForeignKey()

Get the foreign key of the relationship.
string getQualifiedForeignKey()

Get the fully qualified foreign key of the relationship.
string getOtherKey()

Get the associated key of the relationship.
string getRelation()

Get the name of the relationship.
string getQualifiedOtherKeyName()

Get the fully qualified associated key of the relationship.

Details

void __construct(Builder $query, Model $parent, string $foreignKey, string $otherKey, string $relation)

Create a new belongs to relationship instance.

Parameters

Builder $query
Model $parent
string $foreignKey
string $otherKey
string $relation

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

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

Builder getRelationQuery(Builder $query, Builder $parent, array|mixed $columns = ['*'])

Add the constraints for a relationship query.

Parameters

Builder $query
Builder $parent
array|mixed $columns

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

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

mixed __call(string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

Builder getRelationQueryForSelfRelation(Builder $query, Builder $parent, array|mixed $columns = ['*'])

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

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

protected array getEagerModelKeys(array $models)

Gather the keys from an array of related models.

Parameters

array $models

Return Value

array

Model associate(Model|int $model)

Associate the model instance to the given parent.

Parameters

Model|int $model

Return Value

Model

Model dissociate()

Dissociate previously associated model from the given parent.

Return Value

Model

mixed update(array $attributes)

Update the parent model on the relationship.

Parameters

array $attributes

Return Value

mixed

string getForeignKey()

Get the foreign key of the relationship.

Return Value

string

string getQualifiedForeignKey()

Get the fully qualified foreign key of the relationship.

Return Value

string

string getOtherKey()

Get the associated key of the relationship.

Return Value

string

string getRelation()

Get the name of the relationship.

Return Value

string

string getQualifiedOtherKeyName()

Get the fully qualified associated key of the relationship.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Eloquent/Relations/BelongsTo.html