Code Generator

zend-di comes with Ahead-of-Time (AoT) generators to create optimized code for production. These generators will inspect the provided classes, resolve their dependencies, and generate factories based on these results.

Removal of zend-code dependencies

Before version 3.1, this feature required zend-code, which you can add to your project using Composer:

$ composer require --dev zendframework/zend-code

Since version 3.1 and up, this is no longer required.

Generating an optimized injector

The Zend\Di\CodeGenerator\InjectorGenerator class offers an implementation to generate an optimized injector based on the runtime configuration and a resolver instance.

use Zend\Di\Config;
use Zend\Di\Definition\RuntimeDefinition;
use Zend\Di\Resolver\DependencyResolver;
use Zend\Di\CodeGenerator\InjectorGenerator;

$config = new Config();
$resolver = new DependencyResolver(new RuntimeDefinition(), $config)
$generator = new InjectorGenerator($config, $resolver);

// It is highly recommended to set the container that is used at runtime:
$resolver->setContainer($container);
$generator->setOutputDirectory('/path/to/generated/files');
$generator->generate([
    MyClassA::class,
    MyClassB::class,
    // ...
]);

You can also utilize Zend\Code\Scanner to scan your code for classes:

$scanner = new DirectoryScanner(__DIR__);
$generator->generate($scanner->getClassNames());

MVC and Expressive integration

When you are using zend-di's ConfigProvider with Expressive or consuming the Module class via zend-mvc, you can obtain the generator instance from the service manager:

$generator = $serviceManager->get(\Zend\Di\CodeGenerator\InjectorGenerator::class);

AoT Config Options

The service factory uses options in your config service, located under the key dependencies.auto.aot. This should be defined as an associative array of options for creating the code generator instance. This array respects the following keys (unknown keys are ignored):

  • namespace: This will be used as base namespace to prefix the namespace of the generated classes. It will be passed to the constructor of Zend\Di\CodeGenerator\InjectorGenerator; the default value is Zend\Di\Generated.

  • directory: The directory where the generated PHP files will be stored. If this value is not provided, you will need to set it with the generator's setOutputDirectory() method before calling generate().

Below is an example detailing configuration of the generator factory:

return [
    'dependencies' => [
        'auto' => [
            'aot' => [
                'namespace' => 'AppAoT\Generated',
                'directory' => __DIR__ . '/../gen',
            ],
        ],
    ],
];

Logging

The InjectorGenerator allows passing a PSR-3 logger instance via an optional fourth constructor parameter.

The generator will log the following information:

  • When a factory is about to be generated for a class or alias (Log level: Debug)
  • When the factory generation caused an exception (Log level: Error)

Found a mistake or want to contribute to the documentation? Edit this page on GitHub!