| Methods |
public
|
__construct(Builder<TRelatedModel> $query, TDeclaringModel $parent): void
Create a new relation instance.
Create a new relation instance.
Overriden by
|
#
|
public
static
|
noConstraints<TReturn is mixed>(Closure(): TReturn $callback): TReturn
Run a callback with constraints disabled on the relation.
Run a callback with constraints disabled on the relation.
|
#
|
abstract
public
|
addConstraints(): void
Set the base constraints on the relation query.
Set the base constraints on the relation query.
Implemented by
|
#
|
abstract
public
|
addEagerConstraints(array<int, TDeclaringModel> $models): void
Set the constraints for an eager load of the relation.
Set the constraints for an eager load of the relation.
Implemented by
|
#
|
abstract
public
|
initRelation(array<int, TDeclaringModel> $models, string $relation): array<int, TDeclaringModel>
Initialize the relation on a set of models.
Initialize the relation on a set of models.
Implemented by
|
#
|
abstract
public
|
match(
array<int, TDeclaringModel> $models,
Collection<int, TRelatedModel> $results,
string $relation,
): array<int, TDeclaringModel>
Match the eagerly loaded results to their parents.
Match the eagerly loaded results to their parents.
Implemented by
|
#
|
abstract
public
|
getResults(): TResult
Get the results of the relationship.
Get the results of the relationship.
Implemented by
|
#
|
public
|
getEager(): Collection<int, TRelatedModel>
Get the relationship for eager loading.
Get the relationship for eager loading.
Overriden by
|
#
|
public
|
sole(array|string $columns = ['*']): TRelatedModel
Execute the query and get the first result if it's the sole matching record.
Execute the query and get the first result if it's the sole matching record.
Throws
|
#
|
public
|
get(array $columns = ['*']): Collection<int, TRelatedModel>
Execute the query as a "select" statement.
Execute the query as a "select" statement.
Overriden by
|
#
|
public
|
touch(): void
Touch all of the related models for the relationship.
Touch all of the related models for the relationship.
Overriden by
|
#
|
public
|
rawUpdate(array $attributes = []): int
Run a raw update against the base query.
Run a raw update against the base query.
|
#
|
public
|
getRelationExistenceCountQuery(
Builder<TRelatedModel> $query,
Builder<TDeclaringModel> $parentQuery,
): Builder<TRelatedModel>
Add the constraints for a relationship count query.
Add the constraints for a relationship count query.
|
#
|
public
|
getRelationExistenceQuery(
Builder<TRelatedModel> $query,
Builder<TDeclaringModel> $parentQuery,
array|mixed $columns = ['*'],
): Builder<TRelatedModel>
Add the constraints for an internal relationship existence query.
Add the constraints for an internal relationship existence query.
Essentially, these queries compare on column names like whereColumn.
Overriden by
|
#
|
public
|
getRelationCountHash(bool $incrementJoinCount = true): string
Get a relationship join table hash.
Get a relationship join table hash.
|
#
|
protected
|
getKeys(array<int, TDeclaringModel> $models, string|null $key = null): array<int, int|string|null>
Get all of the primary keys for an array of models.
Get all of the primary keys for an array of models.
|
#
|
protected
|
getRelationQuery(): Builder<TRelatedModel>
Get the query builder that will contain the relationship constraints.
Get the query builder that will contain the relationship constraints.
|
#
|
public
|
getQuery(): Builder<TRelatedModel>
Get the underlying query for the relation.
Get the underlying query for the relation.
|
#
|
public
|
getBaseQuery(): Builder
Get the base query builder driving the Eloquent builder.
Get the base query builder driving the Eloquent builder.
|
#
|
public
|
toBase(): Builder
Get a base query builder instance.
Get a base query builder instance.
|
#
|
public
|
getParent(): TDeclaringModel
Get the parent model of the relation.
Get the parent model of the relation.
|
#
|
public
|
getQualifiedParentKeyName(): string
Get the fully qualified parent key name.
Get the fully qualified parent key name.
Overriden by
|
#
|
public
|
getRelated(): TRelatedModel
Get the related model of the relation.
Get the related model of the relation.
|
#
|
public
|
createdAt(): string
Get the name of the "created at" column.
Get the name of the "created at" column.
Overriden by
|
#
|
public
|
updatedAt(): string
Get the name of the "updated at" column.
Get the name of the "updated at" column.
Overriden by
|
#
|
public
|
relatedUpdatedAt(): string
Get the name of the related model's "updated at" column.
Get the name of the related model's "updated at" column.
|
#
|
protected
|
whereInEager(string $whereIn, string $key, array $modelKeys, Builder<TRelatedModel>|null $query = null): void
Add a whereIn eager constraint for the given set of model keys to be loaded.
Add a whereIn eager constraint for the given set of model keys to be loaded.
|
#
|
protected
|
whereInMethod(Model $model, string $key): string
Get the name of the "where in" method for eager loading.
Get the name of the "where in" method for eager loading.
|
#
|
public
static
|
requireMorphMap(bool $requireMorphMap = true): void
Prevent polymorphic relationships from being used without model mappings.
Prevent polymorphic relationships from being used without model mappings.
|
#
|
public
static
|
requiresMorphMap(): bool
Determine if polymorphic relationships require explicit model mapping.
Determine if polymorphic relationships require explicit model mapping.
|
#
|
public
static
|
enforceMorphMap(array<string, class-string<Model>> $map, bool $merge = true): array
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
|
#
|
public
static
|
morphMap(array<string, class-string<Model>>|null $map = null, bool $merge = true): array<string, class-string<Model>>
Set or get the morph map for polymorphic relations.
Set or get the morph map for polymorphic relations.
|
#
|
protected
static
|
buildMorphMapFromModels(list<class-string<Model>>|null $models = null): array<string, class-string<Model>>|null
Builds a table-keyed array from model class names.
Builds a table-keyed array from model class names.
|
#
|
public
static
|
getMorphedModel(string $alias): class-string<Model>|null
Get the model associated with a custom polymorphic type.
Get the model associated with a custom polymorphic type.
|
#
|
public
static
|
getMorphAlias(class-string<Model> $className): int|string
Get the alias associated with a custom polymorphic class.
Get the alias associated with a custom polymorphic class.
|
#
|
public
|
__call(string $method, array $parameters): mixed
Handle dynamic method calls to the relationship.
Handle dynamic method calls to the relationship.
Overriden by
|
#
|
public
|
__clone(): void
Force a clone of the underlying query builder when cloning.
Force a clone of the underlying query builder when cloning.
|
#
|