XmlFileLoader
extends FileLoader
in package
Uses
HostTrait, LocalizedRouteTrait, PrefixTrait
XmlFileLoader loads XML routing files.
Tags
Table of Contents
- NAMESPACE_URI = 'http://symfony.com/schema/routing'
- SCHEME_PATH = '/schema/routing/routing-1.0.xsd'
- $env : mixed
- $loading : mixed
- $locator : mixed
- $resolver : mixed
- $currentDir : mixed
- __construct() : mixed
- getLocator() : FileLocatorInterface
- Returns the file locator used by this loader.
- getResolver() : LoaderResolverInterface
- Gets the loader resolver.
- import() : mixed
- Imports a resource.
- load() : RouteCollection
- Loads an XML file.
- resolve() : LoaderInterface
- Finds a loader able to load an imported resource.
- setCurrentDir() : mixed
- Sets the current directory.
- setResolver() : mixed
- Sets the loader resolver.
- supports() : mixed
- {@inheritdoc}
- loadFile() : DOMDocument
- parseImport() : mixed
- Parses an import and adds the routes in the resource to the RouteCollection.
- parseNode() : mixed
- Parses a node from a loaded XML file.
- parseRoute() : mixed
- Parses a route and adds it to the RouteCollection.
- doImport() : mixed
- isElementValueNull() : bool
- parseConfigs() : array<string|int, mixed>
- Parses the config elements (default, requirement, option).
- parseDefaultNode() : array<string|int, mixed>|bool|float|int|string|null
- Recursively parses the value of a "default" element.
- parseDefaultsConfig() : array<string|int, mixed>|bool|float|int|string|null
- Parses the "default" elements.
- parseDeprecation() : array<string|int, mixed>
- Parses the deprecation elements.
Constants
NAMESPACE_URI
public
mixed
NAMESPACE_URI
= 'http://symfony.com/schema/routing'
SCHEME_PATH
public
mixed
SCHEME_PATH
= '/schema/routing/routing-1.0.xsd'
Properties
$env
protected
mixed
$env
$loading
protected
static mixed
$loading
= []
$locator
protected
mixed
$locator
$resolver
protected
mixed
$resolver
$currentDir
private
mixed
$currentDir
Methods
__construct()
public
__construct([string|null $env = null ]) : mixed
Parameters
- $env : string|null = null
Return values
mixed —getLocator()
Returns the file locator used by this loader.
public
getLocator() : FileLocatorInterface
Return values
FileLocatorInterface —getResolver()
Gets the loader resolver.
public
getResolver() : LoaderResolverInterface
Return values
LoaderResolverInterface —import()
Imports a resource.
public
import(mixed $resource[, string|null $type = null ]) : mixed
Parameters
- $resource : mixed
-
A resource
- $type : string|null = null
-
The resource type or null if unknown
Return values
mixed —load()
Loads an XML file.
public
load(string $file[, string|null $type = null ]) : RouteCollection
Parameters
- $file : string
-
An XML file path
- $type : string|null = null
-
The resource type
Tags
Return values
RouteCollection —resolve()
Finds a loader able to load an imported resource.
public
resolve(mixed $resource[, string|null $type = null ]) : LoaderInterface
Parameters
- $resource : mixed
-
A resource
- $type : string|null = null
-
The resource type or null if unknown
Tags
Return values
LoaderInterface —setCurrentDir()
Sets the current directory.
public
setCurrentDir(string $dir) : mixed
Parameters
- $dir : string
Return values
mixed —setResolver()
Sets the loader resolver.
public
setResolver(LoaderResolverInterface $resolver) : mixed
Parameters
- $resolver : LoaderResolverInterface
Return values
mixed —supports()
{@inheritdoc}
public
supports(mixed $resource[, string|null $type = null ]) : mixed
Parameters
- $resource : mixed
- $type : string|null = null
Return values
mixed —loadFile()
protected
loadFile(string $file) : DOMDocument
Parameters
- $file : string
Tags
Return values
DOMDocument —parseImport()
Parses an import and adds the routes in the resource to the RouteCollection.
protected
parseImport(RouteCollection $collection, DOMElement $node, string $path, string $file) : mixed
Parameters
- $collection : RouteCollection
- $node : DOMElement
- $path : string
- $file : string
Tags
Return values
mixed —parseNode()
Parses a node from a loaded XML file.
protected
parseNode(RouteCollection $collection, DOMElement $node, string $path, string $file) : mixed
Parameters
- $collection : RouteCollection
- $node : DOMElement
- $path : string
- $file : string
Tags
Return values
mixed —parseRoute()
Parses a route and adds it to the RouteCollection.
protected
parseRoute(RouteCollection $collection, DOMElement $node, string $path) : mixed
Parameters
- $collection : RouteCollection
- $node : DOMElement
- $path : string
Tags
Return values
mixed —doImport()
private
doImport(mixed $resource[, string|null $type = null ][, bool $ignoreErrors = false ][, string|null $sourceResource = null ]) : mixed
Parameters
- $resource : mixed
- $type : string|null = null
- $ignoreErrors : bool = false
- $sourceResource : string|null = null
Return values
mixed —isElementValueNull()
private
isElementValueNull(DOMElement $element) : bool
Parameters
- $element : DOMElement
Return values
bool —parseConfigs()
Parses the config elements (default, requirement, option).
private
parseConfigs(DOMElement $node, string $path) : array<string|int, mixed>
Parameters
- $node : DOMElement
- $path : string
Tags
Return values
array<string|int, mixed> —parseDefaultNode()
Recursively parses the value of a "default" element.
private
parseDefaultNode(DOMElement $node, string $path) : array<string|int, mixed>|bool|float|int|string|null
Parameters
- $node : DOMElement
- $path : string
Tags
Return values
array<string|int, mixed>|bool|float|int|string|null —parseDefaultsConfig()
Parses the "default" elements.
private
parseDefaultsConfig(DOMElement $element, string $path) : array<string|int, mixed>|bool|float|int|string|null
Parameters
- $element : DOMElement
- $path : string
Return values
array<string|int, mixed>|bool|float|int|string|null —parseDeprecation()
Parses the deprecation elements.
private
parseDeprecation(DOMElement $node, string $path) : array<string|int, mixed>
Parameters
- $node : DOMElement
- $path : string