chimera/serialization-jms

Adapter for jms/serializer which allows you to create messages to be handled

0.4.0 2021-02-24 21:27 UTC

README

Total Downloads Latest Stable Version Unstable Version

Build Status Code Coverage

The term Chimera (/kɪˈmɪərə/ or /kaɪˈmɪərə/) has come to describe any mythical or fictional animal with parts taken from various animals, or to describe anything composed of very disparate parts, or perceived as wildly imaginative, implausible, or dazzling.

There are many many amazing libraries in the PHP community and with the creation and adoption of the PSRs we don't necessarily need to rely on full stack frameworks to create a complex and well designed software. Choosing which components to use and plugging them together can sometimes be a little challenging.

The goal of this set of packages is to make it easier to do that (without compromising the quality), allowing you to focus on the behaviour of your software.

This package provides an adapter for jms/serializer, allowing us to use it as a MessageCreator - which is responsible for converting the user input into a message to be handled.

Installation

Package is available on Packagist, you can install it using Composer.

composer require chimera/serialization-jms

PHP Configuration

In order to make sure that we're dealing with the correct data, we're using assert(), which is a very interesting feature in PHP but not often used. The nice thing about assert() is that we can (and should) disable it in production mode so that we don't have useless statements.

So, for production mode, we recommend you to set zend.assertions to -1 in your php.ini. For development you should leave zend.assertions as 1 and set assert.exception to 1, which will make PHP throw an AssertionError when things go wrong.

Check the documentation for more information: https://secure.php.net/manual/en/function.assert.php

Usage

This is how you can use the ArrayTransformer as a MessageCreator:

<?php
declare(strict_types=1);

namespace MyApp;

use Chimera\ExecuteQuery;
use Chimera\MessageCreator\InputExtractor\AppendGeneratedIdentifier;
use Chimera\MessageCreator\InputExtractor\UseInputData;
use Chimera\MessageCreator\JmsSerializer\ArrayTransformer;
use JMS\Serializer\SerializerBuilder;

// We instantiate it passing a valid JMS serialiser
$messageCreator = new ArrayTransformer(
    SerializerBuilder::create()->build(),
    new AppendGeneratedIdentifier(new UseInputData())
);

// Then use it on the actions
$action = new ExecuteQuery($queryBus, $messageCreator, MyQuery::class); // considering that $queryBus is a valid instance of `ServiceBus`
$result = $action->fetch($input); // considering that $input is a valid instance of `Input`

var_dump($result);

License

MIT, see LICENSE.