+ */
+interface ServiceSubscriberInterface
+{
+ /**
+ * Returns an array of service types required by such instances, optionally keyed by the service names used internally.
+ *
+ * For mandatory dependencies:
+ *
+ * * array('logger' => 'Psr\Log\LoggerInterface') means the objects use the "logger" name
+ * internally to fetch a service which must implement Psr\Log\LoggerInterface.
+ * * array('Psr\Log\LoggerInterface') is a shortcut for
+ * * array('Psr\Log\LoggerInterface' => 'Psr\Log\LoggerInterface')
+ *
+ * otherwise:
+ *
+ * * array('logger' => '?Psr\Log\LoggerInterface') denotes an optional dependency
+ * * array('?Psr\Log\LoggerInterface') is a shortcut for
+ * * array('Psr\Log\LoggerInterface' => '?Psr\Log\LoggerInterface')
+ *
+ * @return array The required service types, optionally keyed by service names
+ */
+ public static function getSubscribedServices();
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterServiceSubscribersPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterServiceSubscribersPassTest.php
new file mode 100644
index 0000000000000..e8971ca7fa7ea
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterServiceSubscribersPassTest.php
@@ -0,0 +1,118 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Compiler;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
+use Symfony\Component\DependencyInjection\Compiler\RegisterServiceSubscribersPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\ServiceLocator;
+use Symfony\Component\DependencyInjection\TypedReference;
+
+require_once __DIR__.'/../Fixtures/includes/classes.php';
+
+class RegisterServiceSubscribersPassTest extends TestCase
+{
+ /**
+ * @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
+ * @expectedExceptionMessage Service "foo" must implement interface "Symfony\Component\DependencyInjection\ServiceSubscriberInterface".
+ */
+ public function testInvalidClass()
+ {
+ $container = new ContainerBuilder();
+
+ $container->register('foo', 'stdClass')
+ ->addTag('container.service_subscriber')
+ ;
+
+ $pass = new RegisterServiceSubscribersPass();
+ $pass->process($container);
+ }
+
+ /**
+ * @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
+ * @expectedExceptionMessage The "container.service_subscriber" tag accepts only the "key" and "id" attributes, "bar" given for service "foo".
+ */
+ public function testInvalidAttributes()
+ {
+ $container = new ContainerBuilder();
+
+ $container->register('foo', 'TestServiceSubscriber')
+ ->addTag('container.service_subscriber', array('bar' => '123'))
+ ;
+
+ $pass = new RegisterServiceSubscribersPass();
+ $pass->process($container);
+ }
+
+ public function testNoAttributes()
+ {
+ $container = new ContainerBuilder();
+
+ $container->register('foo', 'TestServiceSubscriber')
+ ->addArgument(new Reference('container'))
+ ->addTag('container.service_subscriber')
+ ;
+
+ $pass = new RegisterServiceSubscribersPass();
+ $pass->process($container);
+
+ $foo = $container->getDefinition('foo');
+ $locator = $container->getDefinition((string) $foo->getArgument(0));
+
+ $this->assertFalse($locator->isAutowired());
+ $this->assertFalse($locator->isPublic());
+ $this->assertSame(ServiceLocator::class, $locator->getClass());
+
+ $expected = array(
+ 'TestServiceSubscriber' => new ServiceClosureArgument(new TypedReference('TestServiceSubscriber', 'TestServiceSubscriber')),
+ 'stdClass' => new ServiceClosureArgument(new TypedReference('stdClass', 'stdClass', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)),
+ 'bar' => new ServiceClosureArgument(new TypedReference('stdClass', 'stdClass')),
+ 'baz' => new ServiceClosureArgument(new TypedReference('stdClass', 'stdClass', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)),
+ );
+
+ $this->assertEquals($expected, $locator->getArgument(0));
+ }
+
+ public function testWithAttributes()
+ {
+ $container = new ContainerBuilder();
+
+ $container->register('foo', 'TestServiceSubscriber')
+ ->setAutowired(true)
+ ->addArgument(new Reference('container'))
+ ->addTag('container.service_subscriber', array('key' => 'bar', 'id' => 'bar'))
+ ->addTag('container.service_subscriber', array('key' => 'bar', 'id' => 'baz')) // should be ignored: the first wins
+ ;
+
+ $pass = new RegisterServiceSubscribersPass();
+ $pass->process($container);
+
+ $foo = $container->getDefinition('foo');
+ $locator = $container->getDefinition((string) $foo->getArgument(0));
+
+ $this->assertTrue($locator->isAutowired());
+ $this->assertFalse($locator->isPublic());
+ $this->assertSame(ServiceLocator::class, $locator->getClass());
+
+ $expected = array(
+ 'TestServiceSubscriber' => new ServiceClosureArgument(new TypedReference('TestServiceSubscriber', 'TestServiceSubscriber')),
+ 'stdClass' => new ServiceClosureArgument(new TypedReference('stdClass', 'stdClass', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)),
+ 'bar' => new ServiceClosureArgument(new TypedReference('bar', 'stdClass')),
+ 'baz' => new ServiceClosureArgument(new TypedReference('stdClass', 'stdClass', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)),
+ );
+
+ $this->assertEquals($expected, $locator->getArgument(0));
+ }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php b/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php
index 19c9ebdeb1343..5926301d44319 100644
--- a/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php
+++ b/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php
@@ -658,4 +658,23 @@ public function testServiceLocator()
$this->assertStringEqualsFile(self::$fixturesPath.'/php/services_locator.php', $dumper->dump());
}
+
+ public function testServiceSubscriber()
+ {
+ $container = new ContainerBuilder();
+ $container->register('foo_service', 'TestServiceSubscriber')
+ ->setAutowired(true)
+ ->addArgument(new Reference('container'))
+ ->addTag('container.service_subscriber', array(
+ 'key' => 'test',
+ 'id' => 'TestServiceSubscriber',
+ ))
+ ;
+ $container->register('TestServiceSubscriber', 'TestServiceSubscriber');
+ $container->compile();
+
+ $dumper = new PhpDumper($container);
+
+ $this->assertStringEqualsFile(self::$fixturesPath.'/php/services_subscriber.php', $dumper->dump());
+ }
}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/classes.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/classes.php
index ffa2a896a8c72..c4c93c123e2a0 100644
--- a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/classes.php
+++ b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/classes.php
@@ -2,6 +2,7 @@
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface as ProxyDumper;
+use Symfony\Component\DependencyInjection\ServiceSubscriberInterface;
function sc_configure($instance)
{
@@ -107,3 +108,20 @@ public function __construct($lazyValues)
$this->lazyValues = $lazyValues;
}
}
+
+class TestServiceSubscriber implements ServiceSubscriberInterface
+{
+ public function __construct($container)
+ {
+ }
+
+ public static function getSubscribedServices()
+ {
+ return array(
+ __CLASS__,
+ '?stdClass',
+ 'bar' => 'stdClass',
+ 'baz' => '?stdClass',
+ );
+ }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_subscriber.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_subscriber.php
new file mode 100644
index 0000000000000..1c4e389c8b4cb
--- /dev/null
+++ b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_subscriber.php
@@ -0,0 +1,129 @@
+services = array();
+ $this->normalizedIds = array(
+ 'autowired.stdclass' => 'autowired.stdClass',
+ 'psr\\container\\containerinterface' => 'Psr\\Container\\ContainerInterface',
+ 'stdclass' => 'stdClass',
+ 'symfony\\component\\dependencyinjection\\containerinterface' => 'Symfony\\Component\\DependencyInjection\\ContainerInterface',
+ 'testservicesubscriber' => 'TestServiceSubscriber',
+ );
+ $this->methodMap = array(
+ 'TestServiceSubscriber' => 'getTestServiceSubscriberService',
+ 'autowired.stdClass' => 'getAutowired_StdClassService',
+ 'foo_service' => 'getFooServiceService',
+ );
+ $this->privates = array(
+ 'autowired.stdClass' => true,
+ );
+
+ $this->aliases = array();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function compile()
+ {
+ throw new LogicException('You cannot compile a dumped container that was already compiled.');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function isCompiled()
+ {
+ return true;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function isFrozen()
+ {
+ @trigger_error(sprintf('The %s() method is deprecated since version 3.3 and will be removed in 4.0. Use the isCompiled() method instead.', __METHOD__), E_USER_DEPRECATED);
+
+ return true;
+ }
+
+ /**
+ * Gets the 'TestServiceSubscriber' service.
+ *
+ * This service is shared.
+ * This method always returns the same instance of the service.
+ *
+ * @return \TestServiceSubscriber A TestServiceSubscriber instance
+ */
+ protected function getTestServiceSubscriberService()
+ {
+ return $this->services['TestServiceSubscriber'] = new \TestServiceSubscriber();
+ }
+
+ /**
+ * Gets the 'foo_service' service.
+ *
+ * This service is shared.
+ * This method always returns the same instance of the service.
+ *
+ * This service is autowired.
+ *
+ * @return \TestServiceSubscriber A TestServiceSubscriber instance
+ */
+ protected function getFooServiceService()
+ {
+ return $this->services['foo_service'] = new \TestServiceSubscriber(new \Symfony\Component\DependencyInjection\ServiceLocator(array('TestServiceSubscriber' => function () {
+ $f = function (\TestServiceSubscriber $v) { return $v; }; return $f(${($_ = isset($this->services['TestServiceSubscriber']) ? $this->services['TestServiceSubscriber'] : $this->get('TestServiceSubscriber')) && false ?: '_'});
+ }, 'stdClass' => function () {
+ $f = function (\stdClass $v = null) { return $v; }; return $f(${($_ = isset($this->services['autowired.stdClass']) ? $this->services['autowired.stdClass'] : $this->getAutowired_StdClassService()) && false ?: '_'});
+ }, 'bar' => function () {
+ $f = function (\stdClass $v) { return $v; }; return $f(${($_ = isset($this->services['autowired.stdClass']) ? $this->services['autowired.stdClass'] : $this->getAutowired_StdClassService()) && false ?: '_'});
+ }, 'baz' => function () {
+ $f = function (\stdClass $v = null) { return $v; }; return $f(${($_ = isset($this->services['autowired.stdClass']) ? $this->services['autowired.stdClass'] : $this->getAutowired_StdClassService()) && false ?: '_'});
+ })));
+ }
+
+ /**
+ * Gets the 'autowired.stdClass' service.
+ *
+ * This service is shared.
+ * This method always returns the same instance of the service.
+ *
+ * This service is private.
+ * If you want to be able to request this service from the container directly,
+ * make it public, otherwise you might end up with broken code.
+ *
+ * This service is autowired.
+ *
+ * @return \stdClass A stdClass instance
+ */
+ protected function getAutowired_StdClassService()
+ {
+ return $this->services['autowired.stdClass'] = new \stdClass();
+ }
+}
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
index 146f73e6cfdd5..e2ca619f4a63d 100644
--- a/src/Symfony/Component/HttpKernel/CHANGELOG.md
+++ b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -8,8 +8,6 @@ CHANGELOG
* Deprecated the special `SYMFONY__` environment variables
* added the possibility to change the query string parameter used by `UriSigner`
* deprecated `LazyLoadingFragmentHandler::addRendererService()`
- * added `SessionListener`
- * added `TestSessionListener`
3.2.0
-----
diff --git a/src/Symfony/Component/HttpKernel/EventListener/SessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/SessionListener.php
index 39ebfd922fac6..a6a7de7550a51 100644
--- a/src/Symfony/Component/HttpKernel/EventListener/SessionListener.php
+++ b/src/Symfony/Component/HttpKernel/EventListener/SessionListener.php
@@ -12,6 +12,8 @@
namespace Symfony\Component\HttpKernel\EventListener;
use Psr\Container\ContainerInterface;
+use Symfony\Component\DependencyInjection\ServiceSubscriberInterface;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
/**
* Sets the session in the request.
@@ -20,7 +22,7 @@
*
* @final since version 3.3
*/
-class SessionListener extends AbstractSessionListener
+class SessionListener extends AbstractSessionListener implements ServiceSubscriberInterface
{
private $container;
@@ -37,4 +39,14 @@ protected function getSession()
return $this->container->get('session');
}
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getSubscribedServices()
+ {
+ return array(
+ 'session' => '?'.SessionInterface::class,
+ );
+ }
}
diff --git a/src/Symfony/Component/HttpKernel/EventListener/TestSessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/TestSessionListener.php
index 36abb422f4f6d..769eb3b6d033c 100644
--- a/src/Symfony/Component/HttpKernel/EventListener/TestSessionListener.php
+++ b/src/Symfony/Component/HttpKernel/EventListener/TestSessionListener.php
@@ -12,6 +12,8 @@
namespace Symfony\Component\HttpKernel\EventListener;
use Psr\Container\ContainerInterface;
+use Symfony\Component\DependencyInjection\ServiceSubscriberInterface;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
/**
* Sets the session in the request.
@@ -20,7 +22,7 @@
*
* @final since version 3.3
*/
-class TestSessionListener extends AbstractTestSessionListener
+class TestSessionListener extends AbstractTestSessionListener implements ServiceSubscriberInterface
{
private $container;
@@ -37,4 +39,14 @@ protected function getSession()
return $this->container->get('session');
}
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function getSubscribedServices()
+ {
+ return array(
+ 'session' => '?'.SessionInterface::class,
+ );
+ }
}
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy