| Methods |
public
|
relationResolver<TRelatedModel is Model>(class-string<TRelatedModel> $class, string $key): Closure|null
Get the dynamic relation resolver if defined or inherited, or return null.
Get the dynamic relation resolver if defined or inherited, or return null.
|
#
|
public
static
|
resolveRelationUsing(string $name, Closure $callback): void
Define a dynamic relation resolver.
Define a dynamic relation resolver.
|
#
|
public
|
hasOne<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string|null $foreignKey = null,
string|null $localKey = null,
): HasOne<TRelatedModel, $this>
Define a one-to-one relationship.
Define a one-to-one relationship.
|
#
|
protected
|
newHasOne<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string $foreignKey,
string $localKey,
): HasOne<TRelatedModel, TDeclaringModel>
Instantiate a new HasOne relationship.
Instantiate a new HasOne relationship.
|
#
|
public
|
hasOneThrough<TRelatedModel is Model, TIntermediateModel is Model>(
class-string<TRelatedModel> $related,
class-string<TIntermediateModel> $through,
string|null $firstKey = null,
string|null $secondKey = null,
string|null $localKey = null,
string|null $secondLocalKey = null,
): HasOneThrough<TRelatedModel, TIntermediateModel, $this>
Define a has-one-through relationship.
Define a has-one-through relationship.
|
#
|
protected
|
newHasOneThrough<TRelatedModel is Model, TIntermediateModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $farParent,
TIntermediateModel $throughParent,
string $firstKey,
string $secondKey,
string $localKey,
string $secondLocalKey,
): HasOneThrough<TRelatedModel, TIntermediateModel, TDeclaringModel>
Instantiate a new HasOneThrough relationship.
Instantiate a new HasOneThrough relationship.
|
#
|
public
|
morphOne<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string $name,
string|null $type = null,
string|null $id = null,
string|null $localKey = null,
): MorphOne<TRelatedModel, $this>
Define a polymorphic one-to-one relationship.
Define a polymorphic one-to-one relationship.
|
#
|
protected
|
newMorphOne<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string $type,
string $id,
string $localKey,
): MorphOne<TRelatedModel, TDeclaringModel>
Instantiate a new MorphOne relationship.
Instantiate a new MorphOne relationship.
|
#
|
public
|
belongsTo<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string|null $foreignKey = null,
string|null $ownerKey = null,
string|null $relation = null,
): BelongsTo<TRelatedModel, $this>
Define an inverse one-to-one or many relationship.
Define an inverse one-to-one or many relationship.
|
#
|
protected
|
newBelongsTo<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $child,
string $foreignKey,
string $ownerKey,
string $relation,
): BelongsTo<TRelatedModel, TDeclaringModel>
Instantiate a new BelongsTo relationship.
Instantiate a new BelongsTo relationship.
|
#
|
public
|
morphTo(
string|null $name = null,
string|null $type = null,
string|null $id = null,
string|null $ownerKey = null,
): MorphTo<Model, $this>
Define a polymorphic, inverse one-to-one or many relationship.
Define a polymorphic, inverse one-to-one or many relationship.
|
#
|
protected
|
morphEagerTo(string $name, string $type, string $id, string|null $ownerKey): MorphTo<Model, $this>
Define a polymorphic, inverse one-to-one or many relationship.
Define a polymorphic, inverse one-to-one or many relationship.
|
#
|
protected
|
morphInstanceTo(string $target, string $name, string $type, string $id, string|null $ownerKey): MorphTo<Model, $this>
Define a polymorphic, inverse one-to-one or many relationship.
Define a polymorphic, inverse one-to-one or many relationship.
|
#
|
protected
|
newMorphTo<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string $foreignKey,
string|null $ownerKey,
string $type,
string $relation,
): MorphTo<TRelatedModel, TDeclaringModel>
Instantiate a new MorphTo relationship.
Instantiate a new MorphTo relationship.
|
#
|
public
static
|
getActualClassNameForMorph(string $class): string
Retrieve the actual class name for a given morph class.
Retrieve the actual class name for a given morph class.
|
#
|
protected
|
guessBelongsToRelation(): string
Guess the "belongs to" relationship name.
Guess the "belongs to" relationship name.
|
#
|
public
|
through<TIntermediateModel is Model>(
string|HasMany<TIntermediateModel, out $this>|HasOne<TIntermediateModel, out $this> $relationship,
): ($relationship is string ? PendingHasThroughRelationship<Model, $this> : ($relationship is HasMany<TIntermediateModel, $this> ? PendingHasThroughRelationship<TIntermediateModel, $this, HasMany<TIntermediateModel, $this>> : PendingHasThroughRelationship<TIntermediateModel, $this, HasOne<TIntermediateModel, $this>>))
Create a pending has-many-through or has-one-through relationship.
Create a pending has-many-through or has-one-through relationship.
|
#
|
public
|
hasMany<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string|null $foreignKey = null,
string|null $localKey = null,
): HasMany<TRelatedModel, $this>
Define a one-to-many relationship.
Define a one-to-many relationship.
|
#
|
protected
|
newHasMany<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string $foreignKey,
string $localKey,
): HasMany<TRelatedModel, TDeclaringModel>
Instantiate a new HasMany relationship.
Instantiate a new HasMany relationship.
|
#
|
public
|
hasManyThrough<TRelatedModel is Model, TIntermediateModel is Model>(
class-string<TRelatedModel> $related,
class-string<TIntermediateModel> $through,
string|null $firstKey = null,
string|null $secondKey = null,
string|null $localKey = null,
string|null $secondLocalKey = null,
): HasManyThrough<TRelatedModel, TIntermediateModel, $this>
Define a has-many-through relationship.
Define a has-many-through relationship.
|
#
|
protected
|
newHasManyThrough<TRelatedModel is Model, TIntermediateModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $farParent,
TIntermediateModel $throughParent,
string $firstKey,
string $secondKey,
string $localKey,
string $secondLocalKey,
): HasManyThrough<TRelatedModel, TIntermediateModel, TDeclaringModel>
Instantiate a new HasManyThrough relationship.
Instantiate a new HasManyThrough relationship.
|
#
|
public
|
morphMany<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string $name,
string|null $type = null,
string|null $id = null,
string|null $localKey = null,
): MorphMany<TRelatedModel, $this>
Define a polymorphic one-to-many relationship.
Define a polymorphic one-to-many relationship.
|
#
|
protected
|
newMorphMany<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string $type,
string $id,
string $localKey,
): MorphMany<TRelatedModel, TDeclaringModel>
Instantiate a new MorphMany relationship.
Instantiate a new MorphMany relationship.
|
#
|
public
|
belongsToMany<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string|class-string<Model>|null $table = null,
string|null $foreignPivotKey = null,
string|null $relatedPivotKey = null,
string|null $parentKey = null,
string|null $relatedKey = null,
string|null $relation = null,
): BelongsToMany<TRelatedModel, $this, Pivot>
Define a many-to-many relationship.
Define a many-to-many relationship.
|
#
|
protected
|
newBelongsToMany<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string|class-string<Model> $table,
string $foreignPivotKey,
string $relatedPivotKey,
string $parentKey,
string $relatedKey,
string|null $relationName = null,
): BelongsToMany<TRelatedModel, TDeclaringModel, Pivot>
Instantiate a new BelongsToMany relationship.
Instantiate a new BelongsToMany relationship.
|
#
|
public
|
morphToMany<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string $name,
string|null $table = null,
string|null $foreignPivotKey = null,
string|null $relatedPivotKey = null,
string|null $parentKey = null,
string|null $relatedKey = null,
string|null $relation = null,
bool $inverse = false,
): MorphToMany<TRelatedModel, $this>
Define a polymorphic many-to-many relationship.
Define a polymorphic many-to-many relationship.
|
#
|
protected
|
newMorphToMany<TRelatedModel is Model, TDeclaringModel is Model>(
Builder<TRelatedModel> $query,
TDeclaringModel $parent,
string $name,
string $table,
string $foreignPivotKey,
string $relatedPivotKey,
string $parentKey,
string $relatedKey,
string|null $relationName = null,
bool $inverse = false,
): MorphToMany<TRelatedModel, TDeclaringModel>
Instantiate a new MorphToMany relationship.
Instantiate a new MorphToMany relationship.
|
#
|
public
|
morphedByMany<TRelatedModel is Model>(
class-string<TRelatedModel> $related,
string $name,
string|null $table = null,
string|null $foreignPivotKey = null,
string|null $relatedPivotKey = null,
string|null $parentKey = null,
string|null $relatedKey = null,
string|null $relation = null,
): MorphToMany<TRelatedModel, $this>
Define a polymorphic, inverse many-to-many relationship.
Define a polymorphic, inverse many-to-many relationship.
|
#
|
protected
|
guessBelongsToManyRelation(): string|null
Get the relationship name of the belongsToMany relationship.
Get the relationship name of the belongsToMany relationship.
|
#
|
public
|
joiningTable(string $related, Model|null $instance = null): string
Get the joining table name for a many-to-many relation.
Get the joining table name for a many-to-many relation.
|
#
|
public
|
joiningTableSegment(): string
Get this model's half of the intermediate table name for belongsToMany relationships.
Get this model's half of the intermediate table name for belongsToMany relationships.
|
#
|
public
|
touches(string $relation): bool
Determine if the model touches a given relation.
Determine if the model touches a given relation.
|
#
|
public
|
touchOwners(): void
Touch the owning relations of the model.
Touch the owning relations of the model.
|
#
|
protected
|
getMorphs(string $name, string $type, string $id): array
Get the polymorphic relationship columns.
Get the polymorphic relationship columns.
|
#
|
public
|
getMorphClass(): string
Get the class name for polymorphic relations.
Get the class name for polymorphic relations.
|
#
|
protected
|
newRelatedInstance<TRelatedModel is Model>(class-string<TRelatedModel> $class): TRelatedModel
Create a new model instance for a related model.
Create a new model instance for a related model.
|
#
|
protected
|
newRelatedThroughInstance<TRelatedModel is Model>(class-string<TRelatedModel> $class): TRelatedModel
Create a new model instance for a related "through" model.
Create a new model instance for a related "through" model.
|
#
|
public
|
getRelations(): array
Get all the loaded relations for the instance.
Get all the loaded relations for the instance.
|
#
|
public
|
getRelation(string $relation): mixed
Get a specified relationship.
Get a specified relationship.
|
#
|
public
|
relationLoaded(string $key): bool
Determine if the given relation is loaded.
Determine if the given relation is loaded.
|
#
|
public
|
setRelation(string $relation, mixed $value): $this
Set the given relationship on the model.
Set the given relationship on the model.
|
#
|
public
|
unsetRelation(string $relation): $this
Unset a loaded relationship.
Unset a loaded relationship.
|
#
|
public
|
setRelations(array $relations): $this
Set the entire relations array on the model.
Set the entire relations array on the model.
|
#
|
public
|
withoutRelations(): $this
Duplicate the instance and unset all the loaded relations.
Duplicate the instance and unset all the loaded relations.
|
#
|
public
|
unsetRelations(): $this
Unset all the loaded relations for the instance.
Unset all the loaded relations for the instance.
|
#
|
public
|
getTouchedRelations(): array
Get the relationships that are touched on save.
Get the relationships that are touched on save.
|
#
|
public
|
setTouchedRelations(array $touches): $this
Set the relationships that are touched on save.
Set the relationships that are touched on save.
|
#
|