1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Routing
  7. \
  8. Loader
  9. \
  10. YamlFileLoader

YamlFileLoader

class YamlFileLoader extends FileLoader

YamlFileLoader loads Yaml routing files.

Properties

protected $resolver from Loader
static protected $loading from FileLoader
protected $locator from FileLoader

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)

No description

from FileLoader
setCurrentDir(string $dir)

Sets the current directory.

from FileLoader
FileLocatorInterface
getLocator()

Returns the file locator used by this loader.

from FileLoader
glob(string $pattern, bool $recursive, $resource = null, bool $ignoreErrors = false, bool $forExclusion = false, array $excluded = array())

No description

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.

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

Parses a route and adds it to the RouteCollection.

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

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

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

Validates the route configuration.

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

LoaderLoadException
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

LoaderLoadException 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, bool $forExclusion = false, array $excluded = array())

Parameters

string $pattern
bool $recursive
$resource
bool $ignoreErrors
bool $forExclusion
array $excluded

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