Relation
abstract class Relation implements Builder mixin Builder<TRelatedModel> (View source)
Traits
| ForwardsCalls | |
| Macroable |
Properties
| static protected array | $macros | The registered string macros. | from Macroable |
| protected TRelatedModel> | $query | The Eloquent query builder instance. | |
| protected TDeclaringModel | $parent | The parent model instance. | |
| protected TRelatedModel | $related | The related model instance. | |
| protected bool | $eagerKeysWereEmpty | Indicates whether the eagerly loaded relation should implicitly return an empty collection. | |
| static protected bool | $constraints | Indicates if the relation is adding constraints. | |
| static array | $morphMap | An array to map class names to their morph names in the database. | |
| static protected bool | $requireMorphMap | Prevents morph relationships without a morph map. | |
| static protected int | $selfJoinCount | The count of self joins. |
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)
Handle dynamic method calls to the relationship. | |
| void | __construct(Builder $query, Model $parent)
Create a new relation 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. | |
| TDeclaringModel> | initRelation(array $models, string $relation)
Initialize the relation on a set of models. | |
| TDeclaringModel> | match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents. | |
| TResult | getResults()
Get the results of the relationship. | |
| TRelatedModel> | getEager()
Get the relationship for eager loading. | |
| TRelatedModel | sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record. | |
| TRelatedModel> | 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. | |
| TRelatedModel> | getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query. | |
| TRelatedModel> | getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for an internal relationship existence query. | |
| string | getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash. | |
| array<int,int|string> | getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models. | |
| TRelatedModel> | getRelationQuery()
Get the query builder that will contain the relationship constraints. | |
| TRelatedModel> | 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. | |
| TDeclaringModel | getParent()
Get the parent model of the relation. | |
| string | getQualifiedParentKeyName()
Get the fully qualified parent key name. | |
| TRelatedModel | 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. | |
| void | whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)
Add a whereIn eager constraint for the given set of model keys to be loaded. | |
| 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|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations. | |
| static array|null | buildMorphMapFromModels(array|null $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. | |
| static int|string | getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class. | |
| void | __clone()
Force a clone of the underlying query builder when cloning. |
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)
Handle dynamic method calls to the relationship.
static mixed noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
abstract void addConstraints()
Set the base constraints on the relation query.
abstract void addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
abstract TDeclaringModel> initRelation(array $models, string $relation)
Initialize the relation on a set of models.
abstract TDeclaringModel> match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
abstract TResult getResults()
Get the results of the relationship.
TRelatedModel> getEager()
Get the relationship for eager loading.
TRelatedModel sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
TRelatedModel> 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.
TRelatedModel> getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
TRelatedModel> getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])
Add the constraints for an internal relationship existence query.
Essentially, these queries compare on column names like whereColumn.
string getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
protected array<int,int|string> getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
protected TRelatedModel> getRelationQuery()
Get the query builder that will contain the relationship constraints.
TRelatedModel> 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.
TDeclaringModel getParent()
Get the parent model of the relation.
string getQualifiedParentKeyName()
Get the fully qualified parent key name.
TRelatedModel 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|null $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|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
static protected array|null buildMorphMapFromModels(array|null $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.
static int|string getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
void __clone()
Force a clone of the underlying query builder when cloning.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Eloquent/Relations/Relation.html
