[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of the Symfony package.
   5   *
   6   * (c) Fabien Potencier <fabien@symfony.com>
   7   *
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  namespace Symfony\Component\Config;
  13  
  14  use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;
  15  
  16  /**
  17   * @author Fabien Potencier <fabien@symfony.com>
  18   */
  19  interface FileLocatorInterface
  20  {
  21      /**
  22       * Returns a full path for a given file name.
  23       *
  24       * @param string      $name        The file name to locate
  25       * @param string|null $currentPath The current path
  26       * @param bool        $first       Whether to return the first occurrence or an array of filenames
  27       *
  28       * @return string|array The full path to the file or an array of file paths
  29       *
  30       * @throws \InvalidArgumentException        If $name is empty
  31       * @throws FileLocatorFileNotFoundException If a file is not found
  32       */
  33      public function locate($name, $currentPath = null, $first = true);
  34  }