Dependency injection - phpday 2010

Dependency Injection
with PHP 5.3

Fabien Potencier

Fabien Potencier
Serial entrepreneur
Developer by passion
Founder of Sensio
Creator and lead developer of Symfony
On Twitter @fabpot
On github http://www.github.com/fabpot
Blog http://fabien.potencier.org/


A real world « web » example

In most web applications, you need to manage the user preferences

–  The user language
–  Whether the user is authenticated or not
–  The user credentials
–  …

This can be done with a User object

–  setLanguage(), getLanguage()
–  setAuthenticated(), isAuthenticated()
–  addCredential(), hasCredential()
–  ...

The User information
need to be persisted
between HTTP requests

We use the PHP session for the Storage

class SessionStorage
{
function __construct($cookieName = 'PHP_SESS_ID')
{
session_name($cookieName);
session_start();
}

function set($key, $value)
{
$_SESSION[$key] = $value;
}

// ...
}

class User
{
protected $storage;

function __construct() Very hard to
{ customize
$this->storage = new SessionStorage();
}

function setLanguage($language)
{
$this->storage->set('language', $language);
}

// ...
} Very easy
to use
$user = new User();

class User
{
protected $storage; Very easy to
customize
function __construct($storage)
{
$this->storage = $storage;
}
}

$storage = new SessionStorage();
$user = new User($storage);
Slightly more
difficult to use

That’s Dependency Injection

Nothing more

Let’s understand why the ﬁrst example
is not a good idea

I want to change the session cookie name

class User
{
protected $storage;

function __construct()
Hardcode it in the
{ User class
$this->storage = new SessionStorage('SESSION_ID');
}

function setLanguage($language)
{
$this->storage->set('language', $language);
}

// ...
}

$user = new User();

class User
{
protected $storage;

{
$this->storage = new SessionStorage(STORAGE_SESSION_NAME);
}
}
Add a global
configuration?
define('STORAGE_SESSION_NAME', 'SESSION_ID');

$user = new User();

class User
{
protected $storage;

function __construct($sessionName)
{
$this->storage = new SessionStorage($sessionName);
}
}

$user = new User('SESSION_ID');
Configure via
User?

