Class Salient\Sync\Http\HttpSyncDefinition

`<TEntity is SyncEntityInterface, TProvider is HttpSyncProvider>`

`final`
`extends`	`AbstractSyncDefinition<TEntity, TProvider>`
`implements`	`Buildable<HttpSyncDefinitionBuilder<TEntity, TProvider>>`
`uses`	`BuildableTrait, ImmutableTrait`

Generates closures that use an HttpSyncProvider to perform sync operations on an entity

Override {@see HttpSyncProvider::buildHttpDefinition()} to service HTTP endpoints declaratively via {@see HttpSyncDefinition} objects.

If more than one implementation of a sync operation is available for an entity, the order of precedence is as follows:

The callback in {@see AbstractSyncDefinition::$Overrides} for the operation
The provider method declared for the operation, e.g. Provider::getFaculties() or Provider::createUser()
The closure returned by {@see AbstractSyncDefinition::getClosure()} for the operation

If no implementations are found, {@see SyncOperationNotImplementedException} is thrown.

Salient\Sync\AbstractSyncDefinition implements SyncDefinitionInterface<TEntity, TProvider>, Chainable, Readable uses ChainableTrait, ImmutableTrait, ReadableTrait
- Salient\Sync\Http\HttpSyncDefinition implements Buildable<HttpSyncDefinitionBuilder<TEntity, TProvider>> uses BuildableTrait, ImmutableTrait

Type aliases
`OverrideClosure`	`(Closure(static, SyncOperation::, SyncContextInterface, int\|string\|null, mixed...): TEntity)\|(Closure(static, SyncOperation::, SyncContextInterface, mixed...): iterable<array-key, TEntity>)\|(Closure(static, SyncOperation::, SyncContextInterface, TEntity, mixed...): TEntity)\|(Closure(static, SyncOperation::, SyncContextInterface, iterable<TEntity>, mixed...): iterable<array-key, TEntity>)`	#

Methods


					
	public

withPath(string[]|string|null $path): static

Get an instance with the given endpoint path or paths, e.g. "/v1/user"


					
	public

withQuery(mixed[]|null $query): static

Get an instance that applies the given query parameters to the sync operation URL


					
	public

withHeaders(?HttpHeadersInterface $headers): static

Get an instance that applies the given HTTP headers to sync operation requests


					
	public

withPager(?CurlerPagerInterface $pager, bool $alwaysPaginate = false): static

Get an instance with the given pagination handler

Parameters

$alwaysPaginate

If true, the pager is used to process requests even if no pagination is required.


					
	public

withExpiry(int<-1, max>|null $expiry): static

Get an instance where cached responses expire after the given number of seconds

Parameters

$expiry

null: do not cache responses
0: cache responses indefinitely
-1 (default): use the value returned by {@see HttpSyncProvider::getExpiry()}


					
	public

withMethodMap(array<SyncOperation::*, HttpRequestMethod::*> $methodMap): static

Get an instance that maps sync operations to the given HTTP request methods


					
	public

withCurlerCallback(
	(callable(CurlerInterface, HttpSyncDefinition<TEntity, TProvider>, SyncOperation::*, SyncContextInterface, mixed...): CurlerInterface)|null $callback,
): static

Get an instance that applies the given callback to the Curler instance created for each sync operation


					
	public

withArgs(mixed[]|null $args): static

Get an instance that replaces the arguments passed to each sync operation


					
	public
					static

getReadableProperties(): array

Get readable properties

Returning ["*"] has the same effect as returning every protected property of the class.

Overrides

Salient\Sync\AbstractSyncDefinition::getReadableProperties()

Methods inherited from Salient\Sync\AbstractSyncDefinition
`getClosure(), withConformity(), withFilterPolicy(), withKeyMap(), withKeyMapFlags(), withPipelineFromBackend(), withPipelineToBackend(), withReadFromList(), withReturnEntitiesFrom(), getOperationClosure(), getFallbackClosure(), getPipelineToBackend(), getPipelineFromBackend(),`

