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

AnnotationFileLoader

class AnnotationFileLoader extends FileLoader

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

Properties

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

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, AnnotationClassLoader $loader)

No description

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

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

Returns whether this class supports the given resource.

string|false
findClass(string $file)

Returns the full class name for the first class in the 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(FileLocatorInterface $locator, AnnotationClassLoader $loader)

Parameters

FileLocatorInterface $locator
AnnotationClassLoader $loader

Exceptions

RuntimeException

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 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

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 string|false findClass(string $file)

Returns the full class name for the first class in the file.

Parameters

string $file A PHP file path

Return Value

string|false Full class name if found, false otherwise