https://github.com/geggleto/commander

https://github.com/geggleto/commander

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/geggleto/commander
• Owner: geggleto
• License: mit
• Created: 2016-12-01T17:12:18.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-09T19:46:00.000Z (almost 8 years ago)
• Last Synced: 2024-04-16T23:29:28.674Z (7 months ago)
• Language: PHP
• Size: 56.6 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Commander

Micro-Service Command/Event Framework

Commander maps a HTTP Request to a Command Handler and listens for Framework Events.

## How to use

1) Write a Command Handler

    - Make sure to Fire `CompletedEvent`

    - Make sure to Fire `ErrorEvent`

    

2) Tell commander what end-point the handler is for

3) Do something with your Event

## Use Cases

Currently we only support JSON APIs.

## Simple Example

```php

$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

- Framework.Complete

    - This event is raised when the response has been completed

    - Payload: `User Defined`

    

    

- Framework.Error

    - This event is raised if there has been an error somewhere

    - Payload: `User Defined` or Framework Errors are `["message" => "..."]`

    

    

- Framework.CommandBus.Handle

    - This event is fired when a Command Handler is about to be executed

    - Payload: `[CommandKey]`

    

    

- Framework.Invoke

    - This event is fired when a Command is about to be fired to the command bus

    - Payload: `["commandKey" => "", "commandClass" => ""]`

    

    

- Framework.EventBus.Notify

    - 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