Class Salient\Sync\Support\DeferredRelationship

`final`
`implements`	`DeferredRelationshipInterface<TEntity>`


					
	public

getIterator(): Traversable

Implements

IteratorAggregate::getIterator()

#


					
	public

resolve(): array

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()}.

Implements

Salient\Contract\Sync\DeferredRelationshipInterface::resolve()

#


					
	public

replace(array $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.

Implements

Salient\Contract\Sync\DeferredRelationshipInterface::replace()

#


					
	public
					static

defer(
	SyncProviderInterface $provider,
	?SyncContextInterface $context,
	string $entity,
	string $forEntity,
	string $forEntityProperty,
	$forEntityId,
	?array $filter = null,
	&$replace = null,
	?Closure $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.

Implements

Salient\Contract\Sync\DeferredRelationshipInterface::defer()

#


					
	public

getContext(): ?SyncContextInterface

Get the context within which the provider is servicing the entity

Implements

Salient\Contract\Sync\DeferredRelationshipInterface::getContext()

#

Namespaces

Classes

Class Salient\Sync\Support\DeferredRelationship

`<TEntity is SyncEntityInterface>`

Implements

Implements

Implements

Parameters

Implements

Implements