37 lines
1.1 KiB
PHP
37 lines
1.1 KiB
PHP
|
<?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;
|
||
|
|
|
||
|
|
use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
||
|
|
*/
|
||
|
|
interface FileLocatorInterface
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Returns a full path for a given file name.
|
||
|
|
*
|
||
|
|
* @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|string[] The full path to the file or an array of file paths
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException If $name is empty
|
||
|
|
* @throws FileLocatorFileNotFoundException If a file is not found
|
||
|
|
*
|
||
|
|
* @psalm-return ($first is true ? string : string[])
|
||
|
|
*/
|
||
|
|
public function locate(string $name, ?string $currentPath = null, bool $first = true): string|array;
|
||
|
|
}
|