YamlFileLoader

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

protected glob(string $pattern, bool $recursive, $resource = null, bool $ignoreErrors = false)

Parameters

string	$pattern
bool	$recursive
	$resource
bool	$ignoreErrors

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

protected parseRoute(RouteCollection $collection, string $name, array $config, string $path)

Parses a route and adds it to the RouteCollection.

Parameters

RouteCollection	$collection	A RouteCollection instance
string	$name	Route name
array	$config	Route definition
string	$path	Full path of the YAML file being processed

protected parseImport(RouteCollection $collection, array $config, string $path, string $file)

Parses an import and adds the routes in the resource to the RouteCollection.

Parameters

RouteCollection	$collection	A RouteCollection instance
array	$config	Route definition
string	$path	Full path of the YAML file being processed
string	$file	Loaded file name

protected validate(array $config, string $name, string $path)

Validates the route configuration.

Parameters

array	$config	A resource config
string	$name	The config key
string	$path	The loaded file path

Exceptions

InvalidArgumentException

If one of the provided config keys is not supported, something is missing or the combination is nonsense