Class Salient\Sync\AbstractSyncProvider

Get a dependency substitution map for the provider

{@inheritDoc}

Override this method to bind any {@see SyncEntityInterface} classes customised for the provider to their generic parent classes, e.g.:

<?php
public static function getContextualBindings(): array
{
    return [
        Post::class => CustomPost::class,
        User::class => CustomUser::class,
    ];
}

Creates a new sync provider object

Creating an instance of the provider registers it with the entity store injected by the container.

Get a context within which to instantiate entities on the provider's behalf

Get the provider's default unclaimed filter policy

True if a value is of the correct type and format to be an entity ID

Get the provider's entity store

Get the provider ID assigned to the backend instance by its entity store

Perform a sync operation if its context is valid

Providers where sync operations are performed by declared methods should use this method to ensure filter policy violations are caught and to take advantage of other safety checks that may be added in the future.

Example:

<?php
class Provider extends HttpSyncProvider
{
    public function getEntities(SyncContextInterface $ctx): iterable
    {
        // Claim filter values
        $start = $ctx->claimFilter('start_date');
        $end = $ctx->claimFilter('end_date');

return $this->run(
            $ctx,
            fn(): iterable =>
                Entity::provide(
                    $this->getCurler('/entities')->getP([
                        'from' => $start,
                        'to' => $end,
                    ]),
                    $ctx,
                )
        );
    }
}

Get a new pipeline for mapping provider data to entities

Get a new pipeline for mapping entities to provider data

Get a list of services provided by the class

Use an entity-agnostic interface to the provider's implementation of sync operations for an entity

Perform a sync operation after validating its context

Filter the output of a sync operation if required by its context