Cargo
Cargo is yet another container library. Its feature set and semantics closely follow Pimple; however, it's design is more modular so that it can be extended. It was designed to be compatible with Pimple; so you can easily use any Pimple service providers with Cargo., (*1)
Pimple is a great service container; however it suffers from one problem... extendability. Pimple was never designed to properly extended or decorated which makes it very hard to add features without modifying the core. Cargo is a container that manages to keep the simplicity of Pimple while allowing powerful extensions., (*2)
Installation
Install with composer at krak/cargo, (*3)
Usage
Creating a Container
There are several ways to create cargo containers. The easiest way is to just create the default container like so:, (*4)
<?php
use Krak\Cargo;
$c = Cargo\container();
Which is just the same as doing:, (*5)
$c = new Container\BoxContainer();
$c = new Container\SingletonContainer($c);
$c = new Container\BoxFactoryContainer($c);
$c = new Container\FreezingContainer($c);
$c = new Container\AliasContainer($c);
Cargo is designed to be extendable and flexible, so each container decorator adds a feature that can be removed if not desired., (*6)
If you want just a bare bones container, you can use the following:, (*7)
<?php
$c = Cargo\liteContainer($values = [], $box_container = null);
This just implements the Box and BoxFactory container which caches services as singletons by default., (*8)
Defining Services
Services can defined and configured several ways., (*9)
$c['a'] = function($c) {
return new ServiceA();
};
// or
$c->add('b', function($c) {
return new ServiceB($c['a']);
});
Due to the BoxFactoryContainer, all Closures are treated as lazy services. Meaning, they are not invoked until needed. The Singleton container also defaults all services to be singletons, so the result of the service definition closure is cached so that it's not invoked twice. These semantics mimic the behavior of the Pimple Container;, (*10)
Accessing the Container
You can either use the ArrayAccess methods or get to retrieve values and invoke services., (*11)
$c['a'] == $c->get('a');
Factory or Singleton Services
You can specify if you want to define a service as a factory or singleton with these two helper methods., (*12)
$c->singleton('a', function() {
return new ServiceA();
});
$c->factory('b', function() {
return new ServiceB();
});
// $c['a'] === $c['a'] - same instance each time
// $c['b'] !== $c['b'] - different instance each time
Parameters/Values
Anything added to the container that isn't a service is defined as value., (*13)
$c['a.parameter'] = 'value';
$c['a'] = function($c) {
return new ServiceA($c['a.parameter']);
};
Values are stored and retrieved as is. No processing is done to them., (*14)
If you want to use a closure as a parameter, you can use the protect method:, (*15)
$func = function() {};
$c->protect('a.closure_parameter', $func);
// it returns the same instance because values are just stored as is.
// $c['a.closure_parameter'] === $func
Env Parameters
You can register parameters to be read from the environment with the env method:, (*16)
$c->env('APP_KEY', $alias = 'application.key');
// $c['APP_KEY'] === $c['application.key'] are read from the env
Wrapping Services
Similar to Pimple's extend, Cargo allows you to wrap service definitions for decoration., (*17)
If you want to replace a definition, you would simply redefine it; however, if you want to decorate or modify a definition, you wrap it:, (*18)
$c['logger'] = function() {
return new Logger();
};
$c->wrap('logger', function($logger, $c) {
$logger->setValue($c['value']);
return new MyLogger($logger);
});
// $c['logger'] instanceof MyLogger == true
Service Freezing
Services by default will be frozen due to the FreezingContainer. You can redefine entries as much you'd like, but once a service is invoked, it is considered frozen and will throw an exception if you try to redefine it., (*19)
$c['a'] = function() {};
// ok to redefine because we haven't invoked 'a' yet.
$c['a'] = function() {};
$service = $c['a'];
// this will throw an exception because the service was frozen
$c['a'] = function() {};
Aliasing Entries
It's often useful to use class names as the identifier, but then also provide aliases for a quick reference., (*20)
$c[Acme\ServiceA::class] = function() {
return new Acme\ServiceA();
};
$c->alias(Acme\ServiceA::class, 'acme.service_a', 'a');
// $c[Acme\ServiceA::class] === $c['service_a'] === $c['a']
Auto Wiring
Auto wiring allows the container to try and automatically instantiate services if they aren't already defined in the container. To enable auto-wiring, you need to:, (*21)
- Install the Auto Args Library (
composer install krak/auto-args)
- Use the AutoWireContainer
// the second parameter as true will include the auto wiring
$c = Cargo\container([], $auto_wire = true);
$stack = $c->get('SplStack');
// will return an instance of SplStack as a singleton.
// defines 'StdClass' as a factory instance and will set it up for auto-wiring since no definition was given.
$c->factory('StdClass');
// $c['StdClass'] !== $c['StdClass']
In addition, you can bind any class to be auto wired:, (*22)
$c->singleton('a', SplStack::class);
$c->factory('b', ArrayObject::class);
a and b will resolve to their respective classes. This only works on singleton/factory entries, else it'll just treat the service like a string value and won't try to auto-resolve it., (*23)
Service Providers
Cargo\ServiceProvider provides a simple interface for defining multiple related services., (*24)
interface ServiceProvider {
public function register(Cargo\Container $c);
}
You can register service providers with a given container with the register method:, (*25)
$c->register(new FooProvider(), [
'foo.parameters' => 1,
]); // or Cargo\register($c, new FooProvider(), [])
Container Interop
Krak\Cargo\Container is not compatible with the ContainerInterop interface by default. However, you can easily export the container to an Interop container using the toInterop function., (*26)
$interop = Cargo\toInterop($c); // or $c->toInterop
// $interop instanceof Psr\Container\ContainerInterface
Pimple Interop
Achieving Pimple compatibility is simple with the toPimple function., (*27)
$pimple = Cargo\toPimple($c); // or $c->toPimple()
$pimple['a'] = function() {};
$pimple->extend('a', function() {});
$pimple['b'] = $pimple->protect(function() {
});
// $c has access to all services defined in pimple
$c['b'];
Delegate Containers
In an effort to provide better integration with other containers, we provide delegate containers to allow you to default to a cargo definitions, but fallback to the delegate container., (*28)
ArrayAccessDelegateContainer and PsrDelegateContainer both act as delegate containers. The first will accept any array or ArrayAccess object (like Pimple), and the other will accept any Psr Container., (*29)
<?php
$pimple = new Pimple\Container();
$pimple['a'] = 1;
$pimple['b'] = 1;
$c = Cargo\container();
$c = new Cargo\Container\ArrayAccessDelegateContainer($c, $pimple);
$c['b'] = 2;
assert($c['b'] == 2 && $c['a'] == 1);
Cargo Design
Container Interface for Decoration
To do..., (*30)
Boxes
To do..., (*31)
API
function alias(Container $c, $id, ...$aliases)
Aliases an entry $id into $aliases for the container $c. Each alias will share the same box reference as the original entry., (*32)
function env(Container $c, $var_name, $id = null)
Adds an EnvBox entry into the container $c with $var_name being the name of the env var and $id is the entry name.
If $id is left null, then it will default to $var_name., (*33)
Wallogit.com
