commander/core

container-interop aware command-bus

Commander

Micro-Service Command/Event Framework, _(*1)

Commander maps a HTTP Request to a Command Handler and listens for Framework Events., _(*2)

How to use

1) Write a Command Handler - Make sure to Fire CompletedEvent - Make sure to Fire ErrorEvent, _(*3)

2) Tell commander what end-point the handler is for, _(*4)

3) Do something with your Event, _(*5)

Use Cases

Currently we only support JSON APIs., _(*6)

Simple Example

$commander = new Commander();
$this->commander->get('/user/{id}', 'user.cache.get', SimpleGetUserHandler::class);
$commander->run();


//In SimpleGetUserHandler
class SimpleGetUserHandler extends Handler
{
    /**
     * @param CommandInterface $command
     */
    public function handle(CommandInterface $command)
    {
        $this->eventBus->notify(CompletedEvent::makeEvent(['id' => '1'])); //fill in the user info
    }
}

Why ??

• CQRS!
• Less Boilerplate.
• Greater Testability.
• No Controllers or Controller Actions...
• Better Resource Usage

Framework Events

You can subscribe to the following Framework Events, _(*7)

• Framework.Complete, _(*8)

  • This event is raised when the response has been completed
  • Payload: User Defined

• Framework.Error, _(*9)

  • This event is raised if there has been an error somewhere
  • Payload: User Defined or Framework Errors are ["message" => "..."]

• Framework.CommandBus.Handle, _(*10)

  • This event is fired when a Command Handler is about to be executed
  • Payload: [CommandKey]

• Framework.Invoke, _(*11)

  • This event is fired when a Command is about to be fired to the command bus
  • Payload: ["commandKey" => "", "commandClass" => ""]

• Framework.EventBus.Notify, _(*12)

  • This event is fired when an Event is about to be sent to the EventBus.
  • Will not propagate Framework.EventBus.Notify's
  • Payload: callable... [$object, "method"]

Todo

• Event Payloads
  • JsonPayload
  • TextPayload
  • XMLPayload

Contributors

• Glenn Eggleton geggleto@gmail.com