interface FileLocatorInterface

Methods

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 33
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 If $name is empty
FileLocatorFileNotFoundException If a file is not found