class AnnotationFileLoader extends FileLoader
AnnotationFileLoader loads routing information from annotations set on a PHP class and its 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) | ||
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. |
Gets the loader resolver.
LoaderResolverInterface | A LoaderResolverInterface instance |
Sets the loader resolver.
LoaderResolverInterface | $resolver |
Imports a resource.
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 |
mixed |
FileLoaderLoadException | |
FileLoaderImportCircularReferenceException | |
FileLocatorFileNotFoundException |
Finds a loader able to load an imported resource.
mixed | $resource | A resource |
string|null | $type | The resource type or null if unknown |
$this|LoaderInterface |
FileLoaderLoadException | If no loader is found |
FileLocatorInterface | $locator | |
AnnotationClassLoader | $loader |
RuntimeException |
Sets the current directory.
string | $dir |
Returns the file locator used by this loader.
FileLocatorInterface |
Loads from annotations from a file.
string | $file | A PHP file path |
string|null | $type | The resource type or null if unknown |
InvalidArgumentException | When the file does not exist or its routes cannot be parsed |
Returns whether this class supports the given resource.
mixed | $resource | A resource |
string|null | $type | The resource type or null if unknown |
bool | True if this class supports the given resource, false otherwise |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Routing/Loader/AnnotationFileLoader.html