pauci/cqrs-factory

CQRS factories for PSR-11

v0.7.0 2023-01-18 11:51 UTC

Requires

• php: ^8.0 || ^8.1 || ^8.2
• pauci/cqrs: ^0.7.0
• psr/container: ^1.0 || ^2.0

Requires (Dev)

• doctrine/orm: ^2.8
• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.7
• symfony/serializer: ^6.0

MIT

README

CQRS factories for PSR-11

This package provides a set of factories to be used with containers using the PSR-11 standard for an easy CQRS integration in a project.

Installation

The easiest way to install this package is through composer:

$ composer require pauci/cqrs-factory

Configuration

In the general case where you are only using a single command bus, it's enough to define the command bus factory:

return [
    'dependencies' => [
        'factories' => [
            'cqrs.command_bus.cqrs_default' => \CQRSFactory\CommandBusFactory::class,
        ],
    ],
];

If you want to add a second command bus, or use another name than "cqrs_default", you can do so by using the static variants of the factories:

return [
    'dependencies' => [
        'factories' => [
            'cqrs.command_bus.cqrs_other' => [\CQRSFactory\CommandBusFactory::class, 'cqrs_other'],
        ],
    ],
];

Each factory supplied by this package will by default look for a registered factory in the container. If it cannot find one, it will automatically pull its dependencies from on-the-fly created factories. This saves you the hassle of registering factories in your container which you may not need at all. Of course, you can always register those factories when required. The following additional factories are available:

• \CQRSFactory\EventBusFactory (cqrs.event_bus.*)
• \CQRSFactory\EventPublisherFactory (cqrs.event_publisher.*)
• \CQRSFactory\EventStoreFactory (cqrs.event_store.*)
• \CQRSFactory\IdentityMapFactory (cqrs.identity_map.*)
• \CQRSFactory\SerializerFactory (cqrs.serializer.*)
• \CQRSFactory\TransactionManagerFactory (cqrs.transaction_manager.*)

Each of those factories supports the same static behavior as the command bus factory. For container specific configurations, there are a few examples provided in the example directory:

• Zend\ServiceManager

Example configuration

A complete example configuration can be found in example/config.php.