1. class
  2. Symfony
  3. Component
  4. DependencyInjection
  5. Loader
  6. XmlFileLoader

XmlFileLoader

class XmlFileLoader extends FileLoader

XmlFileLoader loads XML files service definitions.

Constants

NS

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)

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(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

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

Exceptions

FileLoaderLoadException
FileLoaderImportCircularReferenceException

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

in FileLoader at line line 33
__construct(ContainerBuilder $container, FileLocatorInterface $locator)

Constructor.

Parameters

ContainerBuilder $container A ContainerBuilder instance
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 37
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

at line line 64
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

at line line 430
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

at line line 562
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