| Methods |
public
|
entity<T is SyncEntityInterface>(class-string<T> $value): static<T, TProvider>
The entity being serviced
The entity being serviced
|
#
|
public
|
provider<T is HttpSyncProvider>(T $value): static<TEntity, T>
The provider servicing the entity
The provider servicing the entity
|
#
|
public
|
pipelineFromBackend<T is SyncEntityInterface>(
PipelineInterface<mixed[], T, SyncPipelineArgument>|null $value,
): static<T, TProvider>
Pipeline that maps provider data to a serialized entity, or `null` if mapping is not required
Pipeline that maps provider data to a serialized entity, or null if mapping is not required
|
#
|
public
|
pipelineToBackend<T is SyncEntityInterface>(
PipelineInterface<T, mixed[], SyncPipelineArgument>|null $value,
): static<T, TProvider>
Pipeline that maps a serialized entity to provider data, or `null` if mapping is not required
Pipeline that maps a serialized entity to provider data, or null if mapping is not required
|
#
|
public
|
operations(array<SyncOperation::*> $value): $this
Supported sync operations
Supported sync operations
|
#
|
public
|
path(string[]|string|null $value): $this
Path or paths to the endpoint servicing the entity, e.g. "/v1/user" (see {@see HttpSyncDefinition::$Path})
Path or paths to the endpoint servicing the entity, e.g. "/v1/user" (see {@see HttpSyncDefinition::$Path})
|
#
|
public
|
query(mixed[]|null $value): $this
Query parameters applied to the sync operation URL (see {@see HttpSyncDefinition::$Query})
Query parameters applied to the sync operation URL (see {@see HttpSyncDefinition::$Query})
|
#
|
public
|
headers(?HttpHeadersInterface $value): $this
HTTP headers applied to the sync operation request (see {@see HttpSyncDefinition::$Headers})
HTTP headers applied to the sync operation request (see {@see HttpSyncDefinition::$Headers})
|
#
|
public
|
pager(?CurlerPagerInterface $value): $this
Pagination handler for the endpoint servicing the entity (see {@see HttpSyncDefinition::$Pager})
Pagination handler for the endpoint servicing the entity (see {@see HttpSyncDefinition::$Pager})
|
#
|
public
|
alwaysPaginate(bool $value = true): $this
Use the pager to process requests even if no pagination is required (default: false)
Use the pager to process requests even if no pagination is required (default: false)
|
#
|
public
|
callback(
(callable(HttpSyncDefinition<TEntity, TProvider>, SyncOperation::*, SyncContextInterface, mixed...): HttpSyncDefinition<TEntity, TProvider>)|null $value,
): $this
Callback applied to the definition before each sync operation (see {@see HttpSyncDefinition::$Callback})
Callback applied to the definition before each sync operation (see {@see HttpSyncDefinition::$Callback})
|
#
|
public
|
conformity(ListConformity::* $value): $this
Conformity level of data returned by the provider for this entity (see {@see AbstractSyncDefinition::$Conformity})
Conformity level of data returned by the provider for this entity (see {@see AbstractSyncDefinition::$Conformity})
|
#
|
public
|
filterPolicy(FilterPolicy::*|null $value): $this
Action to take when filters are not claimed by the provider (see {@see AbstractSyncDefinition::$FilterPolicy})
Action to take when filters are not claimed by the provider (see {@see AbstractSyncDefinition::$FilterPolicy})
|
#
|
public
|
expiry(int<-1, max>|null $value): $this
Seconds before cached responses expire (see {@see HttpSyncDefinition::$Expiry})
Seconds before cached responses expire (see {@see HttpSyncDefinition::$Expiry})
|
#
|
public
|
methodMap(array<SyncOperation::*, HttpRequestMethod::*> $value): $this
Array that maps sync operations to HTTP request methods (see {@see HttpSyncDefinition::$MethodMap})
Array that maps sync operations to HTTP request methods (see {@see HttpSyncDefinition::$MethodMap})
|
#
|
public
|
curlerCallback(
(callable(CurlerInterface, HttpSyncDefinition<TEntity, TProvider>, SyncOperation::*, SyncContextInterface, mixed...): CurlerInterface)|null $value,
): $this
Callback applied to the Curler instance created to perform each sync operation (see {@see HttpSyncDefinition::…
Callback applied to the Curler instance created to perform each sync operation (see {@see HttpSyncDefinition::$CurlerCallback})
|
#
|
public
|
syncOneEntityPerRequest(bool $value = true): $this
Perform CREATE_LIST, UPDATE_LIST and DELETE_LIST operations on one entity per HTTP request (default: false)
Perform CREATE_LIST, UPDATE_LIST and DELETE_LIST operations on one entity per HTTP request (default: false)
|
#
|
public
|
overrides(
array<int-mask-of<SyncOperation::*>, Closure(HttpSyncDefinition<TEntity, TProvider>, SyncOperation::*, SyncContextInterface, mixed...): (iterable<TEntity>|TEntity)> $value,
): $this
Array that maps sync operations to closures that override other implementations (see {@see AbstractSyncDefinition::…
Array that maps sync operations to closures that override other implementations (see {@see AbstractSyncDefinition::$Overrides})
|
#
|
public
|
keyMap(array<array-key, array-key|array-key[]>|null $value): $this
Array that maps keys to properties for entity data returned by the provider (see {@see AbstractSyncDefinition::$KeyMap})
Array that maps keys to properties for entity data returned by the provider (see {@see AbstractSyncDefinition::$KeyMap})
|
#
|
public
|
keyMapFlags(int-mask-of<ArrayMapperFlag::*> $value): $this
Array mapper flags used if a key map is provided
Array mapper flags used if a key map is provided
|
#
|
public
|
readFromList(bool $value = true): $this
Perform READ operations by iterating over entities returned by READ_LIST (default: false; see {@see…
Perform READ operations by iterating over entities returned by READ_LIST (default: false; see {@see AbstractSyncDefinition::$ReadFromList})
|
#
|
public
|
returnEntitiesFrom(SyncEntitySource::*|null $value): $this
Source of entity data for the return value of a successful CREATE, UPDATE or DELETE operation
Source of entity data for the return value of a successful CREATE, UPDATE or DELETE operation
|
#
|
public
|
args(mixed[]|null $value): $this
Arguments passed to each sync operation
Arguments passed to each sync operation
|
#
|