library zf-dependency-injection

reinfi/zf-dependency-injection

A Zend Framework module for loading dependencies via annotation or config entries.

Configure dependency injection in Laminas or Mezzio using attributes (PHP 8.0+), yaml or autowiring., _(*1)

Heavily inspired by https://github.com/mikemix/mxdiModule., _(*2)

=======, _(*3)

1. Installation
2. AutoWiring
3. Attributes
4. Annotations (Deprecated)
5. YAML (Deprecated)
6. Caching
7. PHPStan Extension
8. Rector Sets
9. Console commands

Installation

1. Install with Composer: composer require reinfi/zf-dependency-injection.
2. Enable the module via config in application.config.php under modules key:

    return [
        'modules' => [
            'Reinfi\DependencyInjection',
            // other modules
        ],
    ];

AutoWiring

To use autowiring for your service, you need to specify the 'AutoWiringFactory' within the service manager configuration., _(*4)

'service_manager' => [
    'factories' => [
        YourService::class => \Reinfi\DependencyInjection\Factory\AutoWiringFactory::class,
    ],
]

Fallback AutoWiring

If you are migrating your existing project to use zend service manager and don't want to register all autowired services by hand, you can register the abstract FallbackAutoWiringFactory factory., _(*5)

Please make sure that you don't use the fallback mechanism for everything. You should try to write and register explicit factories for your services., _(*6)

'service_manager' => [
    'abstract_factories' => [
        \Reinfi\DependencyInjection\AbstractFactory\FallbackAutoWiringFactory::class,
    ],
]

What can be autowired?

Every service registered within the service manager can be autowired. Plugins within the plugin manager can also be autowired. If you need to register another mapping, you can add the following:, _(*7)

PluginManagerResolver::addMapping('MyInterfaceClass', 'MyPluginManager');

If your service needs the container as a dependency, this can also be autowired., _(*8)

Add another resolver

If you like to add another resolver, you can add one through the configuration., _(*9)

'reinfi.dependencyInjection' => [
    'autowire_resolver' => [
        AnotherResolver::class,
    ],
]

It needs to implement the ResolverInterface., _(*10)

Attributes

Attributes are activated if you are using a php version 8.0 or higher. To use attributes for your dependencies, you need to specify the 'InjectionFactory' within the service manager configuration., _(*11)

'service_manager' => [
    'factories' => [
        YourService::class => \Reinfi\DependencyInjection\Factory\InjectionFactory::class,
    ],
]

The following attributes are supported: * Inject (directly injects a service from the service locator) * InjectParent (must be used if you inject a service from a plugin manager) * InjectConfig (dot-separated path to a config value, e.g., service_manager.factories) * InjectContainer (directly inject container interface), _(*12)

Also, in addition, there are several annotations to inject from plugin managers. * InjectViewHelper * InjectFilter * InjectInputFilter * InjectValidator * InjectHydrator * InjectFormElement, _(*13)

You can either pass directly the required service name, or if you need options, you can pass them as follows:, _(*14)

#[InjectFormElement(name="Service", options={"field": "value"}]

If you need a doctrine repository, there is also an attribute. * InjectDoctrineRepository, _(*15)

It is only constructor injection supported, if you need di from setters, you need to use delegator factories., _(*16)

You can add the attributes at properties or at the __construct method., _(*17)

#[Inject("Namespace\MyService")] 
private MyService $service;

public function __construct(MyService $service) 
{
    $this->service = $service;
}

or, _(*18)

private MyService $service;

#[Inject("Namespace\MyService")] 
public function __construct(MyService $service) 
{
    $this->service = $service;
}

The order is important and you should decide between constructor or property annotations., _(*19)

Annotations (Deprecated)

Note: Annotations are deprecated and will be removed in a future version. Please use Attributes instead, which provide the same functionality with a more modern syntax., _(*20)

To use annotations for your dependencies you need to specify the 'InjectionFactory' within the service manager configuration., _(*21)

'service_manager' => [
    'factories' => [
        YourService::class => \Reinfi\DependencyInjection\Factory\InjectionFactory::class,
    ],
]

The following annotations are supported: * Inject (directly injects a service from the service locator) * InjectParent (must be used if you inject a service from a plugin manager) * InjectConfig (dot-separated path to a config value, e.g., service_manager.factories) * InjectContainer (directly inject container interface), _(*22)

