Download the PHP package elie29/zend-phpdi-config without Composer

zend-phpdi-config

🚀 Quick Start

✨ Features

• 🧩 PSR-11 compatible container configuration
• ⚡ Autowiring support
• 🔗 Service manager compatibility (Laminas/Mezzio)
• 💻 CLI tool for autowire entry management
• 🗃️ Cache and proxy support
• 🔄 Easy migration from other containers

📖 Introduction

zend-phpdi-config acts as a bridge to configure a PSR-11 compatible PHP-DI container using service manager configuration.

Requirements: PHP 8.2 or higher

It can be used with Laminas and Mezzio starting from v10.0.0

This library uses autowiring technique, cache compilation and cache definitions as defined in PHP-DI.

🛠️ Configuration

Service Manager Configuration

To get a configured PSR-11 PHP-DI container, do the following:

Configuration Keys

The dependencies configuration array supports the following keys:

• services: Maps a service name to a specific service instance, class name, or callable.

  • Values can be object instances, class names, or callables
  • Used for registering pre-instantiated services or simple service definitions
  • See ServicesTest.php for comprehensive examples

• invokables: Maps service names to classes with no constructor dependencies.

  • Can be an associative array (alias => class name) or indexed array (class names)
  • When alias differs from class name, the alias is created automatically
  • Classes must have no required constructor parameters
  • See InvokablesTest.php for comprehensive examples

• autowires: Array of fully qualified class names to be autowired by PHP-DI.

  • PHP-DI automatically resolves constructor dependencies through type-hinting
  • Works with or without constructor parameters
  • Create aliases separately in the aliases configuration if needed

• factories: Maps service names to factory classes or callables.

  • Factory classes must implement __invoke(ContainerInterface $container)
  • Can reference other registered factories by name
  • Factories must return the actual service instance (object, array, scalar, etc.), not service names
  • Used when service instantiation requires custom or dynamic logic
  • See FactoriesTest.php for comprehensive examples

• aliases: Maps alias names to service names or other aliases.

  • Allows multiple names to resolve to the same service instance
  • Can chain aliases (alias → alias → service)
  • Only invokables create aliases automatically
• delegators: Maps service names to arrays of delegator factory classes.
  • Decorates or wraps services with additional functionality
  • Delegators are applied in the order specified
  • See Laminas delegators documentation for details

N.B.: All configuration except dependencies is merged into a config key within the $container:

💻 CLI Usage

The CLI command add-autowires-entry creates the configuration file if it doesn't exist, otherwise it adds the entry to the autowires key.

Example of adding ConsoleHelper to a config.php:

You can also add this as a Composer script:

🧪 Development & Testing

Running Tests

Git Hooks with GrumPHP

This project uses GrumPHP to automatically run tests before each commit.

After running composer install, GrumPHP will:

• Install git hooks automatically
• Run composer test before every commit
• Block commits if tests fail

Bypass the hook (not recommended):

Configure GrumPHP: Edit grumphp.yml to customize tasks and behavior.

🐞 Troubleshooting / FAQ

Q: My service is not autowired. A: Ensure it is listed in the autowires array and all dependencies are available.

Q: The CLI tool fails with a permissions error. A: Make sure the config file directory is writable.

Q: How do I debug container errors? A: Check that all dependencies are correctly defined and that your factories do not throw exceptions.

Using with Mezzio (formerly Expressive)

Replace contents of config/container.php with the following:

Example of a ConfigProvider class

Where UserManager depends on Mailer as follows:

Switching back to another container

To switch back to another container is straightforward:

1. Create your factories with __invoke function
2. Replace autowires key in ConfigProvider by factories key, then for each class name attach its correspondent factory.

PSR 11 and Interop\Container\ContainerInterface

V4.x supports as well Interop\Container\ContainerInterface

Migration guides

• Migration from 3.x to 4.0
• Migration from 4.x to 5.0: container-interop/container-interop was dropped in favor of PSR-11.

🤝 Contributing

See CONTRIBUTING.md for guidelines on how to contribute, run tests, and submit pull requests.

📄 License

This project is licensed under the MIT License. See LICENSE for details.