class User
{
protected $storage;

function __construct($storageOptions)
{
$this->storage = new SessionStorage($storageOptions
['session_name']);

$user = new User(
array('session_name' => 'SESSION_ID')
);
Configure with an
array?

I want to change the session storage implementation

Filesystem
MySQL
Memcached
…

class User
{
protected $storage;

function __construct() Use a global
{ registry object?
$this->storage = Registry::get('session_storage');
}
}

Registry::set('session_storage', $storage);
$user = new User();

Now, the User depends on the Registry

Instead of harcoding
the Storage dependency
inside the User class constructor

Inject the Storage dependency
in the User object

class User
{
protected $storage;

{
}
}

$storage = new SessionStorage('SESSION_ID');

Use diﬀerent Storage strategies

class User
{
protected $storage;

{
}
} Use a different
Storage engine
$storage = new MySQLSessionStorage('SESSION_ID');

Conﬁguration becomes natural

class User
{
protected $storage;

{
}
} Configuration
is natural
$storage = new MySQLSessionStorage('SESSION_ID');

Wrap third-party classes (Interface / Adapter)

class User
{
protected $storage;
Add an interface
function __construct(SessionStorageInterface $storage)
{
}
}

interface SessionStorageInterface
{
function get($key);

function set($key, $value);
}

Mock the Storage object (for testing)

class User
{
protected $storage;

function __construct(SessionStorageInterface $storage)
{
}
}
Mock the Session
class SessionStorageForTests implements SessionStorageInterface
{
protected $data = array();

static function set($key, $value)
{
self::$data[$key] = $value;
}
}

Use diﬀerent Storage strategies
Conﬁguration becomes natural
Wrap third-party classes (Interface / Adapter)
Mock the Storage object (for testing)

Easy without changing the User class

« Dependency Injection is where
components are given their dependencies
through their constructors, methods, or
directly into ﬁelds. »
http://www.picocontainer.org/injection.html


// constructor injection

// setter injection
$user = new User();
$user->setStorage($storage);

// property injection
$user = new User();
$user->storage = $storage;

A slightly more complex
web example

$request = new Request();
$response = new Response();

$storage = new FileSessionStorage('SESSION_ID');

$cache = new FileCache(
array('dir' => dirname(__FILE__).'/cache')
);
$routing = new Routing($cache);

class Application
{
{
$this->request = new WebRequest();
$this->response = new WebResponse();

$storage = new FileSessionStorage('SESSION_ID');
$this->user = new User($storage);

$cache = new FileCache(
array('dir' => dirname(__FILE__).'/cache')
);
$this->routing = new Routing($cache);
}
}

$application = new Application();

We need a Container
Describes objects
and their dependencies

Instantiates and conﬁgures
objects on-demand

A container
SHOULD be able to manage
ANY PHP object (POPO)

The objects MUST not know
that they are managed
by a container

•  Parameters
–  The SessionStorageInterface implementation we want to use (the class name)
–  The session name
•  Objects
–  SessionStorage
–  User
•  Dependencies
–  User depends on a SessionStorageInterface implementation

Let’s build a simple container with PHP 5.3

DI Container

Managing parameters

class Container
{
protected $parameters = array();

public function setParameter($key, $value)
{
$this->parameters[$key] = $value;
}

public function getParameter($key)
{
return $this->parameters[$key];
}
}

Decoupling

$container = new Container(); Customization
$container->setParameter('session_name', 'SESSION_ID');
$container->setParameter('storage_class', 'SessionStorage');

$class = $container->getParameter('storage_class');
$sessionStorage = new $class($container->getParameter('session_name'));
$user = new User($sessionStorage);
Objects creation

class Container Using PHP
{ magic methods

public function __set($key, $value)
{
}

public function __get($key)
{
return $this->parameters[$key];
}
}

Interface
is cleaner

$container = new Container();
$container->session_name = 'SESSION_ID';
$container->storage_class = 'SessionStorage';

$sessionStorage = new $container->storage_class($container->session_name);
$user = new User($sessionStorage);

DI Container

Managing objects

We need a way to describe how to create objects,
without actually instantiating anything!

Anonymous functions to the rescue!

Anonymous Functions / Lambdas

A lambda is a function
deﬁned on the ﬂy
with no name

function () { echo 'Hello world!'; };


A lambda can be stored
in a variable

$hello = function () { echo 'Hello world!'; };


And then it can be used
as any other PHP callable

$hello();

call_user_func($hello);


You can also pass a lambda
as an argument to a function or method

function foo(Closure $func)
{
$func();
}

foo($hello);

Fonctions anonymes
$hello = function ($name) { echo 'Hello '.$name; };

$hello('Fabien');

call_user_func($hello, 'Fabien');

function foo(Closure $func, $name)
{
$func($name);
}

foo($hello, 'Fabien');

class Container
{
protected $objects = array();

public function __set($key, $value)
{
}

public function __get($key) Store a lambda
{
return $this->parameters[$key]; able to create the
object on-demand
}

public function setService($key, Closure $service)
{
$this->objects[$key] = $service;
}

public function getService($key) Ask the closure to create
{
return $this->objects[$key]($this); th e object and pass the
}
} current Container

$container->session_name = 'SESSION_ID'; Description
$container->setService('user', function ($c)
{
return new User($c->getService('storage'));
});
$container->setService('storage', function ($c)
{
return new $c->storage_class($c->session_name);
});

Creating the User
is now as easy as before
$user = $container->getService('user');

class Container
{
protected $values = array(); Simplify the code
function __set($id, $value)
{
$this->values[$id] = $value;
}

function __get($id)
{
if (is_callable($this->values[$id]))
{
return $this->values[$id]($this);
}
else
{
return $this->values[$id];
}
}
}

Unified interface
$container->session_name = 'SESSION_ID';
$container->user = function ($c)
{
return new User($c->storage);
};
$container->storage = function ($c)
{
return new $c->storage_class($c->session_name);
};

$user = $container->user;

For some objects, like the user,
the container must always
return the same instance

spl_object_hash($container->user)

!==

$container->user = function ($c)
{
static $user;

if (is_null($user))
{
$user = new User($c->storage);
}

return $user;
};


===

$container->user = $container->asShared(function ($c)
{
return new User($c->storage);
});

A closure is a lambda
that remembers the context
of its creation…

class Article
{
public function __construct($title)
{
$this->title = $title;
}

public function getTitle()
{
return $this->title;
}
}

$articles = array(
new Article('Title 1'),
new Article('Title 2'),
);

$mapper = function ($article)
{
return $article->getTitle();
};

$titles = array_map($mapper, $articles);

$method = 'getTitle';

$mapper = function ($article) use($method)
{
return $article->$method();
};

$method = 'getAuthor';

$titles = array_map($mapper, $articles);

$mapper = function ($method)
{
return function ($article) use($method)
{
return $article->$method();
};
};

$titles = array_map($mapper('getTitle'), $articles);

$authors = array_map($mapper('getAuthor'), $articles);

function asShared(Closure $lambda)
{
return function ($container) use ($lambda)
{
static $object;

if (is_null($object))
{
$object = $lambda($container);
}
return $object;
};
}

class Container
{
protected $values = array();

{
}

function __get($id)
{ Error management
if (!isset($this->values[$id]))
{
throw new InvalidArgumentException(sprintf('Value "%s" is not defined.', $id));
}

{
}
else
{
}
}
}

class Container
{
protected $values = array();

{
}

function __get($id)
{
if (!isset($this->values[$id]))
{
throw new InvalidArgumentException(sprintf('Value "%s" is not defined.', $id));
}

{
}
else
{
}
}

function asShared($callable)
{

40 LOC for a fully-
return function ($c) use ($callable)
{
static $object;

if (is_null($object))
{
$object = $callable($c);
featured container
}
return $object;
};
}
}

I’m NOT advocating
the usage of lambdas everywhere

This presentation is about
showing how they work
on practical examples

A DI Container
does NOT manage
ALL your objects

Good rule of thumb:
It manages “Global” objects

Objects with only one instance (!= Singletons)

LIKE
a User, a Request,
a database Connection, a Logger, …

UNLIKE
Model objects (a Product, a blog Post, …)

Symfony Components

Rock-solid implementation of a DIC in PHP 5.3

At the core of the Symfony 2.0 framework

… which is one of the fastest framework

Very ﬂexible

Conﬁguration in PHP, XML, YAML, or INI

$container = new Builder();

$container->register('output', 'FancyOutput');
$container->
register('message', 'Message')->
setArguments(array(
new sfServiceReference('output'),
array('with_newline' => true)
))
;

$container->message->say('Hello World!');

services:
output: { class: FancyOutput }
message:
class: Message
arguments:
- @output
- { with_newline: true }

<container xmlns="http://symfony-project.org/schema/dic/services">
<import resource="parameters.yml" />
<import resource="parameters.ini" />
<import resource="services.xml" />
</container>

imports:
- { resource: parameters.yml }
- { resource: parameters.ini }
- { resource: services.xml }

As fast as it can be
The container can be
“compiled” down
to plain PHP code

use SymfonyComponentsDependencyInjectionContainer;
use SymfonyComponentsDependencyInjectionReference;
use SymfonyComponentsDependencyInjectionParameter;

class ProjectServiceContainer extends Container
{
protected $shared = array();

protected function getOutputService()
{
if (isset($this->shared['output'])) return $this->shared['output'];

$instance = new FancyOutput();

return $this->shared['output'] = $instance;
}

protected function getMessageService()
{
if (isset($this->shared['message'])) return $this->shared['message'];

$instance = new Message($this->getOutputService(), array('with_newline' => true));

return $this->shared['message'] = $instance;
}
}

Semantic conﬁguration
Thanks to an extension mechanism

<container xmlns="http://www.symfony-project.org/schema/dic/services">

<zend:logger
priority="debug"
path="%kernel.root_dir%/logs/%kernel.environment%.log" />

<doctrine:dbal dbname="dbname" username="root" password="" />

<swift:mailer transport="gmail">
<swift:username>fabien.potencier</swift:username>
<swift:password>xxxxxx</swift:password>
</swift:mailer>

</container>

<container xmlns="http://www.symfony-project.org/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:swift="http://www.symfony-project.org/schema/dic/swiftmailer"
xmlns:doctrine="http://www.symfony-project.org/schema/dic/doctrine"
xmlns:zend="http://www.symfony-project.org/schema/dic/zend"
xsi:schemaLocation="http://www.symfony-project.org/schema/dic/services http://www.symfony-
project.org/schema/dic/services/services-1.0.xsd
http://www.symfony-project.org/schema/dic/doctrine http://www.symfony-
project.org/schema/dic/doctrine/doctrine-1.0.xsd
http://www.symfony-project.org/schema/dic/swiftmailer http://
www.symfony-project.org/schema/dic/swiftmailer/swiftmailer-1.0.xsd">

<zend:logger priority="debug" path="%kernel.root_dir%/logs/%kernel.environment%.log" />

auto-completion
<doctrine:dbal dbname="dbname" username="root" password="" />

<swift:mailer transport="gmail"> and validation
<swift:username>fabien.potencier</swift:username>
<swift:password>xxxxxx</swift:password> with XSD
</swift:mailer>

</container>

zend.logger:
level: debug
path: %kernel.root_dir%/logs/%kernel.environment%.log

doctrine.dbal:
dbname: dbname
username: root
password: ~

swift.mailer:
transport: gmail
username: fabien.potencier
password: xxxxxxx

Everything is converted by the extension
to plain services and parameters
no overhead

Loader::registerExtension(new SwiftMailerExtension());
Loader::registerExtension(new DoctrineExtension());
Loader::registerExtension(new ZendExtension());

$loader = new XmlFileLoader(__DIR__);
$config = $loader->load('services.xml');

$container = new Builder();
$container->merge($config);

$container->mailer->...

$dumper = new PhpDumper($container);
echo $dumper->dump();

More about Dependency Injection
http://fabien.potencier.org/article/17/on-php-5-3-lambda-functions-and-closures

http://components.symfony-project.org/dependency-injection/ (5.2)

http://github.com/fabpot/symfony/tree/master/src/Symfony/Components/DependencyInjection/(5.3)

http://github.com/fabpot/pimple

http://twittee.org/

Remember, most of the time,
you don’t need a Container
to use Dependency Injection

You can start to use and beneﬁt from
Dependency Injection today

by implementing it
in your projects

by using externals libraries
that already use DI
without the need of a container

Symfony
Zend Framework
ezComponents
Doctrine
Swift Mailer
…

Questions?

My slides will be available on
slideshare.com/fabpot

Sensio S.A.
92-98, boulevard Victor Hugo
92 115 Clichy Cedex
FRANCE
Tél. : +33 1 40 99 80 80

Contact
Fabien Potencier
fabien.potencier at sensio.com

http://www.sensiolabs.com/
http://www.symfony-project.org/
http://fabien.potencier.org/

Dependency injection - phpday 2010

More Related Content

What's hot

Similar to Dependency injection - phpday 2010

More from Fabien Potencier

Recently uploaded

Dependency injection - phpday 2010