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

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

Forward a method call to the given object.

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.

from Macroable
static void
mixin(object $mixin)

Mix another object into the class.

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.

getEager()

Get the relationship for eager loading.

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.

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

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

from Relation
getQuery()

Get the underlying query for the relation.

from Relation
getBaseQuery()

Get the base query builder driving the Eloquent builder.

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
string
whereInMethod(Model $model, string $key)

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

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

mixed
update(array $attributes)

Update the parent model on the relationship.

associate(Model|int|string $model)

Associate the model instance to the given parent.

dissociate()

Dissociate previously associated model from the given parent.

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

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

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)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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 $relation)

Create a new belongs to relationship instance.

Parameters

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

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

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

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

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

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

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

mixed update(array $attributes)

Update the parent model on the relationship.

Parameters

array $attributes

Return Value

mixed

Model associate(Model|int|string $model)

Associate the model instance to the given parent.

Parameters

Model|int|string $model

Return Value

Model

Model dissociate()

Dissociate previously associated model from the given parent.

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

string getRelationCountHash()

Get a relationship join table hash.

Return Value

string

protected bool relationHasIncrementingId()

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

Return Value

bool

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

Get the associated key of the relationship.

Return Value

string

string getQualifiedOwnerKeyName()

Get the fully qualified associated key of the relationship.

Return Value

string

string getRelation()

Get the name of the relationship.

Return Value

string