1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpKernel
  7. \
  8. Config
  9. \
  10. FileLocator

FileLocator

class FileLocator extends FileLocator

FileLocator uses the KernelInterface to locate resources in bundles.

Properties

protected $paths from FileLocator

Methods

__construct(KernelInterface $kernel, string $path = null, string|string[] $paths = array())

No description

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

Returns a full path for a given file name.

Details

__construct(KernelInterface $kernel, string $path = null, string|string[] $paths = array())

Parameters

KernelInterface $kernel A KernelInterface instance
string $path The path the global resource directory
string|string[] $paths A path or an array of paths where to look for resources

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

Returns a full path for a given file name.

Parameters

$file
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