1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Eloquent
  7. \
  8. Relations
  9. \
  10. BelongsTo

BelongsTo

class BelongsTo extends Relation mixin Builder

Traits

SupportsDefaultModels
Macroable

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 protected array $morphMap

An array to map class names to their morph names in database.

 from  Relation
protected Closure|array|bool $withDefault

Indicates if a default model instance should be used.

 from  SupportsDefaultModels
protected $child

The child model instance of the relation.
protected string $foreignKey

The foreign key of the parent model.
protected string $ownerKey

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

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

Register a custom macro.

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 $child, string $foreignKey, string $ownerKey, string $relation)

Create a new belongs to 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.

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
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

from  Relation
Builder
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
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
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
Model
newRelatedInstanceFor(Model $parent)

Make a new related instance for the given model.

$this
withDefault(Closure|array|bool $callback = true)

Return a new model instance in case the relationship does not exist.

from  SupportsDefaultModels
Model|null
getDefaultFor(Model $parent)

Get the default value for this relation.

from  SupportsDefaultModels
array
getEagerModelKeys(array $models)

Gather the keys from an array of related models.

mixed
update(array $attributes)

Update the parent model on the relationship.

Model
associate(Model|int|string $model)

Associate the model instance to the given parent.

Model
dissociate()

Dissociate previously associated model from the given parent.

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

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

string
getRelationCountHash()

Get a relationship join table hash.

bool
relationHasIncrementingId()

Determine if the related model has an auto-incrementing ID.

string
getForeignKey()

Get the foreign key of the relationship.

string
getQualifiedForeignKey()

Get the fully qualified foreign key of the relationship.

string
getOwnerKey()

Get the associated key of the relationship.

string
getQualifiedOwnerKeyName()

Get the fully qualified associated key of the relationship.

string
getRelation()

Get the name of the relationship.

Details

in Macroable at line 24
static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line 35
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 49
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 71
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 60
void __construct(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

Create a new belongs to relationship instance.

Parameters

Builder $query
Model $child
string $foreignKey
string $ownerKey
string $relation

Return Value

void

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

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

at line 89
void addConstraints()

Set the base constraints on the relation query.

Return Value

void

at line 107
void addEagerConstraints(array $models)

Set the constraints for an eager load of the relation.

Parameters

array $models

Return Value

void

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

Initialize the relation on a set of models.

Parameters

array $models
string $relation

Return Value

array

at line 172
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 79
mixed getResults()

Get the results of the relationship.

Return Value

mixed

in Relation at line 141
Collection getEager()

Get the relationship for eager loading.

Return Value

Collection

in Relation at line 151
void touch()

Touch all of the related models for the relationship.

Return Value

void

in Relation at line 164
int rawUpdate(array $attributes = [])

Run a raw update against the base query.

Parameters

array $attributes

Return Value

int

in Relation at line 176
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parentQuery

Return Value

Builder

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

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

in Relation at line 219
Builder getQuery()

Get the underlying query for the relation.

Return Value

Builder

in Relation at line 229
Builder getBaseQuery()

Get the base query builder driving the Eloquent builder.

Return Value

Builder

in Relation at line 239
Model getParent()

Get the parent model of the relation.

Return Value

Model

in Relation at line 249
string getQualifiedParentKeyName()

Get the fully qualified parent key name.

Return Value

string

in Relation at line 259
Model getRelated()

Get the related model of the relation.

Return Value

Model

in Relation at line 269
string createdAt()

Get the name of the "created at" column.

Return Value

string

in Relation at line 279
string updatedAt()

Get the name of the "updated at" column.

Return Value

string

in Relation at line 289
string relatedUpdatedAt()

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

Return Value

string

in Relation at line 301
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 319
static protected array|null buildMorphMapFromModels(array $models = null)

Builds a table-keyed array from model class names.

Parameters

array $models

Return Value

array|null

in Relation at line 336
static string|null getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

Parameters

string $alias

Return Value

string|null

in Relation at line 370
void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

at line 308
protected Model newRelatedInstanceFor(Model $parent)

Make a new related instance for the given model.

Parameters

Model $parent

Return Value

Model

in SupportsDefaultModels at line 32
$this withDefault(Closure|array|bool $callback = true)

Return a new model instance in case the relationship does not exist.

Parameters

Closure|array|bool $callback

Return Value

$this

in SupportsDefaultModels at line 45
protected Model|null getDefaultFor(Model $parent)

Get the default value for this relation.

Parameters

Model $parent

Return Value

Model|null

at line 123
protected array getEagerModelKeys(array $models)

Gather the keys from an array of related models.

Parameters

array $models

Return Value

array

at line 205
mixed update(array $attributes)

Update the parent model on the relationship.

Parameters

array $attributes

Return Value

mixed

at line 216
Model associate(Model|int|string $model)

Associate the model instance to the given parent.

Parameters

Model|int|string $model

Return Value

Model

at line 234
Model dissociate()

Dissociate previously associated model from the given parent.

Return Value

Model

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

at line 286
string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

at line 296
protected bool relationHasIncrementingId()

Determine if the related model has an auto-incrementing ID.

Return Value

bool

at line 318
string getForeignKey()

Get the foreign key of the relationship.

Return Value

string

at line 328
string getQualifiedForeignKey()

Get the fully qualified foreign key of the relationship.

Return Value

string

at line 338
string getOwnerKey()

Get the associated key of the relationship.

Return Value

string

at line 348
string getQualifiedOwnerKeyName()

Get the fully qualified associated key of the relationship.

Return Value

string

at line 358
string getRelation()

Get the name of the relationship.

Return Value

string