class BelongsTo extends Relation (View source)

Traits

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
protected bool $eagerKeysWereEmpty

Indicates whether the eagerly loaded relation should implicitly return an empty collection.

from  Relation
static protected bool $constraints

Indicates if the relation is adding constraints.

from  Relation
static array $morphMap

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

from  Relation
static protected bool $requireMorphMap

Prevents morph relationships without a morph map.

from  Relation
static protected int $selfJoinCount

The count of self joins.

from  Relation
protected Closure|array|bool $withDefault

Indicates if a default model instance should be used.

from  SupportsDefaultModels
protected Model $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 $relationName

The name of the relationship.

Methods

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

static void
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

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

Register a custom macro.

static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

void
__construct(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relationName)

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.

getEager()

Get the relationship for eager loading.

from  Relation
sole(array|string $columns = ['*'])

Execute the query and get the first result if it's the sole matching record.

from  Relation
get(array $columns = ['*'])

Execute the query as a "select" statement.

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

Add the constraints for a relationship count query.

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

Add the constraints for a relationship query.

string
getRelationCountHash(bool $incrementJoinCount = true)

Get a relationship join table hash.

from  Relation
array
getKeys(array $models, string|null $key = null)

Get all of the primary keys for an array of models.

from  Relation
getRelationQuery()

Get the query builder that will contain the relationship constraints.

from  Relation
getQuery()

Get the underlying query for the relation.

from  Relation
getBaseQuery()

Get the base query builder driving the Eloquent builder.

from  Relation
toBase()

Get a base query builder instance.

from  Relation
getParent()

Get the parent model of the relation.

from  Relation
string
getQualifiedParentKeyName()

Get the fully qualified parent key name.

from  Relation
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
void
whereInEager(string $whereIn, string $key, array $modelKeys, Builder $query = null)

Add a whereIn eager constraint for the given set of model keys to be loaded.

from  Relation
string
whereInMethod(Model $model, string $key)

Get the name of the "where in" method for eager loading.

from  Relation
static void
requireMorphMap(bool $requireMorphMap = true)

Prevent polymorphic relationships from being used without model mappings.

from  Relation
static bool
requiresMorphMap()

Determine if polymorphic relationships require explicit model mapping.

from  Relation
static array
enforceMorphMap(array $map, bool $merge = true)

Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.

