BelongsTo (Database\Eloquent\Relations)
BelongsTo
class BelongsTo extends Relation (View source)
Traits
Macroable |
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 = array()) 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 = array('*')) Add the constraints for a relationship query. | |
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 |
void | __clone() Force a clone of the underlying query builder when cloning. | from Relation |
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 = array('*')) Add the constraints for a relationship query on the same table. | |
string | getRelationCountHash() Get a relationship join table hash. | |
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
static void macro(string $name, callable $macro)
Register a custom macro.
static bool hasMacro(string $name)
Checks if macro is registered.
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 $relation)
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.
void touch()
Touch all of the related models for the relationship.
int rawUpdate(array $attributes = array())
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 = array('*'))
Add the constraints for a relationship query.
Builder getQuery()
Get the underlying query for the relation.
Builder getBaseQuery()
Get the base query builder driving the Eloquent builder.
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.
static array morphMap(array $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
void __clone()
Force a clone of the underlying query builder when cloning.
mixed update(array $attributes)
Update the parent model on the relationship.
Model dissociate()
Dissociate previously associated model from the given parent.
Builder getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = array('*'))
Add the constraints for a relationship query on the same table.
string getRelationCountHash()
Get a relationship join table hash.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Database/Eloquent/Relations/BelongsTo.html