gpslab/payload

The simple infrastructure component for create payload message

v1.1.0 2017-07-11 09:59 UTC

This package is auto-updated.

Last update: 2020-11-30 02:27:01 UTC


README

Latest Stable Version Total Downloads Build Status Coverage Status Scrutinizer Code Quality SensioLabs Insight StyleCI License

The simple infrastructure component for create payload message

Installation

Pretty simple with Composer, run:

composer require gpslab/payload

Usage

This library automatically fill the properties of the object with payload data.

For example, create a simple message

class SimpleMessage extends PayloadMessage
{
    public $id = 0;

    public $name = '';
}

Fill the message

$message = new SimpleMessage([
    'id' => 123,
    'name' => 'foo',
]);

$message->id; // 123
$message->name; // foo
$message->payload(); // ['id' => 123, 'name' => 'foo']

Note

All fields specified in the payload must exist.

Protected properties

You can use protected properties for data. It's convenient to make the properties as read-only.

class SimpleMessage extends PayloadMessage
{
    protected $id = 0;

    protected $name = '';

    public function id()
    {
        return $this->id;
    }

    public function name()
    {
        return $this->name;
    }
}

Fill the message

$message = new SimpleMessage([
    'id' => 123,
    'name' => 'foo',
]);

$message->id(); // 123
$message->name(); // foo
$message->payload(); // ['id' => 123, 'name' => 'foo']

Note

For fill private properties you must use setters.

Property setters

You can mark properties as private and use setters for fill it. This will ensure the security of data and control their type. You can mark the setters as protected to close the class from changes from the outside.

class SimpleMessage extends PayloadMessage
{
    private $id = 0;

    private $name = '';

    public function id(): integer
    {
        return $this->id;
    }

    protected function setId(integer $id)
    {
        $this->id = $id;
    }

    public function name(): string
    {
        return $this->name;
    }

    protected function setName(string $name)
    {
        $this->name = $name;
    }
}

Fill the message

$message = new SimpleMessage([
    'id' => 123,
    'name' => 'foo',
]);

$message->id(); // 123
$message->name(); // foo
$message->payload(); // ['id' => 123, 'name' => 'foo']

CQRS

You can use payload in CQRS infrastructure.

Command to rename contact:

class RenameContactCommand extends PayloadCommand
{
    public $contact_id = 0;

    public $new_name = '';
}

Query for get contact by identity:

class ContactByIdentityQuery extends PayloadQuery
{
    public $id = 0;
}

Domain Events

You can use payload in Domain Events.

Event, contact was renamed:

class RenamedContactEvent extends PayloadDomainEvent
{
    public $contact_id = 0;

    public $old_name = '';

    public $new_name = '';
}

Serialize

You can serialize messages with Symfony serializer component. For do it you can use PayloadNormalizer or TypedPayloadNormalizer and encode result to JSON, XML, YAML, CSV, etc.

  • PayloadNormalizer - can be used only for one class because he does not distinguish messages;
  • TypedPayloadNormalizer - adds to the normalized data the type of message received from MessageTypeResolver service.

You can use ClassNameMessageTypeResolver as a simplify resolver. It use the last part of class name as a messages type.

  • \Acme\Demo\SomeMessage converted to SomeMessage
  • \Acme_Demo_SomeMessage converted to SomeMessage

Be careful with the use of this resolver and do not named message classes equally in different namespace.

License

This bundle is under the MIT license. See the complete license in the file: LICENSE