BelongsTo
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 |
| protected Model | $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. |
from ForwardsCalls |
| mixed | forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Forward a method call to the given object, returning $this if the forwarded call returned itself. |
from ForwardsCalls |
| static void | throwBadMethodCallException(string $method) Throw a bad method call exception for the given method. |
from ForwardsCalls |
| static void | macro(string $name, object|callable $macro) Register a custom macro. |
from Macroable |
| static void | mixin(object $mixin, bool $replace = true) Mix another object into the class. |
from Macroable |
| static bool | hasMacro(string $name) Checks if macro is registered. |
from Macroable |
| static void | flushMacros() Flush the existing macros. |
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 $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. |
|
| Collection | getEager() Get the relationship for eager loading. |
from Relation |
| Model | sole(array|string $columns = ['*']) Execute the query and get the first result if it's the sole matching record. |
from Relation |
| Collection | 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 |
| 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. |
|
| 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 |
| Builder | getRelationQuery() Get the query builder that will contain the relationship constraints. |
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 |
| Builder | toBase() Get a base query builder instance. |
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 |
| 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 $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 |
| bool | is(Model|null $model) Determine if the model is the related instance of the relationship. |
from ComparesRelatedModels |
| bool | isNot(Model|null $model) Determine if the model is not the related instance of the relationship. |
from ComparesRelatedModels |
| 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. |
from ComparesRelatedModels |
| mixed | getDictionaryKey(mixed $attribute) Get a dictionary key attribute - casting it to a string if necessary. |
from InteractsWithDictionary |
| 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. |
|
| Model | associate(Model|int|string|null $model) Associate the model instance to the given parent. |
|
| Model | dissociate() Dissociate previously associated model from the given parent. |
|
| Model | disassociate() Alias of "dissociate" method. |
|
| Builder | 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. |
|
| Model | 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.
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.
static protected 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.
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.
Model sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
Collection get(array $columns = ['*'])
Execute the query as a "select" statement.
void touch()
Touch all of the related models for the relationship.
int rawUpdate(array $attributes = [])
Run a raw update against the base query.
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
Builder 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.
protected array getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
protected Builder getRelationQuery()
Get the query builder that will contain the relationship constraints.
Builder getQuery()
Get the underlying query for the relation.
Builder getBaseQuery()
Get the base query builder driving the Eloquent builder.
Builder toBase()
Get a base query builder instance.
Model getParent()
Get the parent model of the relation.
string getQualifiedParentKeyName()
Get the fully qualified parent key name.
Model getRelated()
Get the related model of the relation.
string createdAt()
Get the name of the "created at" column.
string updatedAt()
Get the name of the "updated at" column.
string relatedUpdatedAt()
Get the name of the related model's "updated at" column.
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.
protected string whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
static void requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings.
static bool requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
static array enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
static array morphMap(array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array $models = null)
Builds a table-keyed array from model class names.
static string|null getMorphedModel(string $alias)
Get the model associated with a custom polymorphic type.
void __clone()
Force a clone of the underlying query builder when cloning.
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.
protected mixed getRelatedKeyFrom(Model $model)
Get the value of the model's associated key.
protected bool compareKeys(mixed $parentKey, mixed $relatedKey)
Compare the parent key with the related key.
protected mixed getDictionaryKey(mixed $attribute)
Get a dictionary key attribute - casting it to a string if necessary.
protected 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.
protected array getEagerModelKeys(array $models)
Gather the keys from an array of related models.
Model dissociate()
Dissociate previously associated model from the given parent.
Model disassociate()
Alias of "dissociate" method.
Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
protected bool relationHasIncrementingId()
Determine if the related model has an auto-incrementing ID.
Model 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.
protected mixed getForeignKeyFrom(Model $model)
Get the value of the model's foreign key.
string getRelationName()
Get the name of the relationship.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Eloquent/Relations/BelongsTo.html