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 | 
| $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)  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
LoaderResolverInterface getResolver()
Gets the loader resolver.
Return Value
| LoaderResolverInterface | A LoaderResolverInterface instance | 
setResolver(LoaderResolverInterface $resolver)
Sets the loader resolver.
Parameters
| LoaderResolverInterface | $resolver | A LoaderResolverInterface instance | 
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 | 
$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
| FileLoaderLoadException | If no loader is found | 
__construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
Constructor.
Parameters
| FileLocatorInterface | $locator | A FileLocatorInterface instance | 
| AnnotationClassLoader | $loader | An AnnotationClassLoader instance | 
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 | 
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 | 
    © 2004–2017 Fabien Potencier
Licensed under the MIT License.
    http://api.symfony.com/3.2/Symfony/Component/Routing/Loader/AnnotationFileLoader.html