Download the PHP package koriym/dii without Composer

Dii

Dependency Injection Container Plugin for Yii 1

This plugin adds the ability to configure object instances and their dependencies before they are used, and to store them into a container class to easy access.

It uses the clean and flexible Ray.Di DI framework which is a PHP dependency injection framework in the style of "Google Guice".

Ray.Di also allows you to program using AOP, that is, decorating the configured instances so some logic can be run before or after any of their methods.

Configuration

Bootstrap file

Use composer autoloader instead of Yii autoloader.

Binding module

Modules are classes that describe how instances and their dependencies should be constructed, they provide a natural way of grouping configurations. An example module looks like this:

Context

You can make the necessary bindings depending on the context. The context class specifies which module to bind in.

In this example we have overridden the binding of AppModule with TestModule.

Caching

By default Dii::setContext() rebuilds the object graph (the Ray.Di Grapher) on every call, so changes to your modules always take effect.

In production, pass FileCache to cache the graph and skip the costly rebuild. It stores the graph as a <?php return '...'; file so OPcache keeps it in memory.

The cache key is the context class name, not a hash of your module graph: FileCache never notices that AppModule::configure() itself changed. Clear the cache directory (e.g. rm -rf tmp/* before warming it back up) as part of your deploy step whenever module bindings change; otherwise a deploy can silently keep serving the previous graph.

To use your own storage (APCu, PSR-16, etc.), implement CacheInterface:

Injecting Dependencies in Controllers

Ray.Di is able to inject instances to your controllers based on the #[Inject] attribute:

As soon as the controller is created, all methods with the #[Inject] attribute will get instances of the hinted class passed. This works only for setter methods, not constructors. Please implement the marker interface Injectable to notify Ray.Di that the class is injectable.

With older, annotation-based Ray.Di (< 2.16), the @Inject docblock annotation works as well.

Bind your injectable controllers

Ray.Di resolves bindings at compile time, so each Injectable controller or console command must be bound in your module. If it is not bound, Ray.Di raises Untargeted and the request fails fast. Dii no longer auto-binds the concrete class at runtime: that silent fallback was not AOP-compiled, so it behaved differently from a module binding and the missing binding went unnoticed (especially at compile time).

Also any class created by Yii:createComponent() method is worked as well.

InjectableModule

Use InjectableModule to bind every Injectable class in flat Yii controller or command directories at compile time:

The scan is non-recursive and only top-level *.php files declaring classes that implement Koriym\Dii\Injectable are bound. Pass each subdirectory explicitly when it should be scanned. Abstract classes are skipped because they cannot be instantiated.

A scan path that does not exist throws Koriym\Dii\Exception\DirectoryNotFound during module configuration, so a misconfigured path fails fast at compile time.

Demo

cd demo
composer install
composer serve