• Navigation
•  Construction and Parameters
• Reading a parameter
• Setting a parameter
• Check if parameter exists
•  Getting services / status
• Getting a service
• Available services
• Has service
• Is service resolved
•  Binding / Setting Services
• Bind service
• Set service
• Releasing / Removing services
• Release service
• Remove service

Basic Container usage

As already stated and in the Getting started guide, there are multiple ways to construct an instnace of the service container. But in the end it does not really matter if a container is generated using the factory or is created dynamically, the usage / API of the container instance is the same for all of them.

#   Construction and Parameters

The constructor of the container always accepts an inital array of dynamic parameters.

use ClanCats\Container\Container;
$container = Container(['env' => 'production']);

This also works if you construct the container instance using a factory:

$factory = new \ClanCats\Container\ContainerFactory(__DIR__ . '/cache');
$container = $factory->create('AppContainer', function($builder) {}, ['env' => 'production']);

The given inital parameters will be merged with already defined parameters.

#  Reading a parameter

This method really does not require to explain alot, thats why im wasting your time with this sentence.

$container->getParameter('env');

You can get a parameter with a fallback value. The fallback value will be returned if the parameter has not been defined. If the parameter is null the default value won't be returned.

$container->getParameter('cron.idle.timeout', 3600);

public function getParameter(string $name, $default = null)

#  Setting a parameter

I like to think of parameters as configuration values that are more or less scalar, but there is no limitation on what a parameter can be. You could assign objects as parameters but that does not mean you should.

$container->setParameter('session.cookie.name', 'mysessiontoken');

$container->setParameter('available.languages', ['de', 'en', 'it', 'fr']);

public function setParameter(string $name, $value)

#  Check if parameter exists

Sometimes you just need to know if a parameter exists. If a parameter is null it still exists!

public function hasParameter(string $name) : bool

#   Getting services / status

#  Getting a service

Gets the service with the given name from the container. This method will also construct the service if it has not been requested before or is of type prototype.

$container->get('repository.comment');

The name container is the only reserved one, and will always refer to the container itself;

$container->get('container'); // === $container

If a service does not exist the container will throw an UnknownServiceException if it is requested. So you should either catch the exeption or check if the servie exists beforehand if you don't trust your dependency tree.

if ($container->has('not.sure.if.exists')) {
    $container->get('not.sure.if.exists'); // do something with it
}

try {
    $container->get('not.sure.if.exists');
} catch(ClanCats\Container\Exceptions\UnknownServiceException $e) {
    // do something its not there.
}

public function get(string $serviceName)

#  Available services

Working on debugging tools and just need to know what services would be available?

echo implode(', ', $container->available());

public function available() : array

#  Has service

public function has(string $serviceName) : bool

#  Is service resolved

If you need to know if a service has already been loaded / requested / resolved you can make use of the isResolved method. This is also mainly usefull for profiling and debugging.

foreach($container->available() as $serviceKey) {
    echo "@{$serviceKey}: " . ($conatiner->isResolved(serviceKey) ? 'yes' : 'no') . PHP_EOL;
}

public function isResolved(string $serviceName) : bool

#   Binding / Setting Services

You can bind new services to the container at any given time. Again this does not depend on how you build / construct your container instance. You can mix dynamic services binding with compiled ones. There is no technical pittfall doing so but for sake of consistency I would stick with one way.

#  Bind service

Autogenerate & return the service factory:

$contanier->bind('enterprise', SpaceShip::class)
    ->arguments(['USS Enterprise']);

When the service factory is autogenerated the bind method will return the factory object. This is why we can call the arguments method right after binding. This is the only case where the bind method returns something.

Pass a service factory as argument:

$contanier->bind('enterprise', new ServiceFactory('\\SpaceShip', ['USS Enterprise']));

In this case the bind method won't return the ServiceFactory object because it is already under your control. Note that we pass the service arguments directly to the service factory.

Using a closure:

$contanier->bind('enterprise', function($c) 
{
    return new SpaceShip('USS Enterprise');
});

$container->bind('session', new SessionFactory);

$container->bind('config', function($c) {
     return new Config($c->get('config.loader'));
}, false);

$container->bind('router', '\\Routing\\Router')
    ->addDependencyArgument('config');

public function bind(string $name, $factory, bool $shared = true)

#  Set service

There probably will come the day where you need to simply inject something into container, for this purpose we have the set method.

$objectISomehowNeedToCreateHere = new Thing();

$contanier->set('thing', $objectISomehowNeedToCreateHere);

public function set(string $serviceName, $serviceValue)

#  Releasing / Removing services

#  Release service

This method will remove the in the container stored instance of the service. But if I understand PHP right every object is kind of a shared pointer. Means as long as you store a reference to the resolved object it won't get released. (Correct me if im wrong here.)

$container->release('db.connection');

public function release(string $serviceName) : bool

#  Remove service

$container->remove('kernel'); // dangerous?

This will if possible release the resolevd instance and remove the service definition from the container.

public function remove(string $serviceName) : bool