Documentation

XmlFileLoader extends FileLoader
in package

XmlFileLoader loads configuration parameters from xml file.

Tags
author

Cristiano Cinotti cristianocinotti@gmail.com

Table of Contents

Properties

$keepFirstTag  : bool

Methods

__construct()  : mixed
load()  : array<string|int, mixed>
Loads a Xml file.
supports()  : bool
Returns true if this class supports the given resource.

Properties

Methods

__construct()

public __construct(FileLocatorInterface $fileLocator[, bool $keepFirstTag = false ]) : mixed
Parameters
$fileLocator : FileLocatorInterface
$keepFirstTag : bool = false

load()

Loads a Xml file.

public load(mixed $resource[, string|null $type = null ]) : array<string|int, mixed>
Parameters
$resource : mixed

The resource to load.

$type : string|null = null

The resource type.

Tags
throws
ConverterException

If an error occurs while parsing the xml.

throws
ConfigurationBuilderException

If an error occurs while reading the xml file.

psalm-suppress

PossiblyInvalidArgument FileLocator::locate() returns string, since 3rd argument isn't false

Return values
array<string|int, mixed>

supports()

Returns true if this class supports the given resource.

public supports(mixed $resource[, string|null $type = null ]) : bool
Parameters
$resource : mixed

A resource.

$type : string|null = null

The resource type.

Return values
bool

true If this class supports the given resource, false otherwise.


        
On this page

Search results