feature #19511 Use a dedicated exception in the file locator (leofeyer)

fabpot · fabpot · commit ccb684a83324 · 2016-08-09T07:23:21.000-07:00
This PR was squashed before being merged into the 3.2-dev branch (closes #19511). Discussion ---------- Use a dedicated exception in the file locator | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - This PR adds a dedicated `FileLocatorFileNotFoundException` class to the file locator, so it is possible to catch file locator exceptions separately from invalid argument exceptions. ```php try { foreach ($container->get('file_locator')->locate('file.php', null, false) as $file) { include $file; } } catch (\InvalidArgumentException $e) { // this will catch both file locator exceptions as well as // any invalid argument exception thrown in an included file } ``` With the dedicated exceptions, we could do this: ```php try { foreach ($container->get('file_locator')->locate('file.php', null, false) as $file) { include $file; } } catch (FileLocatorFileNotFoundException $e) { // this will only ignore file locator exceptions } ``` Commits ------- ee4adaa Use a dedicated exception in the file locator
diff --git a/src/Symfony/Component/Config/Exception/FileLocatorFileNotFoundException.php b/src/Symfony/Component/Config/Exception/FileLocatorFileNotFoundException.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Exception;
+
+/**
+ * File locator exception if a file does not exist.
+ *
+ * @author Leo Feyer <https://github.com/leofeyer>
+ */
+class FileLocatorFileNotFoundException extends \InvalidArgumentException
+{
+}
diff --git a/src/Symfony/Component/Config/FileLocator.php b/src/Symfony/Component/Config/FileLocator.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Config;
 
+use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;
+
 /**
  * FileLocator uses an array of pre-defined paths to find files.
  *
@@ -41,7 +43,7 @@ public function locate($name, $currentPath = null, $first = true)
 
         if ($this->isAbsolutePath($name)) {
             if (!file_exists($name)) {
-                throw new \InvalidArgumentException(sprintf('The file "%s" does not exist.', $name));
+                throw new FileLocatorFileNotFoundException(sprintf('The file "%s" does not exist.', $name));
             }
 
             return $name;
@@ -66,7 +68,7 @@ public function locate($name, $currentPath = null, $first = true)
         }
 
         if (!$filepaths) {
-            throw new \InvalidArgumentException(sprintf('The file "%s" does not exist (in: %s).', $name, implode(', ', $paths)));
+            throw new FileLocatorFileNotFoundException(sprintf('The file "%s" does not exist (in: %s).', $name, implode(', ', $paths)));
         }
 
         return $filepaths;
diff --git a/src/Symfony/Component/Config/FileLocatorInterface.php b/src/Symfony/Component/Config/FileLocatorInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Config;
 
+use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;
+
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  */
@@ -25,7 +27,8 @@ interface FileLocatorInterface
      *
      * @return string|array The full path to the file or an array of file paths
      *
-     * @throws \InvalidArgumentException When file is not found
+     * @throws \InvalidArgumentException        If $name is empty
+     * @throws FileLocatorFileNotFoundException If a file is not found
      */
     public function locate($name, $currentPath = null, $first = true);
 }
diff --git a/src/Symfony/Component/Config/Tests/FileLocatorTest.php b/src/Symfony/Component/Config/Tests/FileLocatorTest.php
@@ -86,7 +86,7 @@ public function testLocate()
     }
 
     /**
-     * @expectedException \InvalidArgumentException
+     * @expectedException \Symfony\Component\Config\Exception\FileLocatorFileNotFoundException
      * @expectedExceptionMessage The file "foobar.xml" does not exist
      */
     public function testLocateThrowsAnExceptionIfTheFileDoesNotExists()
@@ -97,7 +97,7 @@ public function testLocateThrowsAnExceptionIfTheFileDoesNotExists()
     }
 
     /**
-     * @expectedException \InvalidArgumentException
+     * @expectedException \Symfony\Component\Config\Exception\FileLocatorFileNotFoundException
      */
     public function testLocateThrowsAnExceptionIfTheFileDoesNotExistsInAbsolutePath()
     {

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Config;`
`13`	`13`
	`14`	`+use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* FileLocator uses an array of pre-defined paths to find files.`
`16`	`18`	`*`
`@@ -41,7 +43,7 @@ public function locate($name, $currentPath = null, $first = true)`
`41`	`43`
`42`	`44`	`if ($this->isAbsolutePath($name)) {`
`43`	`45`	`if (!file_exists($name)) {`
`44`		`- throw new \InvalidArgumentException(sprintf('The file "%s" does not exist.', $name));`
	`46`	`+ throw new FileLocatorFileNotFoundException(sprintf('The file "%s" does not exist.', $name));`
`45`	`47`	`}`
`46`	`48`
`47`	`49`	`return $name;`
`@@ -66,7 +68,7 @@ public function locate($name, $currentPath = null, $first = true)`
`66`	`68`	`}`
`67`	`69`
`68`	`70`	`if (!$filepaths) {`
`69`		`- throw new \InvalidArgumentException(sprintf('The file "%s" does not exist (in: %s).', $name, implode(', ', $paths)));`
	`71`	`+ throw new FileLocatorFileNotFoundException(sprintf('The file "%s" does not exist (in: %s).', $name, implode(', ', $paths)));`
`70`	`72`	`}`
`71`	`73`
`72`	`74`	`return $filepaths;`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public function testLocate()`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`/**`
`89`		`- * @expectedException \InvalidArgumentException`
	`89`	`+ * @expectedException \Symfony\Component\Config\Exception\FileLocatorFileNotFoundException`
`90`	`90`	`* @expectedExceptionMessage The file "foobar.xml" does not exist`
`91`	`91`	`*/`
`92`	`92`	`public function testLocateThrowsAnExceptionIfTheFileDoesNotExists()`
`@@ -97,7 +97,7 @@ public function testLocateThrowsAnExceptionIfTheFileDoesNotExists()`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`/**`
`100`		`- * @expectedException \InvalidArgumentException`
	`100`	`+ * @expectedException \Symfony\Component\Config\Exception\FileLocatorFileNotFoundException`
`101`	`101`	`*/`
`102`	`102`	`public function testLocateThrowsAnExceptionIfTheFileDoesNotExistsInAbsolutePath()`
`103`	`103`	`{`