minor #12206 [Config] fix filelocator with empty name (Tobion)

This PR was merged into the 2.3 branch.

Discussion
----------

[Config] fix filelocator with empty name

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

fix filelocator with empty name + phpdoc in config component

Commits
-------

63b8c07 [DependencyInjection] use inheritdoc for loaders
ddd2fe2 [Config] fix filelocator with empty name

src/Symfony/Component/Config/FileLocator.php

@@ -31,18 +31,14 @@ public function __construct($paths = array())
     }
 
     /**
-     * Returns a full path for a given file name.
-     *
-     * @param mixed   $name        The file name to locate
-     * @param string  $currentPath The current path
-     * @param bool    $first       Whether to return the first occurrence or an array of filenames
-     *
-     * @return string|array The full path to the file|An array of file paths
-     *
-     * @throws \InvalidArgumentException When file is not found
+     * {@inheritdoc}
      */
     public function locate($name, $currentPath = null, $first = true)
     {
+        if ('' == $name) {
+            throw new \InvalidArgumentException('An empty file name is not valid to be located.');
+        }
+
         if ($this->isAbsolutePath($name)) {
             if (!file_exists($name)) {
                 throw new \InvalidArgumentException(sprintf('The file "%s" does not exist.', $name));
@@ -84,10 +80,10 @@ public function locate($name, $currentPath = null, $first = true)
      */
     private function isAbsolutePath($file)
     {
-        if ($file[0] == '/' || $file[0] == '\\'
+        if ($file[0] === '/' || $file[0] === '\\'
             || (strlen($file) > 3 && ctype_alpha($file[0])
-                && $file[1] == ':'
-                && ($file[2] == '\\' || $file[2] == '/')
+                && $file[1] === ':'
+                && ($file[2] === '\\' || $file[2] === '/')
             )
             || null !== parse_url($file, PHP_URL_SCHEME)
         ) {

src/Symfony/Component/Config/FileLocatorInterface.php

@@ -19,11 +19,11 @@ interface FileLocatorInterface
     /**
      * Returns a full path for a given file name.
      *
-     * @param mixed   $name        The file name to locate
-     * @param string  $currentPath The current path
-     * @param bool    $first       Whether to return the first occurrence or an array of filenames
+     * @param string      $name        The file name to locate
+     * @param string|null $currentPath The current path
+     * @param bool        $first       Whether to return the first occurrence or an array of filenames
      *
-     * @return string|array The full path to the file|An array of file paths
+     * @return string|array The full path to the file or an array of file paths
      *
      * @throws \InvalidArgumentException When file is not found
      */

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

@@ -34,14 +34,7 @@ public function __construct(LoaderResolverInterface $resolver)
     }
 
     /**
-     * Loads a resource.
-     *
-     * @param mixed  $resource A resource
-     * @param string $type     The resource type
-     *
-     * @return mixed
-     *
-     * @throws FileLoaderLoadException if no loader is found.
+     * {@inheritdoc}
      */
     public function load($resource, $type = null)
     {

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

@@ -22,8 +22,14 @@
  */
 abstract class FileLoader extends Loader
 {
+    /**
+     * @var array
+     */
     protected static $loading = array();
 
+    /**
+     * @var FileLocatorInterface
+     */
     protected $locator;
 
     private $currentDir;
@@ -38,11 +44,21 @@ public function __construct(FileLocatorInterface $locator)
         $this->locator = $locator;
     }
 
+    /**
+     * Sets the current directory.
+     *
+     * @param string $dir
+     */
     public function setCurrentDir($dir)
     {
         $this->currentDir = $dir;
     }
 
+    /**
+     * Returns the file locator used by this loader.
+     *
+     * @return FileLocatorInterface
+     */
     public function getLocator()
     {
         return $this->locator;
@@ -51,10 +67,10 @@ public function getLocator()
     /**
      * Imports a resource.
      *
-     * @param mixed   $resource       A Resource
-     * @param string  $type           The resource type
-     * @param bool    $ignoreErrors   Whether to ignore import errors or not
-     * @param string  $sourceResource The original resource importing the new resource
+     * @param mixed       $resource       A Resource
+     * @param string|null $type           The resource type or null if unknown
+     * @param bool        $ignoreErrors   Whether to ignore import errors or not
+     * @param string|null $sourceResource The original resource importing the new resource
      *
      * @return mixed
      *

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

@@ -23,19 +23,15 @@ abstract class Loader implements LoaderInterface
     protected $resolver;
 
     /**
-     * Gets the loader resolver.
-     *
-     * @return LoaderResolverInterface A LoaderResolverInterface instance
+     * {@inheritdoc}
      */
     public function getResolver()
     {
         return $this->resolver;
     }
 
     /**
-     * Sets the loader resolver.
-     *
-     * @param LoaderResolverInterface $resolver A LoaderResolverInterface instance
+     * {@inheritdoc}
      */
     public function setResolver(LoaderResolverInterface $resolver)
     {
@@ -45,8 +41,8 @@ public function setResolver(LoaderResolverInterface $resolver)
     /**
      * Imports a resource.
      *
-     * @param mixed  $resource A Resource
-     * @param string $type     The resource type
+     * @param mixed       $resource A resource
+     * @param string|null $type     The resource type or null if unknown
      *
      * @return mixed
      */
@@ -58,12 +54,12 @@ public function import($resource, $type = null)
     /**
      * Finds a loader able to load an imported resource.
      *
-     * @param mixed  $resource A Resource
-     * @param string $type     The resource type
+     * @param mixed       $resource A resource
+     * @param string|null $type     The resource type or null if unknown
      *
      * @return LoaderInterface A LoaderInterface instance
      *
-     * @throws FileLoaderLoadException if no loader is found
+     * @throws FileLoaderLoadException If no loader is found
      */
     public function resolve($resource, $type = null)
     {

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

@@ -21,18 +21,20 @@ interface LoaderInterface
     /**
      * Loads a resource.
      *
-     * @param mixed  $resource The resource
-     * @param string $type     The resource type
+     * @param mixed       $resource The resource
+     * @param string|null $type     The resource type or null if unknown
+     *
+     * @throws \Exception If something went wrong
      */
     public function load($resource, $type = null);
 
     /**
-     * Returns true if this class supports the given resource.
+     * Returns whether this class supports the given resource.
      *
-     * @param mixed  $resource A resource
-     * @param string $type     The resource type
+     * @param mixed       $resource A resource
+     * @param string|null $type     The resource type or null if unknown
      *
-     * @return bool    true if this class supports the given resource, false otherwise
+     * @return bool True if this class supports the given resource, false otherwise
      */
     public function supports($resource, $type = null);
 

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

@@ -40,12 +40,7 @@ public function __construct(array $loaders = array())
     }
 
     /**
-     * Returns a loader able to load the resource.
-     *
-     * @param mixed  $resource A resource
-     * @param string $type     The resource type
-     *
-     * @return LoaderInterface|false A LoaderInterface instance
+     * {@inheritdoc}
      */
     public function resolve($resource, $type = null)
     {

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

@@ -21,10 +21,10 @@ interface LoaderResolverInterface
     /**
      * Returns a loader able to load the resource.
      *
-     * @param mixed  $resource A resource
-     * @param string $type     The resource type
+     * @param mixed       $resource A resource
+     * @param string|null $type     The resource type or null if unknown
      *
-     * @return LoaderInterface A LoaderInterface instance
+     * @return LoaderInterface|false The loader or false if none is able to load the resource
      */
     public function resolve($resource, $type = null);
 }

src/Symfony/Component/Config/Resource/DirectoryResource.php

@@ -24,8 +24,8 @@ class DirectoryResource implements ResourceInterface, \Serializable
     /**
      * Constructor.
      *
-     * @param string $resource The file path to the resource
-     * @param string $pattern  A pattern to restrict monitored files
+     * @param string      $resource The file path to the resource
+     * @param string|null $pattern  A pattern to restrict monitored files
      */
     public function __construct($resource, $pattern = null)
     {
@@ -34,36 +34,33 @@ public function __construct($resource, $pattern = null)
     }
 
     /**
-     * Returns a string representation of the Resource.
-     *
-     * @return string A string representation of the Resource
+     * {@inheritdoc}
      */
     public function __toString()
     {
         return (string) $this->resource;
     }
 
     /**
-     * Returns the resource tied to this Resource.
-     *
-     * @return mixed The resource
+     * {@inheritdoc}
      */
     public function getResource()
     {
         return $this->resource;
     }
 
+    /**
+     * Returns the pattern to restrict monitored files
+     *
+     * @return string|null
+     */
     public function getPattern()
     {
         return $this->pattern;
     }
 
     /**
-     * Returns true if the resource has not been updated since the given timestamp.
-     *
-     * @param int     $timestamp The last time the resource was loaded
-     *
-     * @return bool    true if the resource has not been updated, false otherwise
+     * {@inheritdoc}
      */
     public function isFresh($timestamp)
     {

src/Symfony/Component/Config/Resource/FileResource.php

@@ -20,6 +20,9 @@
  */
 class FileResource implements ResourceInterface, \Serializable
 {
+    /**
+     * @var string|false
+     */
     private $resource;
 
     /**
@@ -33,35 +36,27 @@ public function __construct($resource)
     }
 
     /**
-     * Returns a string representation of the Resource.
-     *
-     * @return string A string representation of the Resource
+     * {@inheritdoc}
      */
     public function __toString()
     {
         return (string) $this->resource;
     }
 
     /**
-     * Returns the resource tied to this Resource.
-     *
-     * @return mixed The resource
+     * {@inheritdoc}
      */
     public function getResource()
     {
         return $this->resource;
     }
 
     /**
-     * Returns true if the resource has not been updated since the given timestamp.
-     *
-     * @param int     $timestamp The last time the resource was loaded
-     *
-     * @return bool    true if the resource has not been updated, false otherwise
+     * {@inheritdoc}
      */
     public function isFresh($timestamp)
     {
-        if (!file_exists($this->resource)) {
+        if (false === $this->resource || !file_exists($this->resource)) {
             return false;
         }
 

src/Symfony/Component/Config/Resource/ResourceInterface.php

@@ -28,14 +28,14 @@ public function __toString();
     /**
      * Returns true if the resource has not been updated since the given timestamp.
      *
-     * @param int     $timestamp The last time the resource was loaded
+     * @param int $timestamp The last time the resource was loaded
      *
-     * @return bool    true if the resource has not been updated, false otherwise
+     * @return bool True if the resource has not been updated, false otherwise
      */
     public function isFresh($timestamp);
 
     /**
-     * Returns the resource tied to this Resource.
+     * Returns the tied resource.
      *
      * @return mixed The resource
      */

src/Symfony/Component/Config/Tests/FileLocatorTest.php

@@ -87,6 +87,7 @@ public function testLocate()
 
     /**
      * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The file "foobar.xml" does not exist
      */
     public function testLocateThrowsAnExceptionIfTheFileDoesNotExists()
     {
@@ -104,4 +105,15 @@ public function testLocateThrowsAnExceptionIfTheFileDoesNotExistsInAbsolutePath(
 
         $loader->locate(__DIR__.'/Fixtures/foobar.xml', __DIR__);
     }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage An empty file name is not valid to be located.
+     */
+    public function testLocateEmpty()
+    {
+        $loader = new FileLocator(array(__DIR__.'/Fixtures'));
+
+        $loader->locate(null, __DIR__);
+    }
 }