dms/chainlink-bundle

Wrapper for Chainlink to provide drop in Chain of responsibility implementation into Symfony. Provides tags to inject handlers into configuration defined contexts.

0.5 2016-12-01 11:06 UTC

Requires

• php: >=5.4
• dms/chainlink: ^0.4

Requires (Dev)

• matthiasnoback/symfony-config-test: ^0.4
• mockery/mockery: ^0.9
• phpunit/phpunit: ~4.5
• scrutinizer/ocular: ~1.1
• symfony/config: ~2.5
• symfony/dependency-injection: ~2.5
• symfony/http-kernel: ~2.5

MIT

• Rafael Dohms

• symfony
• bundle
• dms
• handler
• chain of responsibility

README

This Bundle wraps Chainlink library and offers a drop in solution to implement the Chain of Responsibility pattern, based on Symfony service tags. It allows you to, via configuration, setup multiple contexts and define which tags provide handlers for each.

Installation

To get the Bundle code, run:

composer require dms/chainlink-bundle

Edit your AppKernel.php file to instantiate the Bundle:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...

        new DMS\Chainlink\Bundle\DMSChainlinkBundle(),
    );
}

If you are looking for other frameworks, check Packagist for wrappers and adapters.

Usage

To register new Contexts and assign handlers to them, simply add configuration entries in your config.yml.

dms_chainlink:
    contexts:
        my_new_context:
            tag: mycontext.handler

The bundle will look for any services tagged with the tag defined above and inject them as handlers in the context you requested.

To handle a request, retrieve the Context from the Container and pass in your input.

$this->container->get('dms_chainlink.context.my_new_context')->handle($input);

//or its also aliased at

$this->container->get('my_new_context')->handle($input);

Services that will be used as handlers need to implement the HandlerInterface from Chainlink. Its the handler's responsibility to identify which input it is responsible for, the interface contains a handles method that is called for that.

Order of Chain handling

As of version 0.3, Chainlink supports ordering of the handlers using the priority system used extensively in Symfony. The handlers will be called from high to low.

# src/Vendor/MyBundle/Resources/config/services.yml

my_service:
  class: MyHandler
  tag:
    - { name: my_new_context, priority: 1 }

my_other_service:
  class: OtherHandler
  tag:
    - { name: my_new_context, priority: 9001 }

In this case OtherHandler will be called first, and then MyHandler, provided they can handle the usecase.