Added deprecation of aliases to the yaml file loader

j92 · j92 · commit 16a8676d8a2b · 2018-01-26T10:14:44.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -346,8 +346,13 @@ private function parseDefinition($id, $service, $file, array $defaults)
             }
 
             foreach ($service as $key => $value) {
-                if (!in_array($key, array('alias', 'public'))) {
+                if (!in_array($key, array('alias', 'public', 'deprecated'))) {
                     throw new InvalidArgumentException(sprintf('The configuration key "%s" is unsupported for the service "%s" which is defined as an alias in "%s". Allowed configuration keys for service aliases are "alias" and "public".', $key, $id, $file));
+                    continue;
+                }
+
+                if ('deprecated' === $key) {
+                    $alias->setDeprecated(true, $value);
                 }
             }
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/deprecated_alias_definitions.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/deprecated_alias_definitions.yml
@@ -0,0 +1,4 @@
+services:
+    alias_for_foobar:
+        alias: foobar
+        deprecated: The "%service_id%" service alias is deprecated.
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php
@@ -174,6 +174,17 @@ public function testLoadServices()
         $this->assertEquals(array('decorated', 'decorated.pif-pouf', 5), $services['decorator_service_with_name_and_priority']->getDecoratedService());
     }
 
+    public function testDeprecatedAliases()
+    {
+        $container = new ContainerBuilder();
+        $loader = new YamlFileLoader($container, new FileLocator(self::$fixturesPath.'/yaml'));
+        $loader->load('deprecated_alias_definitions.yml');
+
+        $this->assertTrue($container->getAlias('alias_for_foobar')->isDeprecated());
+        $message = 'The "alias_for_foobar" service alias is deprecated.';
+        $this->assertSame($message, $container->getAlias('alias_for_foobar')->getDeprecationMessage('alias_for_foobar'));
+    }
+
     public function testLoadFactoryShortSyntax()
     {
         $container = new ContainerBuilder();

Original file line number	Diff line number	Diff line change
`@@ -346,8 +346,13 @@ private function parseDefinition($id, $service, $file, array $defaults)`
`346`	`346`	`}`
`347`	`347`
`348`	`348`	`foreach ($service as $key => $value) {`
`349`		`- if (!in_array($key, array('alias', 'public'))) {`
	`349`	`+ if (!in_array($key, array('alias', 'public', 'deprecated'))) {`
`350`	`350`	`throw new InvalidArgumentException(sprintf('The configuration key "%s" is unsupported for the service "%s" which is defined as an alias in "%s". Allowed configuration keys for service aliases are "alias" and "public".', $key, $id, $file));`
	`351`	`+ continue;`
	`352`	`+ }`
	`353`	`+`
	`354`	`+ if ('deprecated' === $key) {`
	`355`	`+ $alias->setDeprecated(true, $value);`
`351`	`356`	`}`
`352`	`357`	`}`
`353`	`358`