Documentation

XmlFileLoader extends FileLoader
in package
Uses HostTrait, LocalizedRouteTrait, PrefixTrait

XmlFileLoader loads XML routing files.

Tags
author

Fabien Potencier fabien@symfony.com

author

Tobias Schultze http://tobion.de

Table of Contents

Constants

NAMESPACE_URI  = 'http://symfony.com/schema/routing'
SCHEME_PATH  = '/schema/routing/routing-1.0.xsd'

Properties

$env  : mixed
$loading  : mixed
$locator  : mixed
$resolver  : mixed
$currentDir  : string|null

Methods

__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
resolve()  : LoaderInterface
Finds a loader able to load an imported resource.
setCurrentDir()  : mixed
Sets the current directory.
setResolver()  : mixed
Sets the loader resolver.
supports()  : bool
{@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

$resolver

protected mixed $resolver

$currentDir

private string|null $currentDir = null

Methods

__construct()

public __construct([string $env = null ]) : mixed
Parameters
$env : string = null

import()

Imports a resource.

public import(mixed $resource[, string $type = null ]) : mixed
Parameters
$resource : mixed
$type : string = null

load()

public load(mixed $file[, string $type = null ]) : RouteCollection
Parameters
$file : mixed
$type : string = null
Tags
throws
InvalidArgumentException

when the file cannot be loaded or when the XML cannot be parsed because it does not validate against the scheme

Return values
RouteCollection

setCurrentDir()

Sets the current directory.

public setCurrentDir(string $dir) : mixed
Parameters
$dir : string

supports()

{@inheritdoc}

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

loadFile()

protected loadFile(string $file) : DOMDocument
Parameters
$file : string
Tags
throws
InvalidArgumentException

When loading of XML file fails because of syntax errors or when the XML structure is not as expected by the scheme - see validate()

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
throws
InvalidArgumentException

When the XML is invalid

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
throws
InvalidArgumentException

When the XML is invalid

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
throws
InvalidArgumentException

When the XML is invalid

doImport()

private doImport(mixed $resource[, string $type = null ][, bool $ignoreErrors = false ][, string $sourceResource = null ]) : mixed
Parameters
$resource : mixed
$type : string = null
$ignoreErrors : bool = false
$sourceResource : string = null

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
throws
InvalidArgumentException

When the XML is invalid

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
throws
InvalidArgumentException

when the XML is invalid

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
Tags
throws
InvalidArgumentException

When the XML is invalid

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results