YamlFileLoader
class YamlFileLoader extends FileLoader
YamlFileLoader loads Yaml routing files.
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 |
$this|LoaderInterface | resolve(mixed $resource, string|null $type = null) Finds a loader able to load an imported resource. | from Loader |
__construct(FileLocatorInterface $locator) | from FileLoader | |
setCurrentDir(string $dir) Sets the current directory. | from FileLoader | |
FileLocatorInterface | getLocator() Returns the file locator used by this loader. | from FileLoader |
load(string $file, string|null $type = null) Loads a Yaml file. | ||
bool | supports(mixed $resource, string|null $type = null) Returns whether this class supports the given resource. |
Details
LoaderResolverInterface getResolver()
Gets the loader resolver.
Return Value
LoaderResolverInterface | A LoaderResolverInterface instance |
setResolver(LoaderResolverInterface $resolver)
Sets the loader resolver.
Parameters
LoaderResolverInterface | $resolver |
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 | |
FileLocatorFileNotFoundException |
$this|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
$this|LoaderInterface |
Exceptions
FileLoaderLoadException | If no loader is found |
__construct(FileLocatorInterface $locator)
Parameters
FileLocatorInterface | $locator |
setCurrentDir(string $dir)
Sets the current directory.
Parameters
string | $dir |
FileLocatorInterface getLocator()
Returns the file locator used by this loader.
Return Value
FileLocatorInterface |
load(string $file, string|null $type = null)
Loads a Yaml file.
Parameters
string | $file | A Yaml file path |
string|null | $type | The resource type or null if unknown |
Exceptions
InvalidArgumentException | When a route can't be parsed because YAML is invalid |
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Routing/Loader/YamlFileLoader.html