class XmlFileLoader extends FileLoader

XmlFileLoader loads XML routing files.

Constants

NAMESPACE_URI

SCHEME_PATH

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)

Constructor.

setCurrentDir(string $dir)

Sets the current directory.

getLocator()

Returns the file locator used by this loader.

load(string $file, string|null $type = null)

Loads an XML file.

bool
supports(mixed $resource, string|null $type = null)

Returns whether this class supports the given resource.

Details

in Loader at line line 28
LoaderResolverInterface getResolver()

Gets the loader resolver.

Return Value

LoaderResolverInterface A LoaderResolverInterface instance

in Loader at line line 36
setResolver(LoaderResolverInterface $resolver)

Sets the loader resolver.

Parameters

LoaderResolverInterface $resolver A LoaderResolverInterface instance

in FileLoader at line line 80
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

in Loader at line 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

FileLoaderLoadException If no loader is found

in FileLoader at line line 42
__construct(FileLocatorInterface $locator)

Constructor.

Parameters

FileLocatorInterface $locator A FileLocatorInterface instance

in FileLoader at line line 52
setCurrentDir(string $dir)

Sets the current directory.

Parameters

string $dir

in FileLoader at line line 62
FileLocatorInterface getLocator()

Returns the file locator used by this loader.

Return Value

FileLocatorInterface

at line line 42
load(string $file, string|null $type = null)

Loads an XML file.

Parameters

string $file An XML file path
string|null $type The resource type or null if unknown

Exceptions

InvalidArgumentException When the file cannot be loaded or when the XML cannot be parsed because it does not validate against the scheme.

at line line 94
bool supports(mixed $resource, string|null $type = null)

Returns whether this class supports the given resource.

Parameters

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

Return Value

bool True if this class supports the given resource, false otherwise