YamlFileLoader
extends FileLoader
in package
YamlFileLoader loads Yaml routing files.
Tags
Table of Contents
- $loading : mixed
- $locator : mixed
- $resolver : mixed
- $availableKeys : mixed
- $currentDir : mixed
- $yamlParser : 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 a Yaml file.
- resolve() : $this|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}
- parseImport() : mixed
- Parses an import and adds the routes in the resource to the RouteCollection.
- parseRoute() : mixed
- Parses a route and adds it to the RouteCollection.
- validate() : mixed
- Validates the route configuration.
- doImport() : mixed
Properties
$loading
protected
static mixed
$loading
= []
$locator
protected
mixed
$locator
$resolver
protected
mixed
$resolver
$availableKeys
private
static mixed
$availableKeys
= ['resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'name_prefix', 'trailing_slash_on_root', 'locale', 'format', 'utf8', 'exclude']
$currentDir
private
mixed
$currentDir
$yamlParser
private
mixed
$yamlParser
Methods
__construct()
public
__construct(FileLocatorInterface $locator) : mixed
Parameters
- $locator : FileLocatorInterface
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 —A LoaderResolverInterface instance
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 a Yaml file.
public
load(string $file[, string|null $type = null ]) : RouteCollection
Parameters
- $file : string
-
A Yaml file path
- $type : string|null = null
-
The resource type
Tags
Return values
RouteCollection —A RouteCollection instance
resolve()
Finds a loader able to load an imported resource.
public
resolve(mixed $resource[, string|null $type = null ]) : $this|LoaderInterface
Parameters
- $resource : mixed
-
A resource
- $type : string|null = null
-
The resource type or null if unknown
Tags
Return values
$this|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 $type = null ]) : mixed
Parameters
- $resource : mixed
- $type : string = null
Return values
mixed —parseImport()
Parses an import and adds the routes in the resource to the RouteCollection.
protected
parseImport(RouteCollection $collection, array<string|int, mixed> $config, string $path, string $file) : mixed
Parameters
- $collection : RouteCollection
- $config : array<string|int, mixed>
-
Route definition
- $path : string
-
Full path of the YAML file being processed
- $file : string
-
Loaded file name
Return values
mixed —parseRoute()
Parses a route and adds it to the RouteCollection.
protected
parseRoute(RouteCollection $collection, string $name, array<string|int, mixed> $config, string $path) : mixed
Parameters
- $collection : RouteCollection
- $name : string
-
Route name
- $config : array<string|int, mixed>
-
Route definition
- $path : string
-
Full path of the YAML file being processed
Return values
mixed —validate()
Validates the route configuration.
protected
validate(array<string|int, mixed> $config, string $name, string $path) : mixed
Parameters
- $config : array<string|int, mixed>
-
A resource config
- $name : string
-
The config key
- $path : string
-
The loaded file path
Tags
Return values
mixed —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