BelongsTo
class BelongsTo extends Relation (View source)
Properties
| 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 |
| protected string | $foreignKey | The foreign key of the parent model. |
|
| protected string | $otherKey | The associated key on the parent model. |
|
| protected string | $relation | The name of the relationship. |
Methods
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.
Get all of the primary keys for an array of models.
Handle dynamic method calls to the relationship.
Gather the keys from an array of related models.
Dissociate previously associated model from the given parent.
Update the parent model on the relationship.
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.
Details
void
__construct(Builder $query, Model $parent, string $foreignKey, string $otherKey, string $relation)
Create a new belongs to relationship instance.
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
getRelationCountQuery(Builder $query, Builder $parent)
Add the constraints for a relationship count query.
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
protected array
getKeys(array $models, string $key = null)
Get all of the primary keys for an array of models.
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.
string
wrap(string $value)
Wrap the given value with the parent query's grammar.
mixed
__call(string $method, array $parameters)
Handle dynamic method calls to the relationship.
protected array
getEagerModelKeys(array $models)
Gather the keys from an array of related models.
Model
dissociate()
Dissociate previously associated model from the given parent.
mixed
update(array $attributes)
Update the parent model on the relationship.
string
getForeignKey()
Get the foreign key of the relationship.
string
getQualifiedForeignKey()
Get the fully qualified foreign key of the relationship.
string
getOtherKey()
Get the associated key of the relationship.
string
getQualifiedOtherKeyName()
Get the fully qualified associated key of the relationship.