Download the PHP package phpgears/cqrs without Composer
On this page you can find all versions of the php package phpgears/cqrs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download phpgears/cqrs
More information about phpgears/cqrs
Files in phpgears/cqrs
Informations about the package cqrs
CQRS
CQRS base classes and handling interfaces
This package only provides the building blocks to CQRS
Installation
Composer
Usage
Require composer autoload file
Commands
Commands are DTOs that carry all the information for an action to happen
You can create your own by implementing Gears\CQRS\Command
or extend from Gears\CQRS\AbstractCommand
which ensures command immutability and payload is composed only of scalar values which is a very interesting capability. AbstractCommand has a protected constructor forcing you to create custom static named constructors
In case of a command without any payload you could extend Gears\CQRS\AbstractEmptyCommand
Async commands
Having command assuring all of its payload is composed only of scalar values proves handy when you want to delegate command handling to a message queue system such as RabbitMQ, Gearman or Apache Kafka, serializing/deserializing scalar values is trivial in any format and language
Asynchronous behaviour must be implemented at CommandBus level, command bus must be able to identify async commands (a map of commands, implementing an interface, by a payload parameter, ...) and enqueue them
If you want to have asynchronous behaviour on your CommandBus have a look phpgears/cqrs-async, there you'll find all the necessary pieces to start your async command bus, for example using queue-interop with phpgears/cqrs-async-queue-interop
Queries
Queries are DTOs that carry all the information for a request to be made to the data source
You can create your own by implementing Gears\CQRS\Query
or extend from Gears\CQRS\AbstractQuery
which ensures query immutability and payload is composed only of scalar values. AbstractQuery has a protected constructor forcing you to create a custom static named constructors
In case of a query without any payload you could extend Gears\CQRS\AbstractEmptyQuery
Handlers
Commands and Queries are handed over to Gears\CQRS\CommandHandler
and Gears\CQRS\QueryHandler
respectively on their corresponding buses
AbstractCommandHandler
and AbstractQueryHandler
are provided in this package, this abstract classes verifies the type of the command/query so you can focus only on implementing the handling logic
Have a look at phpgears/dto fo a better understanding of how commands and queries are built out of DTOs and how they hold their payload
Buses
Only Gears\CQRS\CommandBus
and Gears\CQRS\QueryBus
interfaces are provided, you can easily use any of the good bus libraries available out there by simply adding an adapter layer
Implementations
CQRS buses implementations currently available
- phpgears/cqrs-symfony-messenger uses Symfony's Messenger
- phpgears/cqrs-tactician uses League's Tactician
Contributing
Found a bug or have a feature request? Please open a new issue. Have a look at existing issues before.
See file CONTRIBUTING.md
License
See file LICENSE included with the source code for a copy of the license terms.