Interface Salient\Contract\Sync\DeferredRelationshipInterface

`<TEntity is SyncEntityInterface>`

`extends`	`IteratorAggregate<array-key, TEntity>`

Salient\Contract\Sync\DeferredRelationshipInterface extends IteratorAggregate<array-key, TEntity>
- Salient\Sync\Support\DeferredRelationship implements DeferredRelationshipInterface<TEntity>

Located at Toolkit/Contract/Sync/DeferredRelationshipInterface.php

Methods


					
	public

getContext(): ?SyncContextInterface

Get the context within which the provider is servicing the entity

Implemented by

Salient\Sync\Support\DeferredRelationship::getContext()


					
	public

resolve(): TEntity[]

Resolve the deferred relationship from the provider or the local entity store

Calling this method has the same effect as passing the resolved entities to {@see DeferredRelationshipInterface::replace()}.

Implemented by

Salient\Sync\Support\DeferredRelationship::resolve()


					
	public

replace(TEntity[] $entities): void

Resolve the deferred relationship with a list of entity instances

If $callback was given when the relationship was deferred, it is called with the given entities, otherwise the variable or property given via $replace is replaced.

Subsequent calls to {@see DeferredRelationshipInterface::resolve()} return the same instances.

Implemented by

Salient\Sync\Support\DeferredRelationship::replace()


					
	public
					static

defer(
	SyncProviderInterface $provider,
	SyncContextInterface|null $context,
	class-string<TEntity> $entity,
	class-string<SyncEntityInterface> $forEntity,
	string $forEntityProperty,
	int|string $forEntityId,
	array<string, mixed>|null $filter = null,
	TEntity[]|static|null &$replace = null,
	(Closure(TEntity[]): void)|null $callback = null,
): void

Defer retrieval of a sync entity relationship

Parameters

`$provider`	The provider servicing the entity.
`$context`	The context within which the provider is servicing the entity.
`$entity`	The entity to instantiate.
`$forEntity`	The entity for which the relationship is deferred.
`$forEntityProperty`	The entity property for which the relationship is deferred.
`$forEntityId`	The identifier of the entity for which the relationship is deferred.
`$filter`	Overrides the default filter passed to the provider when requesting entities.
`$replace`	Refers to the variable or property to replace when the relationship is resolved.
`$callback`	If given, `$replace` is ignored and the resolved entities are passed to the callback.

Implemented by

Salient\Sync\Support\DeferredRelationship::defer()

Methods inherited from IteratorAggregate
`getIterator()`

Namespaces

Interfaces

Interface Salient\Contract\Sync\DeferredRelationshipInterface

`<TEntity is SyncEntityInterface>`

Implemented by

Implemented by

Implemented by

Parameters

Implemented by