How to inject an interface implementation with Auryn?

Use the alias() method to map an interface to a concrete class globally, or define() for specific parameter mappings. For example, $injector->alias('Engine', 'V8') injects V8 instances wherever Engine is type-hinted, as shown in the Car example.

Auryn vs PHP-DI: which is better for PHP?

Auryn emphasizes strict constructor injection and avoids Service Locators, ideal for clean, testable code. PHP-DI offers more features like auto-wiring with annotations and configuration files, but might encourage anti-patterns. Choose Auryn for DI purity, PHP-DI for convenience and advanced tooling.

How to share a database connection in Auryn without Singletons?

Use the share() method to mark a PDO instance or class as shared. For example, $injector->share($pdo) ensures the same PDO object is injected wherever PDO is type-hinted, avoiding Singleton anti-patterns, as demonstrated in the DataMapper example.

Can Auryn handle scalar dependencies like strings or integers?

Yes, by prefixing parameter names with a colon in define() calls to indicate raw values. For instance, $injector->define('PDO', [':dsn' => 'mysql:...']) injects the string directly without class instantiation, as detailed in the non-class parameters section.

How to inject dependencies into a static method using Auryn?

Use the execute() method with the static method callable. For example, $injector->execute('MyClass::myStaticMethod') will automatically provision and inject dependencies based on the method's parameters, as shown in the injecting for execution examples.

What are the performance implications of Auryn's reflection?

Auryn caches reflection results to minimize performance hits, but reflection is still slower than direct instantiation. For most applications, the overhead is negligible, but in performance-critical loops, consider using delegates or caching instances, as noted in the README.

Auryn — Recursive Dependency Injector for PHP

What is Auryn?

Auryn is a recursive dependency injection container for PHP that automatically instantiates class dependencies based on constructor type-hints. It helps developers build maintainable, testable applications by automating object wiring and promoting proper dependency injection patterns. The container recursively resolves nested dependencies, eliminating the need for manual instantiation and service locators.

Target Audience

PHP developers building SOLID, object-oriented applications who need to manage complex dependency graphs and avoid anti-patterns like Service Locator or Singletons. It's particularly useful for those implementing dependency injection in large-scale projects or frameworks.

Value Proposition

Developers choose Auryn over alternatives because it enforces constructor injection and transparent dependencies, making code more testable and maintainable. Its recursive instantiation, caching of reflections for performance, and avoidance of Service Locator patterns provide a clean, efficient way to wire applications without sacrificing design principles.

IoC Dependency Injector

Use Cases

Best For

Bootstrapping and wiring together SOLID, object-oriented PHP applications with complex dependency trees.
Automating object instantiation in PHP applications where classes have nested dependencies based on constructor type-hints.
Implementing dependency injection in PHP without using Service Locator anti-patterns, ensuring transparent class dependencies.
Sharing single instances (like database connections) across an application without resorting to Singleton anti-patterns.
Injecting dependencies into PHP callables, including functions, static methods, and instance methods, for execution.
Managing interface and abstract class implementations through type-hint aliasing and injection definitions in PHP projects.

Not Ideal For

Projects already integrated with full-stack PHP frameworks that provide mature, convention-over-configuration DI containers (e.g., Laravel's service container or Symfony's DependencyInjection).
Teams seeking a DI solution with extensive auto-wiring that requires zero manual definitions for common scenarios, as Auryn needs explicit define() calls for interfaces and scalars.
Applications requiring advanced DI features like lazy loading via proxies, contextual bindings, or decorator patterns, which Auryn does not natively support.
Developers who prefer annotation-based or configuration file (YAML/XML) dependency injection over programmatic array definitions, due to better IDE integration.

Pros & Cons

Pros

Recursive Auto-Wiring

Automatically instantiates nested class dependencies based on constructor type-hints, eliminating manual object graph construction. The README demonstrates this with the Car-Engine example where SparkPlug and Piston are resolved without extra configuration.

Anti-Pattern Avoidance

Explicitly discourages Service Locator usage and provides instance sharing via share() to replace Singletons, promoting transparent and testable code. The README states, 'auryn is NOT a Service Locator' and shows how to share PDO connections.

Flexible Injection Definitions

Supports aliasing for interfaces, custom definitions for scalars with colon prefixes, and delegates for complex instantiation logic. Examples include define() for parameter mappings and alias() for abstract types like Engine to V8.

Execution Injection

Can inject dependencies into any PHP callable, including functions, static methods, and instance methods, via the execute() method. This allows dependency injection beyond constructors, as shown with Example::myMethod.

Cons

Manual Configuration Overhead

Requires explicit define() calls for non-concrete dependencies and scalar parameters, which can become verbose and error-prone in large applications. The README shows this necessity repeatedly, adding boilerplate code.

Reflection Performance Trade-offs

Relies on PHP Reflection for dependency resolution, and while reflections are cached, this can still impact performance in high-throughput scenarios compared to compiled or pre-resolved containers, as admitted in the README's speed discussion.

Limited Modern Features

Missing features common in other DI containers, such as lazy loading, proxy generation, or integration with configuration management systems, limiting its suitability for complex enterprise applications without additional tooling.

Frequently Asked Questions

What is Auryn?

Target Audience

Value Proposition

Use Cases

Best For

Bootstrapping and wiring together SOLID, object-oriented PHP applications with complex dependency trees.
Automating object instantiation in PHP applications where classes have nested dependencies based on constructor type-hints.
Implementing dependency injection in PHP without using Service Locator anti-patterns, ensuring transparent class dependencies.
Sharing single instances (like database connections) across an application without resorting to Singleton anti-patterns.
Injecting dependencies into PHP callables, including functions, static methods, and instance methods, for execution.
Managing interface and abstract class implementations through type-hint aliasing and injection definitions in PHP projects.

Not Ideal For

Projects already integrated with full-stack PHP frameworks that provide mature, convention-over-configuration DI containers (e.g., Laravel's service container or Symfony's DependencyInjection).
Teams seeking a DI solution with extensive auto-wiring that requires zero manual definitions for common scenarios, as Auryn needs explicit define() calls for interfaces and scalars.
Applications requiring advanced DI features like lazy loading via proxies, contextual bindings, or decorator patterns, which Auryn does not natively support.
Developers who prefer annotation-based or configuration file (YAML/XML) dependency injection over programmatic array definitions, due to better IDE integration.

Pros & Cons

Pros

Recursive Auto-Wiring

Anti-Pattern Avoidance

Flexible Injection Definitions

Execution Injection

Cons

Manual Configuration Overhead

Reflection Performance Trade-offs

Limited Modern Features

Frequently Asked Questions

Auryn

What is Auryn?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Auryn

What is Auryn?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?