gpslab/cqrs

Infrastructure for creating CQRS applications

, _(*1)

CQRS

Infrastructure for creating CQRS applications., _(*2)

, _(*3)

Installation

Pretty simple with Composer, run:, _(*4)

composer require gpslab/cqrs

Command

• Simple usage
• Bus
• Handler
  • Create handler
  • Locator and Subscribers
  • Direct binding locator
  • PSR-11 Container locator (PSR-11)
  • Symfony container locator (Symfony 3.3 implements a PSR-11)
• Queue
  • Pull
  • Memory queue
  • Memory unique queue
  • Predis queue
  • Predis unique queue
  • Subscribe
  • Executing queue
  • Predis queue
  • Serialize command
  • Optimized serializer
  • Payload serializer
• Middleware
• Payload

Simple usage commands

Commands, in the CQRS approach, are designed to change the data in the application., _(*5)

For example, consider the procedure for renaming an article., _(*6)

Create a command to rename:, _(*7)

use GpsLab\Component\Command\Command;

class RenameArticleCommand implements Command
{
    public $article_id;

    public $new_name = '';
}

Note, _(*8)

To simplify the filling of the command, you can use payload., _(*9)

You can use any implementations of callable type as a command handler. We recommend using public methods of classes as handlers. For example we use Doctrine ORM., _(*10)

use GpsLab\Component\Command\Command;
use Doctrine\ORM\EntityManagerInterface;

class RenameArticleHandler
{
    private $em;

    public function __construct(EntityManagerInterface $em)
    {
        $this->em = $em;
    }

    public function handleRenameArticle(RenameArticleCommand $command): void
    {
        // get article by id
        $article = $this->em->getRepository(Article::class)->find($command->article_id);
        $article->rename($command->new_name);
    }
}

And now we register handler and handle command., _(*11)

use GpsLab\Component\Command\Bus\HandlerLocatedCommandBus;
use GpsLab\Component\Command\Handler\Locator\DirectBindingCommandHandlerLocator;

// register command handler in handler locator
$handler = new RenameArticleHandler($em);
$locator = new DirectBindingCommandHandlerLocator();
$locator->registerHandler(RenameArticleCommand::class, [$handler, 'handleRenameArticle']);

// create bus with command handler locator
$bus = new HandlerLocatedCommandBus($locator);

// ...

// create rename article command
$command = new RenameArticleCommand();
$command->article_id = $article_id;
$command->new_name = $new_name;

// handle command
$bus->handle($command);

For the asynchronous handle a command you can use CommandQueue., _(*12)

Note, _(*13)

To monitor the execution of commands, you can use middleware., _(*14)

Query

• Simple usage
• Bus
• Handler
  • Create handler
  • Locator and Subscribers
  • Direct binding locator
  • PSR-11 Container locator (PSR-11)
  • Symfony container locator (Symfony 3.3 implements a PSR-11)
• Middleware
• Payload
• Doctrine specification query

Simple usage queries

Query, in the CQRS approach, are designed to get the data in the application., _(*15)

For example, consider the procedure for get an article by identity., _(*16)

Create a query:, _(*17)

use GpsLab\Component\Query\Query;

class ArticleByIdentityQuery implements Query
{
    public $article_id;
}

Note, _(*18)

To simplify the filling of the query, you can use payload., _(*19)

You can use any implementations of callable type as a query handler. We recommend using public methods of classes as handlers. For example we use Doctrine ORM., _(*20)

use GpsLab\Component\Query\Query;
use Doctrine\ORM\EntityManagerInterface;

class ArticleByIdentityHandler
{
    private $em;

    public function __construct(EntityManagerInterface $em)
    {
        $this->em = $em;
    }

    public function handleArticleByIdentity(ArticleByIdentityQuery $query)
    {
        // get article by id
        return $this->em->getRepository(Article::class)->find($query->article_id);
    }
}

And now we register handler and handle query., _(*21)

use GpsLab\Component\Query\Bus\HandlerLocatedQueryBus;
use GpsLab\Component\Query\Handler\Locator\DirectBindingQueryHandlerLocator;

// register query handler in handler locator
$handler = new ArticleByIdentityHandler($em);
$locator = new DirectBindingQueryHandlerLocator();
$locator->registerHandler(ArticleByIdentityQuery::class, [$handler, 'handleArticleByIdentity']);

// create bus with query handler locator
$bus = new HandlerLocatedQueryBus($locator);

// ...

// create find article query
$query = new ArticleByIdentityQuery();
$query->article_id = $article_id;

// handle query
$article = $bus->handle($query);

Note, _(*22)

To monitor the execution of commands, you can use middleware., _(*23)

License

This bundle is under the MIT license. See the complete license in the file: LICENSE, _(*24)