XmlFileLoader

class XmlFileLoader extends FileLoader

XmlFileLoader loads XML routing files.

Constants

NAMESPACE_URI
SCHEME_PATH

Methods

LoaderResolverInterface 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.

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

Finds a loader able to load an imported resource.

from Loader
__construct(FileLocatorInterface $locator)

Constructor.

from FileLoader
setCurrentDir(string $dir)

Sets the current directory.

from FileLoader
FileLocatorInterface getLocator()

Returns the file locator used by this loader.

from FileLoader
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

LoaderResolverInterface getResolver()

Gets the loader resolver.

Return Value

LoaderResolverInterface A LoaderResolverInterface instance

setResolver(LoaderResolverInterface $resolver)

Sets the loader resolver.

Parameters

LoaderResolverInterface $resolver A LoaderResolverInterface instance

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

FileLoaderLoadException
FileLoaderImportCircularReferenceException

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

LoaderInterface A LoaderInterface instance

Exceptions

FileLoaderLoadException If no loader is found

__construct(FileLocatorInterface $locator)

Constructor.

Parameters

FileLocatorInterface $locator A FileLocatorInterface instance

setCurrentDir(string $dir)

Sets the current directory.

Parameters

string $dir

FileLocatorInterface getLocator()

Returns the file locator used by this loader.

Return Value

FileLocatorInterface

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.

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
doc_Symfony
2016-10-28 06:37:22
Comments
Leave a Comment

Please login to continue.