kzykhys/bowl

Yet another dependency injection container for PHP5.4

Bowl, Yet Another Dependency Injection Container (PHP5.4+)

, _(*1)

• Manage multiple environment (production/development/test ...)
• Manage dependencies between objects
• Perform a Lazy instantiation
• Perform a Factory pattern
• No external files to configure dependencies
• You can avoid Singleton/Factory pattern from your classes

Requirements

• PHP5.4+

Installation

Create or update your composer.json and run composer update, _(*2)

``` json { "require": { "kzykhys/bowl": "1.0" } }, <sub>(*3)</sub>

Usage
-----

### Define parameters

``` php
$bowl = new \Bowl\Bowl();
$bowl['lang'] = 'en';
$bowl['debug'] = true;

Define a shared service

``` php $bowl = new \Bowl\Bowl();, <sub>(*4)</sub>

$bowl->share('service_name', function () { return new stdClass(); });, <sub>(*5)</sub>

var_dump($bowl->get('service_name') === $bowl->get('service_name')); // bool(true), <sub>(*6)</sub>

### Define a factory service

``` php
$bowl = new \Bowl\Bowl();

$bowl->factory('service_name', function () {
    return new stdClass();
});

var_dump($bowl->get('service_name') === $bowl->get('service_name')); // bool(false)

Define a service depending on other services

``` php $bowl = new \Bowl\Bowl();, <sub>(*7)</sub>

$bowl->share('driver.mysql', function () { return new MysqlDriver(); });, <sub>(*8)</sub>

$bowl->share('connection', function () { $c = new Connection(); $c->setDriver($this->get('driver.mysql'));, <sub>(*9)</sub>

return $c;

});, <sub>(*10)</sub>

### Using tags to manage a collection of services

``` php
$bowl = new \Bowl\Bowl();

$bowl->share('form.type.text', function () {
    return new TextType();
}, ['form.type']);

$bowl->share('form.type.email', function () {
    return new EmailType();
}, ['form.type']);

$bowl->share('form', function () {
    $form = new Form();

    foreach ($this->getTaggedServices('form.type') as $service) {
        $form->addType($service);
    }

    return $form;
});

Working with environment flag

``` php use Bowl\Bowl;, <sub>(*11)</sub>

$bowl = new Bowl();, <sub>(*12)</sub>

// Common parameters $bowl['lang'] = 'en';, <sub>(*13)</sub>

// Production configuration $bowl->configure('production', function (Bowl $bowl) { $bowl['debug'] = false;, <sub>(*14)</sub>

$bowl->share('orm.repository', function () {
    return new EntityRepository();
});

});, <sub>(*15)</sub>

// Development configuration $bowl->configure('development', function (Bowl $bowl) { $bowl['debug'] = true;, <sub>(*16)</sub>

$bowl->share('orm.repository', function () {
    return new MockRepository();
});

});, <sub>(*17)</sub>

// Common services $bowl->share('orm.manager', function () { return new OrmManager($this->get('orm.repository')); }); $bowl->share('fixture.loader', function () { return new Loader($this->get('orm.manager'), $this['debug']); });, <sub>(*18)</sub>

// Set enviroment manually $bowl->env('production');, <sub>(*19)</sub>

// Or using system's environment variable $bowl->env(getenv('APP_ENV') ? getenv('APP_ENV') : 'production');, <sub>(*20)</sub>

### Real life example

``` php
<?php

require __DIR__ . '/../vendor/autoload.php';

$bowl = new \Bowl\Bowl();

// Set a parameter
$bowl['debug'] = false;

// Shared service
$bowl->share('ciconia.renderer', function () {
    return new \Ciconia\Renderer\HtmlRenderer();
});

// Tagged service
$bowl->share('ciconia.extension.table', function () {
    return new \Ciconia\Extension\Gfm\TableExtension();
}, ['ciconia.extension']);

