1. class
  2. Symfony
  3. Component
  4. Routing
  5. Loader
  6. AnnotationFileLoader

AnnotationFileLoader

class AnnotationFileLoader extends FileLoader

AnnotationFileLoader loads routing information from annotations set on a PHP class and its methods.

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
LoaderInterface
resolve(mixed $resource, string|null $type = null)

Finds a loader able to load an imported resource.

from Loader
__construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)

Constructor.

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 from annotations from a file.

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

Returns whether this class supports the given resource.

Details

in Loader at line line 28
LoaderResolverInterface getResolver()

Gets the loader resolver.

Return Value

LoaderResolverInterface A LoaderResolverInterface instance

in Loader at line line 36
setResolver(LoaderResolverInterface $resolver)

Sets the loader resolver.

Parameters

LoaderResolverInterface $resolver A LoaderResolverInterface instance

in FileLoader at line line 80
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

in Loader at line line 64
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

LoaderInterface A LoaderInterface instance

Exceptions

FileLoaderLoadException If no loader is found

at line line 37
__construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)

Constructor.

Parameters

FileLocatorInterface $locator A FileLocatorInterface instance
AnnotationClassLoader $loader An AnnotationClassLoader instance

Exceptions

RuntimeException

in FileLoader at line line 52
setCurrentDir(string $dir)

Sets the current directory.

Parameters

string $dir

in FileLoader at line line 62
FileLocatorInterface getLocator()

Returns the file locator used by this loader.

Return Value

FileLocatorInterface

at line line 58
load(string $file, string|null $type = null)

Loads from annotations from a file.

Parameters

string $file A PHP file path
string|null $type The resource type or null if unknown

Exceptions

InvalidArgumentException When the file does not exist or its routes cannot be parsed

at line line 74
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