m1lt0n/delegator

Simple Delegator for PHP 5.4+

1.1.0 2015-09-04 08:02 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• phpspec/phpspec: ~2.0
• squizlabs/php_codesniffer: *

MIT

• Pantelis Vratsalis

• delegation
• decoration

README

Delegator

A simple delegation mechanism for objects.

Delegator is a simple library that allows delegation of methods from an object to others. It can be useful in combination with implementing Delegators, where one can partly decorate an object and partly delegate to the original, undecorated object.

Εxample

<?php

use Delegator\DelegatorInterface;

// Assume we have a Person class
class Person implements DelegatorInterface
{
    use \Delegator\DelegatorTrait;

    // Implement the delegateMap method. This is the only requirement
    // of the DelegatorInterface
    public function delegateMap()
    {
        return [
            'address' => [ 'fullAddress' ],
            'settings' => static::ANY,
        ];
    }

    public function __construct(Address $address)
    {
        $this->address = $address;
    }
}

class Address
{
    protected $street;
    protected $number;
    protected $city;

    public function __construct($street, $number, $city)
    {
        $this->street = $street;
        $this->number = $number;
        $this->city = $city;
    }

    public function fullAddress()
    {
        return "{$this->number}, {$this->street}, {$this->city}";
    }
}

class Settings
{
    public function all()
    {
        return 'all settings';
    }

    public function something()
    {
        return 'some setting';
    }
}

// Simply by using the DelegatorTrait and implementing the delegateMap method,
// we can now delegate calls to the mapped delegates.
$address = new Address('Percy str.', 9, 'London');
$settings = new Settings();
$me = new Person($address, $settings);

echo $me->fullAddress(); // this will be delegated to $me->address->fullAddress();
echo $me->all(); // this will be delegated to $me->settings->all();

// this is equivalent to $me->address->fullAddress, but we have simplified
// our API and hide the internals, while ensuring separation of concerns and
// limited responsibility for each class.

Note: Several delegates can be assigned in the mapping.