smoothcodes/smooth-query-bus

dev-master 2020-04-29 12:53 UTC

Requires

• php: >=7.0
• psr/container: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.1

MIT

• Jakub Rusinowicz

README

This simple package will help you to implement Query part of CQRS in your project. Easy to integrate with Laravel, Symfony or raw PHP project.

Installation

$ composer require smoothcodes/smooth-query-bus

Usage

This package is using Psr\ContainerInterface to resolve dependencies injected to Query Handlers. Symfony and Laravel Dependency Container is implementing ContainerInterface so it's really easy to implement SmoothQueryBus in your Symfony/Laravel Project.

By default this package provides HandlerResolver called SmoothCodes\SmoothQueryBus\SmoothHandlerResolver and it requires project structure for your queries and handlers like this:

app
│   ...    
│
└───Query
│   │   GetUserByIdQuery.php
│   │   ...
│   
└───Handler
    │   GetUserByIdQueryHandler.php
    |   ...

Each Query should implement SmoothCodes\SmoothQueryBus\QueryInterface and each Handler should implement SmoothCodes\SmoothQueryBus\QueryHandlerInterface.

Now you're ready to dispatch your queries like that:

In handlers __invoke method is called as action. So Handler should look like this:

class GetUserByIdQueryHandler implements HandlerInterface {
    protected $userRepository;

    public function __construct(UserRepositoryInterface $userRepository) {
        $this->userRepository = $userRepository;
    }

    public function __invoke(GetUserByIdQuery $query) {
        return $this->userRepository->find($query->id);
}

$queryBus = new SmoothQueryBus(
    new SmoothHandlerResolver($container)
);

$result = $queryBus->query(new GetUserByIdQuery($id));

If you want you can implement your own Query Handler Resolving Strategy by providing class implementing SmoothCodes\SmoothQueryBus\HandlerResolvingStrategy to SmoothHandlerResolver instance eg. like that:

        $namingResolver = new class($queryHandler) implements HandlerResolvingStrategy {
            private $queryHandler;

            public function __construct(QueryHandlerInterface $handler)
            {
                $this->queryHandler = $handler;
            }

            public function getHandlerClassName(QueryInterface $query)
            {
                return get_class($this->queryHandler);
            }
        };

        $queryBus = new SmoothQueryBus(
            new SmoothHandlerResolver($container, $namingResolver)
        );

instead default handler resolving strategy will be used.

That's very simple package which is fully customizable. Report any issues, give feedbacks or do some feature requests.