remessage/client

PHP client for Re Message

v0.8.3 2022-05-11 21:18 UTC

Requires

• php: >=8.1
• ext-mbstring: *
• doctrine/annotations: ^1.10
• doctrine/collections: ^1.6
• psr/event-dispatcher: ^1.0
• psr/http-client: ^1.0
• psr/http-factory: ^1.0
• psr/http-message: ^1.0
• psr/log: ^3.0
• remessage/message: ^2.2.0
• symfony/config: ^6.0
• symfony/yaml: ^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• nyholm/psr7: ^1.2
• phpunit/phpunit: ^9.5
• symfony/event-dispatcher: ^6.0
• symfony/http-client: ^6.0

Apache-2.0

• Oleg Kozlov

README

This package provides an object-oriented client level to interact with Re Message Core. The package architecture inspired by DBAL and Doctrine packages.

Client uses the specific version when sends messages to Core.

Requirements

1. PHP 8.1+

2. Any psr/http-client compatible package to send HTTP requests

3. Any psr/event-dispatcher compatible package

   Configurator for symfony/event-dispatcher included in package

Installation

You will need Composer to install:

composer require remessage/client

Usage

To create an instance of client, you need to choose transport. Now available only HTTP protocol transport. This transport can work with PSR 7, PSR 17, PSR 18 implementation. For example, symfony/http-client. We will use this package as http client in next examples.

Any transport requires message serializer from remessage/message package. You can use RM\Standard\Message\Serializer\ChainMessageSerializer class to pass serializers for each message type.

After creation of transport instance, you can use RM\Component\Client\ClientFactory or RM\Component\Client\ClientConfigurator to create an instance of client. We recommend using the configurator because he has simple settings. Factory has several setters that provide client customization.

In any case, you need to configure the following properties:

• The transport (it is required in constructor and create() method)

Also, you can configure these properties via factory:

• The hydrator, creates entity objects from response
• The repository registry, contains repositories created via factory
• The repository factory, creates repositories
• The authenticator factory, creates authenticators
• The authorization storage, stores the authorization data like token.
• The authorization resolver, finds credentials to pass together with request to core
• The config loader, loads the action config from resource with settings for authorization resolver

Example of creation client with HTTP transport:

use RM\Component\Client\ClientFactory;
use RM\Component\Client\Transport\HttpTransport;
use RM\Standard\Message\Serializer\ActionSerializer;
use RM\Standard\Message\Serializer\ChainMessageSerializer;
use RM\Standard\Message\Serializer\ErrorSerializer;
use RM\Standard\Message\Serializer\ResponseSerializer;
use Symfony\Component\HttpClient\Psr18Client;

$http = new Psr18Client();

$serializer = new ChainMessageSerializer();
$serializer->pushSerializer(new ActionSerializer());
$serializer->pushSerializer(new ErrorSerializer());
$serializer->pushSerializer(new ResponseSerializer());

$transport = new HttpTransport($http, $http, $http, $serializer);
$client = ClientFactory::create($transport)->build();

Events

The package have some events to allow you to interact and to handle some cases. As example, we provided some event listeners.

Events:

• RM\Component\Client\Event\ErrorEvent
• RM\Component\Client\Event\SentEvent
• RM\Component\Client\Event\HydratedEvent

Event listeners:

• RM\Component\Client\EventListener\ThrowableSendListener - throws exception on error message and creates error event
• RM\Component\Client\EventListener\LazyLoadListener - provides lazy load for entity relations

How to add event listener (for Symfony EventDispatcher):

use RM\Component\Client\ClientFactory;
use RM\Component\Client\Event\SentEvent;
use RM\Component\Client\EventListener\ThrowableSendListener;
use RM\Component\Client\Transport\TransportInterface;
use Symfony\Component\EventDispatcher\EventDispatcher;

// transport initialization

/** @var TransportInterface $transport **/
$factory = ClientFactory::create($transport);
$client = $factory->build();

/** @var EventDispatcher $eventDispatcher */
$eventDispatcher = $factory->getEventDispatcher();
$eventDispatcher->addListener(SentEvent::class, new ThrowableSendListener($eventDispatcher));

We recommend registering ALL event listeners provided from the package.

Also, you can overwrite event dispatcher before building:

use RM\Component\Client\ClientFactory;
use RM\Component\Client\Event\SentEvent;
use RM\Component\Client\EventListener\ThrowableSendListener;
use RM\Component\Client\Transport\TransportInterface;
use Symfony\Component\EventDispatcher\EventDispatcher;

// transport initialization

$eventDispatcher = new EventDispatcher();

/** @var TransportInterface $transport **/
$client = ClientFactory::create($transport)
    ->setEventDispatcher($eventDispatcher)
    ->build()
;

$eventDispatcher->addListener(SentEvent::class, new ThrowableSendListener($eventDispatcher));