XmlFileLoader

class XmlFileLoader extends FileLoader

XmlFileLoader loads XML files service definitions.

Constants

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(ContainerBuilder $container, FileLocatorInterface $locator)	from FileLoader
	setCurrentDir(string $dir) Sets the current directory.	from FileLoader
FileLocatorInterface	getLocator() Returns the file locator used by this loader.	from FileLoader
	load(mixed $resource, string\|null $type = null) Loads a resource.
bool	supports(mixed $resource, string\|null $type = null) Returns whether this class supports the given resource.
bool	validateSchema(DOMDocument $dom) Validates a documents XML schema.
static array	convertDomElementToArray(DOMElement $element) Converts a \DomElement object to a PHP array.

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(ContainerBuilder $container, FileLocatorInterface $locator)

Parameters

ContainerBuilder	$container	A ContainerBuilder instance
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(mixed $resource, string|null $type = null)

Loads a resource.

Parameters

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

Exceptions

Exception

If something went wrong

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

bool validateSchema(DOMDocument $dom)

Validates a documents XML schema.

Parameters

DOMDocument

$dom

Return Value

bool

Exceptions

RuntimeException

When extension references a non-existent XSD file

static array convertDomElementToArray(DOMElement $element)

Converts a \DomElement object to a PHP array.

The following rules applies during the conversion:

Each tag is converted to a key value or an array if there is more than one "value"
The content of a tag is set under a "value" key (bar) if the tag also has some nested tags
The attributes are converted to keys ()
The nested-tags are converted to keys (bar)

Parameters

DOMElement

$element

A \DomElement instance

Return Value

array

A PHP array

Links:

http://api.symfony.com/master/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.html

doc_Symfony

2016-10-28 06:37:21

Comments