from  Relation
static array
morphMap(array|null $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

from  Relation
static array|null
buildMorphMapFromModels(array|null $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
bool
is(Model|null $model)

Determine if the model is the related instance of the relationship.

bool
isNot(Model|null $model)

Determine if the model is not the related instance of the relationship.

mixed
getParentKey()

Get the key value of the child's foreign key.

mixed
getRelatedKeyFrom(Model $model)

Get the value of the model's associated key.

bool
compareKeys(mixed $parentKey, mixed $relatedKey)

Compare the parent key with the related key.

mixed
getDictionaryKey(mixed $attribute)

Get a dictionary key attribute - casting it to a string if necessary.

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.

Model|null
getDefaultFor(Model $parent)

Get the default value for this relation.

array
getEagerModelKeys(array $models)

Gather the keys from an array of related models.

associate(Model|int|string|null $model)

Associate the model instance to the given parent.

dissociate()

Dissociate previously associated model from the given parent.

disassociate()

Alias of "dissociate" method.

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

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

bool
relationHasIncrementingId()

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

getChild()

Get the child of the relationship.

string
getForeignKeyName()

Get the foreign key of the relationship.

string
getQualifiedForeignKeyName()

Get the fully qualified foreign key of the relationship.

string
getOwnerKeyName()

Get the associated key of the relationship.

string
getQualifiedOwnerKeyName()

Get the fully qualified associated key of the relationship.

mixed
getForeignKeyFrom(Model $model)

Get the value of the model's foreign key.

string
getRelationName()

Get the name of the relationship.

Details

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

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

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relationName)

Create a new belongs to relationship instance.

Parameters

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

Return Value

void

static mixed noConstraints(Closure $callback)

Run a callback with constraints disabled on the relation.

Parameters

Closure $callback

Return Value

mixed

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

Model sole(array|string $columns = ['*'])

Execute the query and get the first result if it's the sole matching record.

Parameters

array|string $columns

Return Value

Model

Exceptions

Model>
MultipleRecordsFoundException

Collection get(array $columns = ['*'])

Execute the query as a "select" statement.

Parameters

array $columns

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

Add the constraints for a relationship count query.

Parameters

Builder $query
Builder $parentQuery

Return Value

Builder

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

string getRelationCountHash(bool $incrementJoinCount = true)

Get a relationship join table hash.

Parameters

bool $incrementJoinCount

Return Value

string

protected array getKeys(array $models, string|null $key = null)

Get all of the primary keys for an array of models.

Parameters

array $models
string|null $key

Return Value

array

protected Builder getRelationQuery()

Get the query builder that will contain the relationship constraints.

Return Value

Builder

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

Builder toBase()

Get a base query builder instance.

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

protected void whereInEager(string $whereIn, string $key, array $modelKeys, Builder $query = null)

Add a whereIn eager constraint for the given set of model keys to be loaded.

Parameters

string $whereIn
string $key
array $modelKeys
Builder $query

Return Value

void

protected string whereInMethod(Model $model, string $key)

Get the name of the "where in" method for eager loading.

Parameters

Model $model
string $key

Return Value

string

static void requireMorphMap(bool $requireMorphMap = true)

Prevent polymorphic relationships from being used without model mappings.

Parameters

bool $requireMorphMap

Return Value

void

static bool requiresMorphMap()

Determine if polymorphic relationships require explicit model mapping.

Return Value

bool

static array enforceMorphMap(array $map, bool $merge = true)

Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.

Parameters

array $map
bool $merge

Return Value

array

static array morphMap(array|null $map = null, bool $merge = true)

Set or get the morph map for polymorphic relations.

Parameters

array|null $map
bool $merge

Return Value

array

static protected array|null buildMorphMapFromModels(array|null $models = null)

Builds a table-keyed array from model class names.

Parameters

array|null $models

Return Value

array|null

static string|null getMorphedModel(string $alias)

Get the model associated with a custom polymorphic type.

Parameters

string $alias

Return Value

string|null

void __clone()

Force a clone of the underlying query builder when cloning.

Return Value

void

bool is(Model|null $model)

Determine if the model is the related instance of the relationship.

Parameters

Model|null $model

Return Value

bool

bool isNot(Model|null $model)

Determine if the model is not the related instance of the relationship.

Parameters

Model|null $model

Return Value

bool

mixed getParentKey()

Get the key value of the child's foreign key.

Return Value

mixed

protected mixed getRelatedKeyFrom(Model $model)

Get the value of the model's associated key.

Parameters

Model $model

Return Value

mixed

protected bool compareKeys(mixed $parentKey, mixed $relatedKey)

Compare the parent key with the related key.

Parameters

mixed $parentKey
mixed $relatedKey

Return Value

bool

protected mixed getDictionaryKey(mixed $attribute)

Get a dictionary key attribute - casting it to a string if necessary.

Parameters

mixed $attribute

Return Value

mixed

Exceptions

InvalidArgumentException

protected Model newRelatedInstanceFor(Model $parent)

Make a new related instance for the given model.

Parameters

Model $parent

Return Value

Model

$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

protected Model|null getDefaultFor(Model $parent)

Get the default value for this relation.

Parameters

Model $parent

Return Value

Model|null

protected array getEagerModelKeys(array $models)

Gather the keys from an array of related models.

Parameters

array $models

Return Value

array

Model associate(Model|int|string|null $model)

Associate the model instance to the given parent.

Parameters

Model|int|string|null $model

Return Value

Model

Model dissociate()

Dissociate previously associated model from the given parent.

Return Value

Model

Model disassociate()

Alias of "dissociate" method.

Return Value

Model

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

protected bool relationHasIncrementingId()

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

Return Value

bool

Model getChild()

Get the child of the relationship.

Return Value

Model

string getForeignKeyName()

Get the foreign key of the relationship.

Return Value

string

string getQualifiedForeignKeyName()

Get the fully qualified foreign key of the relationship.

Return Value

string

string getOwnerKeyName()

Get the associated key of the relationship.

Return Value

string

string getQualifiedOwnerKeyName()

Get the fully qualified associated key of the relationship.

Return Value

string

protected mixed getForeignKeyFrom(Model $model)

Get the value of the model's foreign key.

Parameters

Model $model

Return Value

mixed

string getRelationName()

Get the name of the relationship.

Return Value

string