lukaszmakuch/class-based-registry

Registry that allows to associate a value to one ore more classes and then fetch this value by passing objects that implements these classes

v0.0.2 2016-01-16 17:52 UTC

Requires (Dev)

• phpdocumentor/phpdocumentor: 2.*
• phpunit/phpunit: 4.7.*

MIT

• Łukasz Makuch

README

Allows to associate a value to one or more classes and then fetch this value by passing objects that implement these classes.

Usage

Environment

Let's assume that we have classes like these:

class Animal {}
class Elephant extends Animal {}
class Plant {}

To get a new instance of the registry create it:

$r = new \lukaszmakuch\ClassBasedRegistry\ClassBasedRegistry();

Simple example

Associate 42 with the Animal class:

$r->associateValueWithClasses(
    42,
    [Animal::class]
);

Fetch it by providing any animal...

$r->fetchValueByObjects([new Animal()]); //42

... that may be an elephant!

$r->fetchValueByObjects([new Elephant()]); //42

Multiple classes

It is possible to associate value with many classes:

$r->associateValueWithClasses(
    1970,
    [Animal::class, Plant::class]
);

While fetching objects may be passed in any order:

$r->fetchValueByObjects([new Plant(), new Elephant()]); //1970

Throwing exceptions

When it's not possible to obtain any value, then a \lukaszmakuch\ClassBasedRegistry\Exception\ValueNotFound exception is thrown:

try {
    $r->fetchValueByObjects([new Plant()]);
} catch (\lukaszmakuch\ClassBasedRegistry\Exception\ValueNotFound $e) {
  //it was not possible to fetch any value by a plant
}

Installation

Use composer to get the latest version:

$ composer require lukaszmakuch/class-based-registry