FileLoader
extends Loader
in package
AbstractYes
FileLoader is the abstract class used by all built-in loaders that are file based.
Tags
Table of Contents
Properties
- $env : mixed
- $loading : mixed
- $locator : mixed
- $resolver : mixed
- $currentDir : string|null
Methods
- __construct() : mixed
- getLocator() : FileLocatorInterface
- Returns the file locator used by this loader.
- getResolver() : LoaderResolverInterface
- Gets the loader resolver.
- import() : mixed
- Imports a resource.
- resolve() : LoaderInterface
- Finds a loader able to load an imported resource.
- setCurrentDir() : mixed
- Sets the current directory.
- setResolver() : mixed
- Sets the loader resolver.
- doImport() : mixed
Properties
$env
protected
mixed
$env
$loading
protected
static mixed
$loading
= []
$locator
protected
mixed
$locator
$resolver
protected
mixed
$resolver
$currentDir
private
string|null
$currentDir
= null
Methods
__construct()
public
__construct(FileLocatorInterface $locator[, string $env = null ]) : mixed
Parameters
- $locator : FileLocatorInterface
- $env : string = null
getLocator()
Returns the file locator used by this loader.
public
getLocator() : FileLocatorInterface
Return values
FileLocatorInterfacegetResolver()
Gets the loader resolver.
public
getResolver() : LoaderResolverInterface
Return values
LoaderResolverInterfaceimport()
Imports a resource.
public
import(mixed $resource[, string|null $type = null ][, bool $ignoreErrors = false ][, string|null $sourceResource = null ][, string|array<string|int, string>|null $exclude = null ]) : mixed
Parameters
- $resource : mixed
-
A Resource
- $type : string|null = null
-
The resource type or null if unknown
- $ignoreErrors : bool = false
-
Whether to ignore import errors or not
- $sourceResource : string|null = null
-
The original resource importing the new resource
- $exclude : string|array<string|int, string>|null = null
-
Glob patterns to exclude from the import
Tags
resolve()
Finds a loader able to load an imported resource.
public
resolve(mixed $resource[, string $type = null ]) : LoaderInterface
Parameters
- $resource : mixed
- $type : string = null
Tags
Return values
LoaderInterfacesetCurrentDir()
Sets the current directory.
public
setCurrentDir(string $dir) : mixed
Parameters
- $dir : string
setResolver()
Sets the loader resolver.
public
setResolver(LoaderResolverInterface $resolver) : mixed
Parameters
- $resolver : LoaderResolverInterface
doImport()
private
doImport(mixed $resource[, string $type = null ][, bool $ignoreErrors = false ][, string $sourceResource = null ]) : mixed
Parameters
- $resource : mixed
- $type : string = null
- $ignoreErrors : bool = false
- $sourceResource : string = null