1. class
  2. Symfony
  3. Component
  4. Config
  5. FileLocator

FileLocator

class FileLocator implements FileLocatorInterface

FileLocator uses an array of pre-defined paths to find files.

Methods

__construct(string|array $paths = array())

Constructor.

string|array
locate(string $name, string|null $currentPath = null, bool $first = true)

Returns a full path for a given file name.

Details

at line line 28
__construct(string|array $paths = array())

Constructor.

Parameters

string|array $paths A path or an array of paths where to look for resources

at line line 36
string|array locate(string $name, string|null $currentPath = null, bool $first = true)

Returns a full path for a given file name.

Parameters

string $name The file name to locate
string|null $currentPath The current path
bool $first Whether to return the first occurrence or an array of filenames

Return Value

string|array The full path to the file or an array of file paths

Exceptions

InvalidArgumentException When file is not found