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

YamlFileLoader

class YamlFileLoader extends FileLoader

YamlFileLoader loads YAML files service definitions.

Properties

protected $resolver from Loader
static protected $loading from FileLoader
protected $locator from FileLoader
protected $container from FileLoader
protected $isLoadingInstanceof from FileLoader
protected $instanceof 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(ContainerBuilder $container, 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
registerClasses(Definition $prototype, string $namespace, string $resource, string|string[]|null $exclude = null)

Registers a set of classes as services using PSR-4 for discovery.

from FileLoader
setDefinition(string $id, Definition $definition)

Registers a definition in the container with its instanceof-conditionals.

from FileLoader
load(mixed $resource, string|null $type = null)

Loads a resource.

bool
supports(mixed $resource, string|null $type = null)

Returns whether this class supports the given resource.

array
loadFile(string $file)

Loads a YAML file.

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(ContainerBuilder $container, FileLocatorInterface $locator)

Parameters

ContainerBuilder $container
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

registerClasses(Definition $prototype, string $namespace, string $resource, string|string[]|null $exclude = null)

Registers a set of classes as services using PSR-4 for discovery.

Parameters

Definition $prototype A definition to use as template
string $namespace The namespace prefix of classes in the scanned directory
string $resource The directory to look for classes, glob-patterns allowed
string|string[]|null $exclude A globbed path of files to exclude or an array of globbed paths of files to exclude

protected setDefinition(string $id, Definition $definition)

Registers a definition in the container with its instanceof-conditionals.

Parameters

string $id
Definition $definition

load(mixed $resource, string|null $type = null)

Loads a resource.

Parameters

mixed $resource The resource
string|null $type The resource type or null if unknown

Exceptions

Exception If something went wrong

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 array loadFile(string $file)

Loads a YAML file.

Parameters

string $file

Return Value

array The file content

Exceptions

InvalidArgumentException when the given file is not a local file or when it does not exist