synecdoche / square1-container
A dependency injection container wrapper for square one
Requires
- php: >=8.1
- php-di/php-di: ^6.0
This package is not auto-updated.
Last update: 2024-06-14 01:42:51 UTC
README
The Tribe Libs Container uses PHP-DI to help you build object graphs, allowing for autowiring dependency injection.
Mutable Container
In general, you should design your services to be stateless.
However, for long-running processes (like queues) or in situations where you absolutely must create a fresh object, including all of its dependencies, you can use the Mutable Container.
This opens up the makeFresh()
method, which works exactly like PHP-DI's make() method, but flushes the container's resolved entries, meaning the object's dependencies will also be recreated from scratch.
NOTE: Only use this when necessary, this is not as performant as the default container.
In a definer:
<?php declare(strict_types=1); namespace Tribe\Project\Feature; use Psr\Container\ContainerInterface; use Symfony\Contracts\HttpClient\HttpClientInterface; use Tribe\Explore_Navigation\Azure\Factories\Client_Factory; use Tribe\Libs\Container\Definer_Interface; use Tribe\Libs\Container\MutableContainer; use Tribe\Libs\Container\Container; class My_Feature_Definer implements Definer_Interface { public function define(): array { return [ // Define our abstract to the interface, placing our existing container inside the mutable container. MutableContainer::class => static fn ( ContainerInterface $c ) => ( new Container() )->wrap( $c ), ]; } }
Then you can utilize the makeFresh()
method to create purely fresh objects
each time it's called:
<?php declare(strict_types=1); namespace Tribe\Project\Feature; use Tribe\Libs\Container\Abstract_Subscriber; use Tribe\Libs\Container\MutableContainer; class My_Queue_Factory { protected MutableContainer $container; public function __construct( MutableContainer $container ) { $this->container = $container; } /** * Make a fresh object. * * @param string $class_name e.g. \Tribe\Project\Feature\SomeFeature::class * * @return mixed|string */ public function make( string $class_name ) { return $this->container->makeFresh( $class_name ); } }
Then call your factory:
<?php declare(strict_types=1); namespace Tribe\Project\Feature; use Tribe\Libs\Container\Abstract_Subscriber; use Tribe\Libs\Container\MutableContainer; class My_Feature_Subscriber extends Abstract_Subscriber { public function register(): void { add_action( 'init', function(): void { // Both of these will be completely separate instances, // including any dependencies SomeFeature::class has. var_dump( $this->container->get( MutableContainer::class )->make( '\Tribe\Project\Feature\SomeFeature::class' ) ); var_dump( $this->container->get( MutableContainer::class )->make( '\Tribe\Project\Feature\SomeFeature::class' ) ); // This will be the same instance as the last freshly made object var_dump( $this->container->get( SomeFeature::class ) ); }, 10, 0 ); } }