thecodingmachine/service-provider-registry

This package provides a service provider registry that can lazily instantiate the service providers it contains.

v3.0.0 2020-04-10 07:42 UTC

Requires

• php: >=7.1
• container-interop/service-provider: ^0.4

Requires (Dev)

• humbug/humbug: ~1.0@dev
• mouf/picotainer: ^1.0
• phpunit/phpunit: ^4.5
• satooshi/php-coveralls: ^1.0
• thecodingmachine/discovery: ^1.0

Suggests

• thecodingmachine/discovery: Discover service providers automatically.

MIT

README

What is it?

This project contains a registry that stores service providers. The registry implements \ArrayAccess and behaves like an array. However, service providers in this object can be instantiated only when the key in the array is fetched, so you don't have to create the instance right away. This is useful for performance considerations, especially for compiled or cached containers.

This class is meant to be used by compiled/cached containers that want to implement container-interop service providers. It is not meant for the mere mortals.

How does it work?

Easy, you create a new Registry object, and then, you push objects in it.

$registry = new Registry();

$key = $registry->push(MyServiceProvider::class);

// This will trigger the creation of the MyServiceProvider object and return it.
$serviceProvider = $registry[$key];

You can also pass parameters to the constructor of the object:

$registry = new Registry();

$key = $registry->push(MyServiceProvider::class, "param1", "param2");

And because we are kind, you can also push into the lazy array an already instantiated object:

$registry = new Registry();

// This is possible, even if we loose the interest of the Registry.
$key = $registry->push(new MyServiceProvider());

Finally, if you are performance oriented (and I'm sure you are, otherwise you wouldn't be looking at this package), you can create the whole registry in one call:

$registry = new Registry([
    MyServiceProvider::class, // Is you simply want to create an instance without passing parameters
    [ MyServiceProvider2::class, [ "param1", "param2 ] ],  // Is you simply want to create an instance and pass parameters to the constructor
    new MyServiceProvider4('foo') // If you directly want to push the constructed instance.
]);

Iterating the registry

The registry implements the \Traversable interface, so iterating it is as simple as a foreach:

foreach ($registry as $serviceProvider) {
    // Do stuff for each service provider.
    // Service providers will be instantiated on the fly if needed.
}

Discovery with thecodingmachine/discovery

The registry supports a discovery mechanism based on thecodingmachine/discovery (to automatically find and attach service providers to your application).

As a second parameter, the Registry accepts the Discovery object from thecodingmachine/discovery. Pass this object and thecodingmachine/discovery will be used to fetch service providers from your packages.

$registry = new Registry([], TheCodingMachine\Discovery::getInstance());

// The registry now contains all the service providers discoverable by thecodingmachine/discovery.

Caching of getFactories and getExtensions

You can use the shortcut Registry::getFactories($key) or Registry::getExtensions($key) methods to call the getFactories and getExtensions methods on a service provider. The result is cached: 2 successive calls will not call the getFactories or getExtensions methods twice.

$factories = $registry->getFactories(0);

$extensions = $registry->getExtensions(0);

Using the registry to create services

Even better, using the createService method of the registry, you can directly call the service factory:

$myService = $registry->createService(0, 'serviceName', $container);

Using the extendService method of the registry, you can directly call the service extension:

$myService = $registry->extendService(0, 'serviceName', $container, $previousService);

Why?

This was built for improving the performance of service providers loading (in compiled container environment).