Yii - Inyección de dependencia
Un contenedor DI (inyección de dependencia) es un objeto que sabe cómo crear instancias y configurar objetos. Yii proporciona el contenedor DI a través delyii\di\Container class.
Es compatible con los siguientes tipos de DI:
- Inyección de setter y propiedad
- Inyección invocable de PHP
- Inyección de constructor
- Inyección de acción del controlador
El contenedor DI admite la inyección del constructor con la ayuda de sugerencias de tipo:
class Object1 {
public function __construct(Object2 $object2) {
}
}
$object1 = $container->get('Object1');
// which is equivalent to the following:
$object2 = new Object2;
$object1 = new Object1($object2);
Las inyecciones de propiedades y setter son compatibles mediante configuraciones:
<?php
use yii\base\Object;
class MyObject extends Object {
public $var1;
private $_var2;
public function getVar2() {
return $this->_var2;
}
public function setVar2(MyObject2 $var2) {
$this->_var2 = $var2;
}
}
$container->get('MyObject', [], [
'var1' => $container->get('MyOtherObject'),
'var2' => $container->get('MyObject2'),
]);
?>
En el caso de la inyección invocable de PHP, el contenedor usará una devolución de llamada PHP registrada para construir nuevas instancias de una clase -
$container->set('Object1', function () {
$object1 = new Object1(new Object2);
return $object1;
});
$object1 = $container->get('Object1');
La inyección de acción del controlador es un tipo de DI donde las dependencias se declaran utilizando las sugerencias de tipo. Es útil para mantener los controladores MVC delgados, livianos y delgados.
public function actionSendToAdmin(EmailValidator $validator, $email) {
if ($validator->validate($email)) {
// sending email
}
}
Puedes usar el yii\db\Container::set() método para registrar dependencias -
<?php
$container = new \yii\di\Container;
// register a class name as is. This can be skipped.
$container->set('yii\db\Connection');
// register an alias name. You can use $container->get('MyObject')
// to create an instance of Connection
$container->set('MyObject', 'yii\db\Connection');
// register an interface
// When a class depends on the interface, the corresponding class
// will be instantiated as the dependent object
$container->set('yii\mail\MailInterface', 'yii\swiftmailer\Mailer');
// register an alias name with class configuration
// In this case, a "class" element is required to specify the class
$container->set('db', [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=127.0.0.1;dbname = helloworld',
'username' => 'vladimir',
'password' => '12345',
'charset' => 'utf8',
]);
// register a class with configuration. The configuration
// will be applied when the class is instantiated by get()
$container->set('yii\db\Connection', [
'dsn' => 'mysql:host=127.0.0.1;dbname = helloworld',
'username' => 'vladimir',
'password' => '12345',
'charset' => 'utf8',
]);
// register a PHP callable
// The callable will be executed each time when $container->get('db') is called
$container->set('db', function ($container, $params, $config) {
return new \yii\db\Connection($config);
});
// register a component instance
// $container->get('pageCache') will return the same instance each time when it
//is called
$container->set('pageCache', new FileCache);
?>
Usando el DI
Step 1 - Dentro del components carpeta crea un archivo llamado MyInterface.php con el siguiente código.
<?php
namespace app\components;
interface MyInterface {
public function test();
}
?>
Step 2 - Dentro de la carpeta de componentes, cree dos archivos.
First.php -
<?php
namespace app\components;
use app\components\MyInterface;
class First implements MyInterface {
public function test() {
echo "First class <br>";
}
}
?>
Second.php -
<?php
app\components;
use app\components\MyInterface;
class Second implements MyInterface {
public function test() {
echo "Second class <br>";
}
}
?>
Step 3 - Ahora, agregue un actionTestInterface al SiteController.
public function actionTestInterface() {
$container = new \yii\di\Container();
$container->set
("\app\components\MyInterface","\app\components\First");
$obj = $container->get("\app\components\MyInterface");
$obj->test(); // print "First class"
$container->set
("\app\components\MyInterface","\app\components\Second");
$obj = $container->get("\app\components\MyInterface");
$obj->test(); // print "Second class"
}
Step 4 - Ir a http://localhost:8080/index.php?r=site/test-interface debería ver lo siguiente.
Este enfoque es conveniente ya que podemos establecer clases en un lugar y otro código usará nuevas clases automáticamente.