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 |
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
Forward a method call to the given object.
Throw a bad method call exception for the given method.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new belongs to relationship instance.
Set the base constraints on the relation query.
Set the constraints for an eager load of the relation.
Initialize the relation on a set of models.
Match the eagerly loaded results to their parents.
Get the results of the relationship.
Add the constraints for a relationship count query.
Add the constraints for a relationship query.
Get all of the primary keys for an array of models.
Set or get the morph map for polymorphic relations.
Builds a table-keyed array from model class names.
Get the model associated with a custom polymorphic type.
Return a new model instance in case the relationship does not exist.
Gather the keys from an array of related models.
Update the parent model on the relationship.
Dissociate previously associated model from the given parent.
Add the constraints for a relationship query on the same table.
Get a relationship join table hash.
Determine if the related model has an auto-incrementing ID.
Get the foreign key of the relationship.
Get the fully qualified foreign key of the relationship.
Get the associated key of the relationship.
Get the fully qualified associated key of the relationship.
Get the name of the relationship.
Details
in ForwardsCalls at line 20
protected mixed
forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
in ForwardsCalls at line 48
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 mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 57
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.
at line 90
void
addConstraints()
Set the base constraints on the relation query.
at line 108
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
at line 151
array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
at line 168
array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
at line 76
mixed
getResults()
Get the results of the relationship.
Collection
getEager()
Get the relationship for eager loading.
Collection
get(array $columns = ['*'])
Execute the query as a "select" statement.
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.
at line 245
Builder
getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query.
protected array
getKeys(array $models, string $key = null)
Get all of the primary keys for an array of models.
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
protected string
whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
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.
at line 304
protected Model
newRelatedInstanceFor(Model $parent)
Make a new related instance for the given model.
in SupportsDefaultModels at line 32
$this
withDefault(Closure|array|bool $callback = true)
Return a new model instance in case the relationship does not exist.
in SupportsDefaultModels at line 45
protected Model|null
getDefaultFor(Model $parent)
Get the default value for this relation.
at line 126
protected array
getEagerModelKeys(array $models)
Gather the keys from an array of related models.
at line 201
mixed
update(array $attributes)
Update the parent model on the relationship.
at line 212
Model
associate(Model|int|string $model)
Associate the model instance to the given parent.
at line 264
Builder
getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for a relationship query on the same table.
at line 282
string
getRelationCountHash()
Get a relationship join table hash.
at line 292
protected bool
relationHasIncrementingId()
Determine if the related model has an auto-incrementing ID.
at line 314
string
getForeignKey()
Get the foreign key of the relationship.
at line 324
string
getQualifiedForeignKey()
Get the fully qualified foreign key of the relationship.
at line 334
string
getOwnerKey()
Get the associated key of the relationship.
at line 344
string
getQualifiedOwnerKeyName()
Get the fully qualified associated key of the relationship.
at line 354
string
getRelation()
Get the name of the relationship.