Chimera - mapping
![Total Downloads]
![Latest Stable Version]
![Unstable Version], (*1)
![Build Status]
![Code Coverage], (*2)
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., (*3)
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., (*4)
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., (*5)
This package provides a set of annotations to be used to configured your
command/query handlers, HTTP middleware, and command/query bus middleware., (*6)
Important: these annotations will only be used when used together with
packages that read them, like chimera/di-symfony., (*7)
Installation
Package is available on Packagist, you can install it using Composer., (*8)
composer require chimera/mapping
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., (*9)
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., (*10)
Check the documentation for more information: https://secure.php.net/manual/en/function.assert.php, (*11)
Usage
These are the annotations related to how services should be mapped to the
command/query bus:, (*12)
-
Chimera\Mapping\ServiceBus\CommandHandler: exposes the class as
a command handler
-
Chimera\Mapping\ServiceBus\QueryHandler: exposes the class as
a query handler
-
Chimera\Mapping\ServiceBus\Middleware: exposes the class as
a command/query middleware
And these are the ones related to how services should be mapped to the
PSR-15 application:, (*13)
-
Chimera\Mapping\Routing\CreateAndFetchEndpoint: adds an endpoint
that will execute a command to create a resource and then a query to fetch
its state
-
Chimera\Mapping\Routing\CreateEndpoint: adds an endpoint
that will execute a command to create a resource
-
Chimera\Mapping\Routing\ExecuteAndFetchEndpoint: adds an endpoint
that will execute a command to modify a resource and then a query to fetch
its state
-
Chimera\Mapping\Routing\ExecuteEndpoint: adds an endpoint
that will execute a command to modify/remove a resource
-
Chimera\Mapping\Routing\FetchEndpoint: adds an endpoint
that will execute a query
-
Chimera\Mapping\Routing\Middleware: exposes the class as
a PSR-15 HTTP middleware
The idea of the annotations is to simplify the mapping of services, removing
complex tags from the dependency injection container file. They should essentially
be used like this:, (*14)
<?php
declare(strict_types=1);
namespace MyApi\Creation;
use Chimera\Mapping as Chimera;
/**
* @Chimera\Routing\CreateEndpoint(path="/books", command=AddToCollection::class, name="book.create", redirectTo="book.fetch_one")
* @Chimera\ServiceBus\CommandHandler(handles=AddToCollection::class)
*/
final class AddToCollectionHandler
{
// ...
}
License
MIT, see LICENSE., (*15)
Wallogit.com
