julienfalque / symfony-service-replacer
Allows replacing services in a Symfony Dependency Injection Container at runtime
Requires
- php: ^7.4 || ^8.0
- laminas/laminas-code: ^4.0
- ocramius/proxy-manager: ^2.13
- psr/container: ^1.0
- symfony/config: ^5.3
- symfony/dependency-injection: ^5.3
- symfony/expression-language: ^5.3
- symfony/framework-bundle: ^5.3
- symfony/http-kernel: ^5.3
Requires (Dev)
- composer/package-versions-deprecated: ^1.11
- phpunit/phpunit: ^9.5
- symfony/proxy-manager-bridge: ^5.3
- symfony/yaml: ^5.3
This package is auto-updated.
Last update: 2024-10-29 05:54:03 UTC
README
Provides a way to replace services in a Symfony Dependency Injection Container at runtime for testing purposes.
Installation
Install the package using Composer:
$ composer require --dev julienfalque/symfony-service-replacer
Then enable the bundle in your Symfony application:
<?php // config/bundles.php return [ // ... JulienFalque\SymfonyServiceReplacer\Bridge\Symfony\Bundle::class => ['test' => true], ];
The bundle decorates Symfony's test container (test.service_container
) so make sure it is available by enabling
FrameworkBundle
's test mode:
# config/packages/test/framework.yaml framework: test: true
Usage
To make a service replaceable at runtime, add the replaceable
tag to it:
# config/services.yaml services: replaceable_service: # ... tags: [replaceable]
Each tagged service is decorated with a proxy that forwards calls to the original service and returns their results unchanged. Tagged services don't need to be public to be replaced.
At runtime, the test container (test.service_container
) now allows you to use the set()
method to replace your
service and the restore()
method to use the original service again:
$service = $container->get('replaceable_service'); echo "{$service->foo()}\n"; $container->get('test.service_container')->set('replaceable_service', new class() { public function foo(): string { return 'Bar'; } }); echo "{$service->foo()}\n"; $replacer->restore('replaceable_service'); echo "{$service->foo()}\n";
Assuming that the original service's method returns "Foo"
, this will output:
Foo
Bar
Foo