divsmith/illuminate-airlock

There is no license information available for the latest version (dev-master) of this package.

Airlock adapters for common Laravel Illuminate classes.

dev-master 2014-09-02 05:02 UTC

Requires

• php: >=5.4.0
• divsmith/airlock: ~1.0.1
• laravel/framework: ~4.2.0

Unknown License

• Parker Smith

README

Laravel provides tons of functionality out of the box with a beautiful and easy to use interface via it's various facades and the Illuminate classes that power them. While this is great for application level classes and services, we don't really want to be doing this in our domain logic.

// Acme\Handlers\UserSubscribedCommandHandler.php

class UserSubscribedCommandHandler {

    public function handle($command)
    {
        // Do everything involved with a new user subscription
        
        Event::fire('user.subscribed', $command); // Very tightly coupled!
    }
}

A common alternative is to inject the Illuminate class in via constructor injection

// Acme\Handlers\UserSubscribedCommandHandler.php

class UserSubscribedCommandHandler {

    protected $dispatcher;

    public function __construct(\Illuminate\Events\Dispatcher $dispatcher) // Less tightly coupled
    {
        $this->dispatcher = $dispatcher;
    }

    public function handle($command)
    {
        $this->dispatcher->fire('user.subscribed', $command);
    }
}

but this approach still leaves us directly tied to the Illuminate\Events\Dispatcher class. Illuminate-Airlock lets us break that coupling and use an interface that we specify and control.

// Acme\Handlers\UserSubscribedCommandHandler.php

class UserSubscribedCommandHandler {
    
    protected $dispatcher;
    
    public function __construct(\Acme\Events\EventInterface $dispatcher) // Completely decoupled
    {
        $this->dispatcher = $dispatcher;
    }
    
    public function handle($command)
    {
        $this->dispatcher->fire('user.subscribed', $command);
    }
}

Installation

1. Add the following to your composer.json file

   {
       "require": {
           "divsmith/airlock": "dev-master"
       }
   }

2. Run composer install

Usage

1. Create an interface that includes the methods on the Illuminate class that your domain logic will use.

   // Acme\Events\EventInterface.php
   
   interface EventInterface {
       public function fire();
       public function listen();
   }

2. Next, create a class that implements the interface and extends the corresponding IlluminateAirlock class.

   // Acme\Events\IlluminateEvents.php
   
   class IlluminateEvents implements EventInterface extends \IlluminateAirlock\Events\Dispatcher {}

   IlluminateAirlock's naming conventions follow Laravel's, so the IlluminateAirlock adapter for Illuminate\Events\Dispatcher would be Divsmith\IlluminateAirlock\Events\Dispatcher, Illuminate\Log\Writer would be Divsmith\IlluminateAirlock\Log\Writer, etc. Each IlluminateAirlock class has the same public methods as the original Illuminate class, so for the most part as long as your interface sticks to them you don't need to implement them in your class.

3. Bind your implementation to the interface in the IoC container via the service provider

   // vendor\divsmith\illuminate-Airlock\src\IlluminateAirlockServiceProvider.php
   
   class IlluminateAirlockServiceProvider extends ServiceProvider {
       
       public function register()
       {
           $this->app->bind('\Acme\Events\EventInterface', function() 
           {
               return new \Acme\Events\IlluminateEvents;
           }
       }
   }

   and add it to your providers array

   // app\config\app.php
   
       ....
       'Illuminate\Session\SessionServiceProvider',
       'Illuminate\Translation\TranslationServiceProvider',
       'Illuminate\Validation\ValidationServiceProvider',
       'Illuminate\View\ViewServiceProvider',
       'Divsmith\IlluminateAirlock\IlluminateAirlockServiceProvider'
   ),
   ....

4. Enjoy!

Notes

1. You may have noticed that there is no tests directory. I purposefully left out unit tests because this package contains no logic to test. It simply passes along method calls; as such, any unit test written would only be able to verify that a specific function was called and that's not the purpose of unit testing.

2. You may occasionally find an Illuminate method that hasn't been implemented in the associated IlluminateAirlock adapter. This is because it's not explicitly defined in the Illuminate class's public API and instead gets called through the __call() magic method. Feel free to add the concrete method to the IlluminateAirlock adapter and submit a pull request.

3. You may notice that some of Laravel's facades don't have IlluminateAirlock adapters provided. I made a conscious decision to leave out the ones that deal with application logic to help keep domain logic clean. If you feel that a valid one has been left out, either send me a message or create the associated adapter and submit a pull request.

Contributing

I'm open to any and all pull requests, from typos to missing method additions to new adapters. Please submit all pull requests to the dev branch.