1. class
  2. Illuminate
  3. Database
  4. Eloquent
  5. Relations
  6. BelongsTo

BelongsTo

class BelongsTo extends Relation (View source)

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 = 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.

from Relation
Builder
getRelationQuery( Builder $query, Builder $parent, array|mixed $columns = array('*'))

Add the constraints for a relationship query.

static  mixed
noConstraints( Closure $callback)

Run a callback with constraints disabled on the relation.

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
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 = array('*'))

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

string
getRelationCountHash()

Get a relationship join table hash.

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
getQualifiedOtherKeyName()

Get the fully qualified associated key of the relationship.

Details

at line line 43
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

at line line 67
void addConstraints()

Set the base constraints on the relation query.

Return Value

void

at line line 137
void addEagerConstraints( array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

at line line 183
array initRelation( array $models, string $relation)

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

at line line 200
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

at line line 57
mixed getResults()

Get the results of the relationship.

Return Value

mixed

in Relation at line line 111
Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

in Relation at line line 121
void touch()

Touch all of the related models for the relationship.

Return Value

void

in Relation at line line 134
int rawUpdate( array $attributes = array())

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

in Relation at line line 146
Builder getRelationCountQuery( Builder $query, Builder $parent)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parent

Return Value

Builder

at line line 87
Builder getRelationQuery( Builder $query, Builder $parent, array|mixed $columns = array('*'))

Add the constraints for a relationship query.

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

in Relation at line line 174
static mixed noConstraints( Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

in Relation at line line 212
Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

in Relation at line line 222
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

in Relation at line line 232
Model getParent()

Get the parent model of the relation.

Return Value

Model

in Relation at line line 242
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

in Relation at line line 252
Model getRelated()

Get the related model of the relation.

Return Value

Model

in Relation at line line 262
string createdAt()

Get the name of the "created at" column.

Return Value

string

in Relation at line line 272
string updatedAt()

Get the name of the "updated at" column.

Return Value

string

in Relation at line line 282
string relatedUpdatedAt()

Get the name of the related model's "updated at" column.

Return Value

string

in Relation at line line 293
string wrap( string $value)

Wrap the given value with the parent query's grammar.

Parameters

string $value

Return Value

string

in Relation at line line 305
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

in Relation at line line 342
mixed __call( string $method, array $parameters)

Handle dynamic method calls to the relationship.

Parameters

string $method
array $parameters

Return Value

mixed

in Relation at line line 358
void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

at line line 108
Builder getRelationQueryForSelfRelation( Builder $query, Builder $parent, array|mixed $columns = array('*'))

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

Parameters

Builder $query
Builder $parent
array|mixed $columns

Return Value

Builder

at line line 126
string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

at line line 233
Model associate( Model|int $model)

Associate the model instance to the given parent.

Parameters

Model|int $model

Return Value

Model

at line line 251
Model dissociate()

Dissociate previously associated model from the given parent.

Return Value

Model

at line line 264
mixed update( array $attributes)

Update the parent model on the relationship.

Parameters

array $attributes

Return Value

mixed

at line line 276
string getForeignKey()

Get the foreign key of the relationship.

Return Value

string

at line line 286
string getQualifiedForeignKey()

Get the fully qualified foreign key of the relationship.

Return Value

string

at line line 296
string getOtherKey()

Get the associated key of the relationship.

Return Value

string

at line line 306
string getQualifiedOtherKeyName()

Get the fully qualified associated key of the relationship.

Return Value

string