BelongsTo
extends Relation
in package
Uses
SupportsDefaultModels
Tags
Table of Contents
- $morphMap : array<string|int, mixed>
- An array to map class names to their morph names in database.
- $child : mixed
- The child model instance of the relation.
- $constraints : bool
- Indicates if the relation is adding constraints.
- $foreignKey : string
- The foreign key of the parent model.
- $macros : array<string|int, mixed>
- The registered string macros.
- $ownerKey : string
- The associated key on the parent model.
- $parent : Model
- The parent model instance.
- $query : Builder
- The Eloquent query builder instance.
- $related : Model
- The related model instance.
- $relation : string
- The name of the relationship.
- $selfJoinCount : int
- The count of self joins.
- $withDefault : Closure|array<string|int, mixed>|bool
- Indicates if a default model instance should be used.
- __call() : mixed
- Dynamically handle calls to the class.
- __callStatic() : mixed
- Dynamically handle calls to the class.
- __clone() : void
- Force a clone of the underlying query builder when cloning.
- __construct() : void
- Create a new belongs to relationship instance.
- addConstraints() : void
- Set the base constraints on the relation query.
- addEagerConstraints() : void
- Set the constraints for an eager load of the relation.
- associate() : Model
- Associate the model instance to the given parent.
- createdAt() : string
- Get the name of the "created at" column.
- dissociate() : Model
- Dissociate previously associated model from the given parent.
- get() : Collection
- Execute the query as a "select" statement.
- getBaseQuery() : Builder
- Get the base query builder driving the Eloquent builder.
- getEager() : Collection
- Get the relationship for eager loading.
- getForeignKey() : string
- Get the foreign key of the relationship.
- getMorphedModel() : string|null
- Get the model associated with a custom polymorphic type.
- getOwnerKey() : string
- Get the associated key of the relationship.
- getParent() : Model
- Get the parent model of the relation.
- getQualifiedForeignKey() : string
- Get the fully qualified foreign key of the relationship.
- getQualifiedOwnerKeyName() : string
- Get the fully qualified associated key of the relationship.
- getQualifiedParentKeyName() : string
- Get the fully qualified parent key name.
- getQuery() : Builder
- Get the underlying query for the relation.
- getRelated() : Model
- Get the related model of the relation.
- getRelation() : string
- Get the name of the relationship.
- getRelationCountHash() : string
- Get a relationship join table hash.
- getRelationExistenceCountQuery() : Builder
- Add the constraints for a relationship count query.
- getRelationExistenceQuery() : Builder
- Add the constraints for a relationship query.
- getRelationExistenceQueryForSelfRelation() : Builder
- Add the constraints for a relationship query on the same table.
- getResults() : mixed
- Get the results of the relationship.
- hasMacro() : bool
- Checks if macro is registered.
- initRelation() : array<string|int, mixed>
- Initialize the relation on a set of models.
- macro() : void
- Register a custom macro.
- match() : array<string|int, mixed>
- Match the eagerly loaded results to their parents.
- mixin() : void
- Mix another object into the class.
- morphMap() : array<string|int, mixed>
- Set or get the morph map for polymorphic relations.
- noConstraints() : mixed
- Run a callback with constraints disabled on the relation.
- rawUpdate() : int
- Run a raw update against the base query.
- relatedUpdatedAt() : string
- Get the name of the related model's "updated at" column.
- touch() : void
- Touch all of the related models for the relationship.
- update() : mixed
- Update the parent model on the relationship.
- updatedAt() : string
- Get the name of the "updated at" column.
- withDefault() : $this
- Return a new model instance in case the relationship does not exist.
- buildMorphMapFromModels() : array<string|int, mixed>|null
- Builds a table-keyed array from model class names.
- getDefaultFor() : Model|null
- Get the default value for this relation.
- getEagerModelKeys() : array<string|int, mixed>
- Gather the keys from an array of related models.
- getKeys() : array<string|int, mixed>
- Get all of the primary keys for an array of models.
- newRelatedInstanceFor() : Model
- Make a new related instance for the given model.
- relationHasIncrementingId() : bool
- Determine if the related model has an auto-incrementing ID.
Properties
$morphMap
An array to map class names to their morph names in database.
public
static array<string|int, mixed>
$morphMap
= []
$child
The child model instance of the relation.
protected
mixed
$child
$constraints
Indicates if the relation is adding constraints.
protected
static bool
$constraints
= true
$foreignKey
The foreign key of the parent model.
protected
string
$foreignKey
$macros
The registered string macros.
protected
static array<string|int, mixed>
$macros
= []
$ownerKey
The associated key on the parent model.
protected
string
$ownerKey
$parent
The parent model instance.
protected
Model
$parent
$query
The Eloquent query builder instance.
protected
Builder
$query
$related
The related model instance.
protected
Model
$related
$relation
The name of the relationship.
protected
string
$relation
$selfJoinCount
The count of self joins.
protected
static int
$selfJoinCount
= 0
$withDefault
Indicates if a default model instance should be used.
protected
Closure|array<string|int, mixed>|bool
$withDefault
Alternatively, may be a Closure or array.
Methods
__call()
Dynamically handle calls to the class.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
Return values
mixed —__callStatic()
Dynamically handle calls to the class.
public
static __callStatic(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
Return values
mixed —__clone()
Force a clone of the underlying query builder when cloning.
public
__clone() : void
Return values
void —__construct()
Create a new belongs to relationship instance.
public
__construct(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation) : void
Parameters
Return values
void —addConstraints()
Set the base constraints on the relation query.
public
addConstraints() : void
Return values
void —addEagerConstraints()
Set the constraints for an eager load of the relation.
public
addEagerConstraints(array<string|int, mixed> $models) : void
Parameters
- $models : array<string|int, mixed>
Return values
void —associate()
Associate the model instance to the given parent.
public
associate(Model|int|string $model) : Model
Parameters
- $model : Model|int|string
Return values
Model —createdAt()
Get the name of the "created at" column.
public
createdAt() : string
Return values
string —dissociate()
Dissociate previously associated model from the given parent.
public
dissociate() : Model
Return values
Model —get()
Execute the query as a "select" statement.
public
get([array<string|int, mixed> $columns = ['*'] ]) : Collection
Parameters
- $columns : array<string|int, mixed> = ['*']
Return values
Collection —getBaseQuery()
Get the base query builder driving the Eloquent builder.
public
getBaseQuery() : Builder
Return values
Builder —getEager()
Get the relationship for eager loading.
public
getEager() : Collection
Return values
Collection —getForeignKey()
Get the foreign key of the relationship.
public
getForeignKey() : string
Return values
string —getMorphedModel()
Get the model associated with a custom polymorphic type.
public
static getMorphedModel(string $alias) : string|null
Parameters
- $alias : string
Return values
string|null —getOwnerKey()
Get the associated key of the relationship.
public
getOwnerKey() : string
Return values
string —getParent()
Get the parent model of the relation.
public
getParent() : Model
Return values
Model —getQualifiedForeignKey()
Get the fully qualified foreign key of the relationship.
public
getQualifiedForeignKey() : string
Return values
string —getQualifiedOwnerKeyName()
Get the fully qualified associated key of the relationship.
public
getQualifiedOwnerKeyName() : string
Return values
string —getQualifiedParentKeyName()
Get the fully qualified parent key name.
public
getQualifiedParentKeyName() : string
Return values
string —getQuery()
Get the underlying query for the relation.
public
getQuery() : Builder
Return values
Builder —getRelated()
Get the related model of the relation.
public
getRelated() : Model
Return values
Model —getRelation()
Get the name of the relationship.
public
getRelation() : string
Return values
string —getRelationCountHash()
Get a relationship join table hash.
public
getRelationCountHash() : string
Return values
string —getRelationExistenceCountQuery()
Add the constraints for a relationship count query.
public
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery) : Builder
Parameters
Return values
Builder —getRelationExistenceQuery()
Add the constraints for a relationship query.
public
getRelationExistenceQuery(Builder $query, Builder $parentQuery[, array<string|int, mixed>|mixed $columns = ['*'] ]) : Builder
Parameters
Return values
Builder —getRelationExistenceQueryForSelfRelation()
Add the constraints for a relationship query on the same table.
public
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery[, array<string|int, mixed>|mixed $columns = ['*'] ]) : Builder
Parameters
Return values
Builder —getResults()
Get the results of the relationship.
public
getResults() : mixed
Return values
mixed —hasMacro()
Checks if macro is registered.
public
static hasMacro(string $name) : bool
Parameters
- $name : string
Return values
bool —initRelation()
Initialize the relation on a set of models.
public
initRelation(array<string|int, mixed> $models, string $relation) : array<string|int, mixed>
Parameters
- $models : array<string|int, mixed>
- $relation : string
Return values
array<string|int, mixed> —macro()
Register a custom macro.
public
static macro(string $name, object|callable $macro) : void
Parameters
- $name : string
- $macro : object|callable
Return values
void —match()
Match the eagerly loaded results to their parents.
public
match(array<string|int, mixed> $models, Collection $results, string $relation) : array<string|int, mixed>
Parameters
- $models : array<string|int, mixed>
- $results : Collection
- $relation : string
Return values
array<string|int, mixed> —mixin()
Mix another object into the class.
public
static mixin(object $mixin) : void
Parameters
- $mixin : object
Return values
void —morphMap()
Set or get the morph map for polymorphic relations.
public
static morphMap([array<string|int, mixed>|null $map = null ][, bool $merge = true ]) : array<string|int, mixed>
Parameters
- $map : array<string|int, mixed>|null = null
- $merge : bool = true
Return values
array<string|int, mixed> —noConstraints()
Run a callback with constraints disabled on the relation.
public
static noConstraints(Closure $callback) : mixed
Parameters
- $callback : Closure
Return values
mixed —rawUpdate()
Run a raw update against the base query.
public
rawUpdate([array<string|int, mixed> $attributes = [] ]) : int
Parameters
- $attributes : array<string|int, mixed> = []
Return values
int —relatedUpdatedAt()
Get the name of the related model's "updated at" column.
public
relatedUpdatedAt() : string
Return values
string —touch()
Touch all of the related models for the relationship.
public
touch() : void
Return values
void —update()
Update the parent model on the relationship.
public
update(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —updatedAt()
Get the name of the "updated at" column.
public
updatedAt() : string
Return values
string —withDefault()
Return a new model instance in case the relationship does not exist.
public
withDefault([Closure|array<string|int, mixed>|bool $callback = true ]) : $this
Parameters
- $callback : Closure|array<string|int, mixed>|bool = true
Return values
$this —buildMorphMapFromModels()
Builds a table-keyed array from model class names.
protected
static buildMorphMapFromModels([array<string|int, string>|null $models = null ]) : array<string|int, mixed>|null
Parameters
- $models : array<string|int, string>|null = null
Return values
array<string|int, mixed>|null —getDefaultFor()
Get the default value for this relation.
protected
getDefaultFor(Model $parent) : Model|null
Parameters
- $parent : Model
Return values
Model|null —getEagerModelKeys()
Gather the keys from an array of related models.
protected
getEagerModelKeys(array<string|int, mixed> $models) : array<string|int, mixed>
Parameters
- $models : array<string|int, mixed>
Return values
array<string|int, mixed> —getKeys()
Get all of the primary keys for an array of models.
protected
getKeys(array<string|int, mixed> $models[, string $key = null ]) : array<string|int, mixed>
Parameters
- $models : array<string|int, mixed>
- $key : string = null
Return values
array<string|int, mixed> —newRelatedInstanceFor()
Make a new related instance for the given model.
protected
newRelatedInstanceFor(Model $parent) : Model
Parameters
- $parent : Model
Return values
Model —relationHasIncrementingId()
Determine if the related model has an auto-incrementing ID.
protected
relationHasIncrementingId() : bool