SiblingsRelation
class SiblingsRelation extends BaseRelation
Traits
Constants
| protected CONSTRAINTS_CONTEXT_KEY |
The context key for storing whether constraints are enabled. |
| protected NESTED_CONSTRAINTS_CONTEXT_KEY |
The context key for enabling constraints on nested relation attributes. |
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected QueryBuilder | $query | The nested-set query builder instance. |
from BaseRelation |
| protected TDeclaringModel | $parent | The parent model instance. |
from Relation |
| protected TRelatedModel | $related | The related model instance. |
from Relation |
| protected bool | $eagerKeysWereEmpty | Indicates whether the eagerly loaded relation should implicitly return an empty collection. |
from Relation |
| static array<int|Model>> | $morphMap | An array to map morph names to their class names in the database. |
from Relation |
| static protected bool | $requireMorphMap | Prevents morph relationships without a morph map. |
from Relation |
| static protected int | $selfJoinCount | The count of self joins. |
from Relation |
| protected bool | $andSelf | Whether to include the parent node itself. |
Methods
Forward a method call to the given object.
Forward a method call to the given object, returning $this if the forwarded call returned itself.
Throw a bad method call exception for the given method.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new sibling relation.
Run a callback without constraints while preserving them for nested relation attributes.
Run a callback with the configured relation constraints.
Run a callback with constraints when resolving a nested relation attribute.
Determine if constraints should be added to the relation query.
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.
Execute the query and get the first result if it's the sole matching record.
Add the constraints for a relationship count query.
Get the relation existence query.
Get a relationship join table hash.
Get all of the primary keys for an array of models.
Get the query builder that will contain the relationship constraints.
Add a whereIn eager constraint for the given set of model keys to be loaded.
Prevent polymorphic relationships from being used without model mappings.
Determine if polymorphic relationships require explicit model mapping.
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
Set or get the morph map for polymorphic relations.
Build a table-keyed array from model class names.
Get the model associated with a custom polymorphic type.
Get the alias associated with a custom polymorphic class.
Apply an eager constraint for one parent model.
Get the sibling relation existence condition.
Group eager constraints by exact scope and parent.
Deduplicate the parent models used to constrain an eager query.
Prepare the lazy parent or constrain an unsaved parent to no results.
Ensure a persisted relation model contains its required projection.
Determine whether eager results should be indexed by tree scope.
Index eager results by exact scope and parent while preserving query order.
Details
in
ForwardsCalls at line 22
protected mixed
forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
in
ForwardsCalls at line 52
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.
in
ForwardsCalls at line 66
static protected never
throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
in
Macroable at line 28
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 41
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 57
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 68
static void
flushMacros()
Flush the existing macros.
Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 78
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 103
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 20
__construct(QueryBuilder $builder, Model $model, bool $andSelf = false)
Create a new sibling relation.
in
Relation at line 110
static mixed
noConstraints(Closure $callback)
Run a callback with constraints disabled on the relation.
in
Relation at line 123
static mixed
noConstraintsForRelation(Closure $callback)
Run a callback without constraints while preserving them for nested relation attributes.
in
Relation at line 136
static protected mixed
withoutConstraints(Closure $callback, bool $constraintsForNestedRelations)
Run a callback with the configured relation constraints.
in
Relation at line 163
static mixed
withConstraints(Closure $callback)
Run a callback with constraints enabled on the relation.
in
Relation at line 184
static mixed
withConstraintsForNestedRelation(Closure $callback)
Run a callback with constraints when resolving a nested relation attribute.
in
Relation at line 194
static bool
shouldAddConstraints()
Determine if constraints should be added to the relation query.
at line 30
void
addConstraints()
Set the base constraints on the relation query.
in
BaseRelation at line 145
void
addEagerConstraints(array $models)
Set the constraints for an eager load of the relation.
in
BaseRelation at line 117
array
initRelation(array $models, string $relation)
Initialize the relation on a set of models.
in
BaseRelation at line 168
array
match(array $models, Collection $results, string $relation)
Match the eagerly loaded results to their parents.
in
BaseRelation at line 133
TResult
getResults()
Get the results of the relationship.
in
Relation at line 240
Collection
getEager()
Get the relationship for eager loading.
in
Relation at line 255
Model
sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
in
Relation at line 277
Collection
get(array $columns = ['*'])
Execute the query as a "select" statement.
in
Relation at line 285
void
touch()
Touch all of the related models for the relationship.
in
Relation at line 299
int
rawUpdate(array $attributes = [])
Run a raw update against the base query.
in
Relation at line 311
Builder
getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
Add the constraints for a relationship count query.
in
BaseRelation at line 69
Builder
getRelationExistenceQuery(Builder $query, Builder $parentQuery, mixed $columns = ['*'])
Get the relation existence query.
in
BaseRelation at line 125
string
getRelationCountHash(bool $incrementJoinCount = true)
Get a relationship join table hash.
in
Relation at line 354
protected array
getKeys(array $models, string|null $key = null)
Get all of the primary keys for an array of models.
in
Relation at line 366
protected Builder
getRelationQuery()
Get the query builder that will contain the relationship constraints.
in
Relation at line 384
Builder
getBaseQuery()
Get the base query builder driving the Eloquent builder.
in
Relation at line 410
string
getQualifiedParentKeyName()
Get the fully-qualified parent key name.
in
Relation at line 430
string
getRelatedClass()
Get the class name of the related model.
in
Relation at line 438
string
createdAt()
Get the name of the "created at" column.
in
Relation at line 446
string
updatedAt()
Get the name of the "updated at" column.
in
Relation at line 454
string
relatedUpdatedAt()
Get the name of the related model's "updated at" column.
in
Relation at line 464
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.
in
Relation at line 476
protected string
whereInMethod(Model $model, string $key)
Get the name of the "where in" method for eager loading.
in
Relation at line 490
static void
requireMorphMap(bool $requireMorphMap = true)
Prevent polymorphic relationships from being used without model mappings.
Boot-only. The flag persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.
in
Relation at line 498
static bool
requiresMorphMap()
Determine if polymorphic relationships require explicit model mapping.
in
Relation at line 512
static array
enforceMorphMap(array $map, bool $merge = true)
Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
Boot-only. Sets both worker-wide morph state (requireMorphMap + morphMap) shared by every coroutine.
in
Relation at line 529
static array
morphMap(array|null $map = null, bool $merge = true)
Set or get the morph map for polymorphic relations.
Boot-only when setting. The map persists in a static property for the worker lifetime and applies to every polymorphic resolution across all coroutines.
in
Relation at line 548
static protected array|null
buildMorphMapFromModels(array|null $models = null)
Build a table-keyed array from model class names.
in
Relation at line 564
static string|null
getMorphedModel(int|string|null $alias)
Get the model associated with a custom polymorphic type.
in
Relation at line 578
static int|string
getMorphAlias(string $className)
Get the alias associated with a custom polymorphic class.
in
Relation at line 588
static void
flushState()
Flush all static state.
in
Relation at line 611
void
__clone()
Force a clone of the underlying query builder when cloning.
at line 125
protected bool
matches(Model $model, Model $related)
Determine whether a result is a sibling of the parent model.
at line 56
protected void
addEagerConstraint(QueryBuilder $query, Model $model)
Apply an eager constraint for one parent model.
at line 237
protected string
relationExistenceCondition(string $hash, string $table, string $lft, string $rgt)
Get the sibling relation existence condition.
at line 206
protected array
requiredParentColumns(Model $model)
Get the parent columns required to resolve siblings.
at line 214
protected array
requiredRelatedColumns(Model $model)
Get the related columns required to match siblings.
in
BaseRelation at line 206
protected Collection
matchForModel(Model $model, Collection $results)
Match query results for one parent.
at line 76
protected void
constrainEagerModels(QueryBuilder $query, array $models)
Group eager constraints by exact scope and parent.
in
BaseRelation at line 232
protected array
prepareEagerModels(array $models)
Deduplicate the parent models used to constrain an eager query.
in
BaseRelation at line 277
protected bool
prepareLazyParent()
Prepare the lazy parent or constrain an unsaved parent to no results.
in
BaseRelation at line 297
protected void
ensureProjection(Model $model, array $columns, string $context)
Ensure a persisted relation model contains its required projection.
in
BaseRelation at line 318
protected bool
shouldIndexResults(array $models)
Determine whether eager results should be indexed by tree scope.
at line 151
protected array
indexResults(Collection $results)
Index eager results by exact scope and parent while preserving query order.
at line 172
protected Collection
matchFromIndex(Model $model, array $indexed)
Match siblings from an exact scope-and-parent bucket.
in
BaseRelation at line 361
protected array
scopeValues(Model $model)
Get the normalized nested-set scope values for a node.
in
BaseRelation at line 369
protected string
scopeKey(Model $model)
Get the stable identity key for a node's nested-set scope.
in
BaseRelation at line 377
string
getForeignKeyName()
Get the plain foreign key.
in
BaseRelation at line 385
string
getQualifiedForeignKeyName()
Get the qualified foreign key name.
at line 222
protected array
siblingColumns(Model $model)
Get the complete sibling bucket projection.
at line 256
protected void
whereParentId(QueryBuilder $query, Model $model)
Constrain a query to the model's parent ID.