Also, in addition, there are several annotations to inject from plugin managers. * InjectViewHelper * InjectFilter * InjectInputFilter * InjectValidator * InjectHydrator * InjectFormElement, _(*23)

You can either pass directly the required service name, or if you need options, you can pass them as follows:, _(*24)

@InjectFormElement(name="Service", options={"field": "value"})

If you need a doctrine repository, there is also an annotation. * InjectDoctrineRepository, _(*25)

It is only constructor injection supported, if you need di from setters, you need to use delegator factories., _(*26)

You can add the annotations at properties or at the __construct method., _(*27)

use Reinfi\DependencyInjection\Annotation\Inject;

/**
 * @Inject("Namespace\MyService")
 */
private MyService $service;

/**
 * @param MyService $service
 */
public function __construct(
    MyService $service,
) {
    $this->service = $service;
}

or, _(*28)

use Reinfi\DependencyInjection\Annotation\Inject;

/**
 * @Inject("Namespace\MyService")
 */
public function __construct(MyService $service) 
{
    $this->service = $service;
}

The order is important, and you should decide between constructor or property annotations., _(*29)

Adding own annotations

If you want to use your own annotation, you need to implement the AnnotationInterface., _(*30)

YAML (Deprecated)

Note: YAML configuration is deprecated and will be removed in a future version. Please use Attributes or Autowiring instead, which provide the same functionality with a more modern approach., _(*31)

You can specify your dependencies within a yaml file., _(*32)

YourService:
  - {type: Inject, value: AnotherService}

To enable YAML usage, you need to specify the following configuration, _(*33)

'reinfi.dependencyInjection' => [
    'extractor' => YamlExtractor::class,
    'extractor_options => [
        'file' => 'path_to_your_yaml_file.yml',
    ],
]

Caching

Parsing mapping sources is very heavy. You should enable the cache on production servers. You can set up caching easily with any custom or pre-existing PSR-16 cache adapter., _(*34)

You can provide a string which will be resolved by the container. The factory must return a PSR-16 cache adapter., _(*35)

'reinfi.dependencyInjection' => [
    'cache' => \Laminas\Cache\Storage\Adapter\Memory::class,
]

or you provide a factory for a cache adapter., _(*36)

'reinfi.dependencyInjection' => [
    'cache' => function() {
       return new \Laminas\Cache\Psr\SimpleCache\SimpleCacheDecorator(
           new \Laminas\Cache\Storage\Adapter\Memory()
       );
    },
]

PHPStan Extension

As "autowiring" is always kind of magic, this library ships with a PHPStan extension to solve that problem., _(*37)

If you also install phpstan/extension-installer then you're all set!, _(*38)

If you don't want to use phpstan/extension-installer, include phpstan-extension.neon in your project's PHPStan config:, _(*40)

includes:
    - vendor/reinfi/zf-dependency-injection/phpstan-extension.neon

, _(*41)

The extension requires knowing your service manager to find all the classes you configured for autowiring., _(*42)

If you do not provide it, the PHPStan extension will simply do nothing., _(*43)

parameters:
    reinfiLaminasDependencyInjection:
       serviceManagerLoader: tests/service-manager.php

For example, tests/service-manager.php would look something like this:, _(*44)

$app = \Laminas\Mvc\Application::init($config);
return $app->getServiceManager();

Rector Sets

If you want to migrate your codebase to use attributes instead of annotations, you can use the provided rector sets., _(*45)

You can use the following rector set to migrate your codebase:, _(*46)

use Rector\Config\RectorConfig;
use Reinfi\DependencyInjection\Extension\Rector\Set\ReinfiDependencyInjectionSetList;

return static function (RectorConfig $rectorConfig): void {
  $rectorConfig->sets([ReinfiDependencyInjectionSetList::REINFI_DEPENDENCY_INJECTION_70]);
};

Console commands

• Warmup script for Laminas: php bin/zf-dependency-injection-cache-warmup Fills the cache with every injection required by a class. This can either be via AutoWiringFactory or InjectionFactory.

FAQ

Feel free to ask any questions or open your own pull requests., _(*47)