// This example shows how to manage services using tags
$bowl->share('ciconia', function () {
    $ciconia = new \Ciconia\Ciconia();

    // $bowl is bind to this closure, so you can access $this as Bowl.
    if ($this['debug']) {
        $ciconia = new \Ciconia\Diagnose\Ciconia();
    }

    // Resolve dependencies
    $ciconia->setRenderer($this->get('ciconia.renderer'));

    // All services tagged as "ciconia.extension"
    foreach ($this->getTaggedServices('ciconia.extension') as $extension) {
        $ciconia->addExtension($extension);
    }

    return $ciconia;
});

// Get the object
$ciconia = $bowl->get('ciconia');
echo $ciconia->render('Markdown is *awesome*');

// Create a new instance even if this is a shared object
$ciconia = $bowl->reset('ciconia')->get('ciconia');
echo $ciconia->render('Markdown is *awesome*');

API

Manage environment

configure(string $environment, \Closure $closure)

You can configure Bowl based on environment flags such as production and development., <sub>(*21)</sub>

``` php $bowl = new \Bowl\Bowl(); $bowl->configure('prod', function (\Bowl\Bowl $bowl) { $bowl['debug'] = false; });, <sub>(*22)</sub>

#### env(_string_ **$environment**)

You have to call `env()` to apply one of environments.

``` php
$bowl = new \Bowl\Bowl();
$bowl->configure('prod', function (\Bowl\Bowl $bowl) {
    $bowl['debug'] = false;
});

$bowl->env('prod');

Service container

share(string $name, \Closure $closure, [_array_ $tags])

Register a shared service, <sub>(*23)</sub>

``` php $bowl = new \Bowl\Bowl(); $bowl->share('logger', function () { return new Logger(); });, <sub>(*24)</sub>

$bowl->get('logger')->log($message);, <sub>(*25)</sub>

#### factory(_string_ **$name**, _\Closure_ **$closure**, \[_array_ **$tags**\])

Register a factory service

``` php
$bowl = new \Bowl\Bowl();
$bowl->share('date.now', function () {
    return new \DateTime('now');
});

$bowl->get('date.now')->format('r');

extend(string $name, \Closure $closure)

Extend a service definition, <sub>(*26)</sub>

``` php $bowl = new \Bowl\Bowl(); $bowl->share('logger', function () { return new Logger(); });, <sub>(*27)</sub>

$bowl->extend('logger', function (LoggerInterface $logger) { $logger->setPath(DIR.'/../app/logs');, <sub>(*28)</sub>

return $logger;

});, <sub>(*29)</sub>

$bowl->get('logger')->log($message);, <sub>(*30)</sub>

#### get(_string_ **$name**)

Get an object

``` php
$bowl = new \Bowl\Bowl();
$bowl['debug'] = true;
$bowl->factory('filesystem', function () {
    return new Filesystem();
});
$bowl->share('logger', function () {
    if ($this['debug']) {
        return new ConsoleLogger();
    } else {
        return new FilesystemLogger($this->get('filesystem'));
    }
});

$logger = $bowl->get('logger');

getTaggedServices(string $name)

Get services having a tag, <sub>(*31)</sub>

``` php $bowl = new \Bowl\Bowl(); $bowl->share('transport.smtp', function () { return new SmtpTransport(); }, ['email.transport']); $bowl->share('transport.sendmail', function () { return new SendmailTransport(); }, ['email.transport']); $bowl->share('mailer', function () { $mailer = new Mailer(); foreach ($this->getTaggedServices('email.transport') as $service) { $mailer->addTransport($service); }, <sub>(*32)</sub>

return $mailer;

});, <sub>(*33)</sub>

$bowl->get('mailer')->send($mimeMessage);, <sub>(*34)</sub>

#### reset(_string_ **$name**)

Re-instantiate the object, even if the service is shared object.

**This is unsafe operation**

``` php
$bowl = new \Bowl\Bowl();
$bowl->share('registry', function () {
    return new Registry();
});

try {
    $bowl->get('registry')->getManager()->flush();
} catch (\Exception $e) {
    $bowl->reset('registry');
}

Contributing

Feel free to fork and send a pull request., <sub>(*35)</sub>

License

The MIT License, <sub>(*36)</sub>

Author

Kazuyuki Hayashi (@kzykhys), <sub>(*37)</sub>