abstract class FileLoader extends Loader

FileLoader is the abstract class used by all built-in loaders that are file based.

Properties

protected $resolver from Loader
static protected $loading
protected $locator

Methods

getResolver()

Gets the loader resolver.

from Loader
setResolver(LoaderResolverInterface $resolver)

Sets the loader resolver.

from Loader
mixed
import(mixed $resource, string|null $type = null, bool $ignoreErrors = false, string|null $sourceResource = null)

Imports a resource.

resolve(mixed $resource, string|null $type = null)

Finds a loader able to load an imported resource.

from Loader
__construct(FileLocatorInterface $locator)

No description

setCurrentDir(string $dir)

Sets the current directory.

getLocator()

Returns the file locator used by this loader.

glob(string $pattern, bool $recursive, $resource = null, bool $ignoreErrors = false, bool $forExclusion = false, array $excluded = [])

No description

Details

in Loader at line 28
LoaderResolverInterface getResolver()

Gets the loader resolver.

Return Value

LoaderResolverInterface A LoaderResolverInterface instance

in Loader at line 36
setResolver(LoaderResolverInterface $resolver)

Sets the loader resolver.

Parameters

LoaderResolverInterface $resolver

at line 73
mixed import(mixed $resource, string|null $type = null, bool $ignoreErrors = false, string|null $sourceResource = null)

Imports a resource.

Parameters

mixed $resource A resource
string|null $type The resource type or null if unknown
bool $ignoreErrors Whether to ignore import errors or not
string|null $sourceResource The original resource importing the new resource

Return Value

mixed

Exceptions

LoaderLoadException
FileLoaderImportCircularReferenceException
FileLocatorFileNotFoundException

in Loader at line 64
$this|LoaderInterface resolve(mixed $resource, string|null $type = null)

Finds a loader able to load an imported resource.

Parameters

mixed $resource A resource
string|null $type The resource type or null if unknown

Return Value

$this|LoaderInterface

Exceptions

LoaderLoadException If no loader is found

at line 34
__construct(FileLocatorInterface $locator)

Parameters

FileLocatorInterface $locator

at line 44
setCurrentDir(string $dir)

Sets the current directory.

Parameters

string $dir

at line 54
FileLocatorInterface getLocator()

Returns the file locator used by this loader.

Return Value

FileLocatorInterface

at line 96
protected glob(string $pattern, bool $recursive, $resource = null, bool $ignoreErrors = false, bool $forExclusion = false, array $excluded = [])

Parameters

string $pattern
bool $recursive
$resource
bool $ignoreErrors
bool $forExclusion
array $excluded