Code Monkey home page Code Monkey logo

depot's Introduction

Depot - PHP Command Bus

Build Status Scrutinizer Code Quality

Install

composer require vherus/depot

Usage

Out of the box, there are two ways to use Depot. You can either explicitly provide a map of commands => handlers, or (my favourite) you can use the NativeNamespaceResolver to automatically resolve your handlers.

First, we'll look at the automatic resolver.

$bus = new Depot\Bus\NativeCommandBus(new Depot\Resolution\NativeNamespaceResolver);
$bus->dispatch(new My\Command);

The NativeNamespaceResolver will look in the commands current directory and a subdirectory of Handler and Handlers to try and resolve the correct handler for the given command. If it's unable to resolve it, it'll throw a Depot\Exception\UnresolvableHandlerException.

So all you need to do is create your command:

namespace My;
    
class Command implements Depot\Command { }

And a handler with the same name, suffixed with 'Handler', in either the current namespace or a sub-namespace named 'Handler' or 'Handlers'.

namespace My\Handler;
    
class CommandHandler
{
    public function handle(My\Command $command) { }
}

Alternatively, you can use the map resolver to be more explicit about your handler resolutions.

$bus = new NativeCommandBus(new NativeMapResolver([
    My\Command::class => My\Command\Handler\CommandHandler::class
]));
$bus->dispatch(new My\Command);

Decoration

Depot does not come with any "decorators" out of the box; at least, not yet. However, since Depot is rather simple, it's very easy to decorate. You could, for example, create your own implementation of the Depot CommandBus interface and pass the provided NativeCommandBus into it.

For example:

class QueuedCommand extends Depot\Command {}

class QueuedCommandBus implements Depot\CommandBus
{
    private $innerBus;
    private $queue;

    public function __construct(Depot\CommandBus $innerBus, SomeQueueLibrary $queue)
    {
        $this->innerBus = $innerBus;
        $this->queue = $queue;
    }

    public function dispatch(Command $command)
    {
        if ($command instanceof QueuedCommand) {
            $this->queue->queue($command);
            return;
        }

        $this->innerBus->dispatch($command);
    }
}

Framework Specifics

Laravel

I'm not in the habit of creating "ServiceProviders" and "Laravel Bridges" - I feel it's important that you be able to decide exactly how to use any given package. However, I have included an adapter for the Laravel IoC container.

To set up Depot with Laravel, you could simply add something like the below to your AppServiceProvider:

$this->app->bind(Depot\Container::class, Depot\Container\Laravel\IlluminateContainer::class);
$this->app->bind(Depot\HandlerResolver::class, Depot\Resolution\NativeNamespaceResolver::class);
$this->app->bind(Depot\CommandBus::class, Depot\Bus\NativeCommandBus::class);

This will allow you to go ahead an inject Depot\CommandBus as a dependency into your classes as normal.

Note: I have no intention of providing a "facade".

depot's People

Contributors

vherus avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.