feature symfony#22383 added a more specialized exception for a better error message (fabpot)

This PR was merged into the 3.3-dev branch.

Discussion
----------

added a more specialized exception for a better error message

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes/no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | n/a
| License       | MIT
| Doc PR        | n/a

When trying to load a resource, it is very interesting to understand why a resource cannot be loaded. Especially when you get `Cannot load resource "../src/Controller/".`... when the real error is that annotation support is disabled. This PR adds more information in that case.

Commits
-------

aeb9bff added a more specialized exception for a better error message

Author: fabpot

src/Symfony/Bundle/FrameworkBundle/Routing/DelegatingLoader.php

@@ -64,7 +64,7 @@ public function load($resource, $type = null)
             // - this handles the case and prevents the second fatal error
             //   by triggering an exception beforehand.
 
-            throw new FileLoaderLoadException($resource);
+            throw new FileLoaderLoadException($resource, null, null, null, $type);
         }
         $this->loading = true;
 

src/Symfony/Component/Config/Exception/FileLoaderLoadException.php

@@ -23,8 +23,9 @@ class FileLoaderLoadException extends \Exception
      * @param string     $sourceResource The original resource importing the new resource
      * @param int        $code           The error code
      * @param \Exception $previous       A previous exception
+     * @param string     $type           The type of resource
      */
-    public function __construct($resource, $sourceResource = null, $code = null, $previous = null)
+    public function __construct($resource, $sourceResource = null, $code = null, $previous = null, $type = null)
     {
         $message = '';
         if ($previous) {
@@ -60,6 +61,13 @@ public function __construct($resource, $sourceResource = null, $code = null, $pr
             $bundle = substr($parts[0], 1);
             $message .= sprintf(' Make sure the "%s" bundle is correctly registered and loaded in the application kernel class.', $bundle);
             $message .= sprintf(' If the bundle is registered, make sure the bundle path "%s" is not empty.', $resource);
+        } elseif (null !== $type) {
+            // maybe there is no loader for this specific type
+            if ('annotation' === $type) {
+                $message .= ' Make sure annotations are enabled.';
+            } else {
+                $message .= sprintf(' Make sure there is a loader supporting the "%s" type.', $type);
+            }
         }
 
         parent::__construct($message, $code, $previous);

src/Symfony/Component/Config/Loader/DelegatingLoader.php

@@ -39,7 +39,7 @@ public function __construct(LoaderResolverInterface $resolver)
     public function load($resource, $type = null)
     {
         if (false === $loader = $this->resolver->resolve($resource, $type)) {
-            throw new FileLoaderLoadException($resource);
+            throw new FileLoaderLoadException($resource, null, null, null, $type);
         }
 
         return $loader->load($resource, $type);

src/Symfony/Component/Config/Loader/FileLoader.php

@@ -210,7 +210,7 @@ private function doImport($resource, $type = null, $ignoreErrors = false, $sourc
                     throw $e;
                 }
 
-                throw new FileLoaderLoadException($resource, $sourceResource, null, $e);
+                throw new FileLoaderLoadException($resource, $sourceResource, null, $e, $type);
             }
         }
     }

src/Symfony/Component/Config/Loader/Loader.php

@@ -70,7 +70,7 @@ public function resolve($resource, $type = null)
         $loader = null === $this->resolver ? false : $this->resolver->resolve($resource, $type);
 
         if (false === $loader) {
-            throw new FileLoaderLoadException($resource);
+            throw new FileLoaderLoadException($resource, null, null, null, $type);
         }
 
         return $loader;

src/Symfony/Component/Config/Tests/Exception/FileLoaderLoadExceptionTest.php

@@ -22,6 +22,18 @@ public function testMessageCannotLoadResource()
         $this->assertEquals('Cannot load resource "resource".', $exception->getMessage());
     }
 
+    public function testMessageCannotLoadResourceWithType()
+    {
+        $exception = new FileLoaderLoadException('resource', null, null, null, 'foobar');
+        $this->assertEquals('Cannot load resource "resource". Make sure there is a loader supporting the "foobar" type.', $exception->getMessage());
+    }
+
+    public function testMessageCannotLoadResourceWithAnnotationType()
+    {
+        $exception = new FileLoaderLoadException('resource', null, null, null, 'annotation');
+        $this->assertEquals('Cannot load resource "resource". Make sure annotations are enabled.', $exception->getMessage());
+    }
+
     public function testMessageCannotImportResourceFromSource()
     {
         $exception = new FileLoaderLoadException('resource', 'sourceResource');

src/Symfony/Component/Routing/RouteCollectionBuilder.php

@@ -369,11 +369,11 @@ private function load($resource, $type = null)
         }
 
         if (null === $resolver = $this->loader->getResolver()) {
-            throw new FileLoaderLoadException($resource);
+            throw new FileLoaderLoadException($resource, null, null, null, $type);
         }
 
         if (false === $loader = $resolver->resolve($resource, $type)) {
-            throw new FileLoaderLoadException($resource);
+            throw new FileLoaderLoadException($resource, null, null, null, $type);
         }
 
         $collections = $loader->load($resource, $type);