[DependencyInjection] Throw helpful error when shortcutting global classes

curry684 · curry684 · commit b9e7b4fd61ed · 2017-03-26T23:09:16.000+02:00
As discussed in #22146 the error message received when trying to use a class in the global namespace as a service without defined class is confusing. Helpful information was added pointing out this current limitation.
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/CheckDefinitionValidityPass.php b/src/Symfony/Component/DependencyInjection/Compiler/CheckDefinitionValidityPass.php
@@ -48,6 +48,15 @@ public function process(ContainerBuilder $container)
                 if ($definition->getFactory()) {
                     throw new RuntimeException(sprintf('Please add the class to service "%s" even if it is constructed by a factory since we might need to add method calls based on compile-time checks.', $id));
                 }
+                if (class_exists($id) || interface_exists($id, false)) {
+                    throw new RuntimeException(sprintf(
+                         'The definition for "%s" has no class attribute, and appears to reference a '
+                        .'class or interface in the global namespace. Leaving out the "class" attribute '
+                        .'is only allowed for namespaced classes. Please specify the class attribute '
+                        .'explicitly to get rid of this error.',
+                        $id
+                    ));
+                }
 
                 throw new RuntimeException(sprintf(
                     'The definition for "%s" has no class. If you intend to inject '
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php
@@ -1106,7 +1106,7 @@ public function testClassFromId()
 
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
-     * @expectedExceptionMessage The definition for "DateTime" has no class.
+     * @expectedExceptionMessage The definition for "DateTime" has no class attribute, and appears to reference a class or interface in the global namespace.
      */
     public function testNoClassFromGlobalNamespaceClassId()
     {

Original file line number	Diff line number	Diff line change
`@@ -1106,7 +1106,7 @@ public function testClassFromId()`
`1106`	`1106`
`1107`	`1107`	`/**`
`1108`	`1108`	`* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException`
`1109`		`- * @expectedExceptionMessage The definition for "DateTime" has no class.`
	`1109`	`+ * @expectedExceptionMessage The definition for "DateTime" has no class attribute, and appears to reference a class or interface in the global namespace.`
`1110`	`1110`	`*/`
`1111`	`1111`	`public function testNoClassFromGlobalNamespaceClassId()`
`1112`	`1112`	`{`