Methods used from Salient\Core\Concern\ChainableTrait
`apply(), applyIf(), applyForEach()`

Methods used from Salient\Core\Concern\ImmutableTrait
`with(), without(), handlePropertyChanged()`

Methods used from Salient\Core\Concern\BuildableTrait
`getBuilder(), build(), resolve()`

Methods used from Salient\Core\Concern\ImmutableTrait
`with(), without(), handlePropertyChanged()`

Constants
`public`	`DEFAULT_METHOD_MAP = [ SyncOperation::CREATE => HttpRequestMethod::POST, SyncOperation::READ => HttpRequestMethod::GET, SyncOperation::UPDATE => HttpRequestMethod::PUT, SyncOperation::DELETE => HttpRequestMethod::DELETE, SyncOperation::CREATE_LIST => HttpRequestMethod::POST, SyncOperation::READ_LIST => HttpRequestMethod::GET, SyncOperation::UPDATE_LIST => HttpRequestMethod::PUT, SyncOperation::DELETE_LIST => HttpRequestMethod::DELETE, ]`	#

Constants inherited from Salient\Contract\HasConformity
`CONFORMITY_NONE, CONFORMITY_PARTIAL, CONFORMITY_COMPLETE`

Properties
`public readonly`	`string[]\|string\|null`	`$Path` Path or paths to the endpoint servicing the entity, e.g. "/v1/user" Path or paths to the endpoint servicing the entity, e.g. "/v1/user"	#
`public readonly`	`mixed[]\|null`	`$Query` Query parameters applied to the sync operation URL Query parameters applied to the sync operation URL	#
`public readonly`	`HttpHeadersInterface\|null`	`$Headers` HTTP headers applied to the sync operation request HTTP headers applied to the sync operation request	#
`public readonly`	`CurlerPagerInterface\|null`	`$Pager` Pagination handler for the endpoint servicing the entity Pagination handler for the endpoint servicing the entity	#
`public readonly`	`bool`	`$AlwaysPaginate` Use the pager to process requests even if no pagination is required Use the pager to process requests even if no pagination is required	#
`public readonly`	`int<-1, max>\|null`	`$Expiry` Seconds before cached responses expire Seconds before cached responses expire	#
`public readonly`	`array<SyncOperation::, HttpRequestMethod::>`	`$MethodMap` Array that maps sync operations to HTTP request methods Array that maps sync operations to HTTP request methods	#
`public readonly`	`(callable(CurlerInterface, HttpSyncDefinition<TEntity, TProvider>, SyncOperation::*, SyncContextInterface, mixed...): CurlerInterface)\|null`	`$CurlerCallback` Callback applied to the Curler instance created to perform each sync operation Callback applied to the Curler instance created to perform each sync operation	#
`public readonly`	`bool`	`$SyncOneEntityPerRequest` Perform CREATE_LIST, UPDATE_LIST and DELETE_LIST operations on one entity per HTTP request Perform CREATE_LIST, UPDATE_LIST and DELETE_LIST operations on one entity per HTTP request	#
`public readonly`	`(callable(HttpSyncDefinition<TEntity, TProvider>, SyncOperation::*, SyncContextInterface, mixed...): HttpSyncDefinition<TEntity, TProvider>)\|null`	`$Callback` Callback applied to the definition before each sync operation Callback applied to the definition before each sync operation	#
`public readonly`	`mixed[]\|null`	`$Args` Arguments passed to each sync operation Arguments passed to each sync operation	#

Properties inherited from Salient\Sync\AbstractSyncDefinition
`$Entity, $Provider, $Operations, $Conformity, $FilterPolicy, $Overrides, $KeyMap, $KeyMapFlags, $PipelineFromBackend, $PipelineToBackend, $ReadFromList, $ReturnEntitiesFrom, $EntityReflector, $ProviderReflector`

Namespaces

Classes

Class Salient\Sync\Http\HttpSyncDefinition

`<TEntity is SyncEntityInterface, TProvider is HttpSyncProvider>`

Parameters

Parameters

Overrides