AnnotationFileLoader
class AnnotationFileLoader extends FileLoader
AnnotationFileLoader загружает информацию маршрутизации из аннотаций, установленных в PHP-классе и его методах.
Методы
| LoaderResolverInterface | getResolver() Получает решатель загрузчиков. | из Loader |
| setResolver(LoaderResolverInterface $resolver) Устанавливает решатель загрузчиков. | из Loader | |
| mixed | import(mixed $resource, string|null $type = null, bool $ignoreErrors = false, string|null $sourceResource = null) Импортирует ресурс. | из FileLoader |
| LoaderInterface | resolve(mixed $resource, string|null $type = null) Находит загрузчик, способный загрузить импортированный ресурс. | из Loader |
| __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader) Конструктор. | ||
| setCurrentDir(string $dir) Устанавливает текущую директорию. | из FileLoader | |
| FileLocatorInterface | getLocator() Возвращает локатор файлов, используемый этим загрузчиком. | из FileLoader |
| load(string $file, string|null $type = null) Загружает аннотации из файла. | ||
| bool | supports(mixed $resource, string|null $type = null) Возвращает, поддерживает ли этот класс данный ресурс. |
Подробности
LoaderResolverInterface getResolver()
Получает решатель загрузчиков.
Возвращаемое значение
| LoaderResolverInterface | Экземпляр LoaderResolverInterface |
setResolver(LoaderResolverInterface $resolver)
Устанавливает решатель загрузчиков.
Параметры
| LoaderResolverInterface | $resolver | Экземпляр LoaderResolverInterface |
mixed import(mixed $resource, string|null $type = null, bool $ignoreErrors = false, string|null $sourceResource = null)
Импортирует ресурс.
Параметры
| mixed | $resource | Ресурс |
| string|null | $type | Тип ресурса или null, если неизвестен |
| bool | $ignoreErrors | Игнорировать ли ошибки импорта |
| string|null | $sourceResource | Исходный ресурс, импортирующий новый ресурс |
Возвращаемое значение
| mixed |
Исключения
| FileLoaderLoadException | |
| FileLoaderImportCircularReferenceException |
LoaderInterface resolve(mixed $resource, string|null $type = null)
Находит загрузчик, способный загрузить импортированный ресурс.
Параметры
| mixed | $resource | Ресурс |
| string|null | $type | Тип ресурса или null, если неизвестен |
Возвращаемое значение
| LoaderInterface | Экземпляр LoaderInterface |
Исключения
| FileLoaderLoadException | Если загрузчик не найден |
__construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
Конструктор.
Параметры
| FileLocatorInterface | $locator | Экземпляр FileLocatorInterface |
| AnnotationClassLoader | $loader | Экземпляр AnnotationClassLoader |
Исключения
| RuntimeException |
setCurrentDir(string $dir)
Устанавливает текущую директорию.
Параметры
| string | $dir |
FileLocatorInterface getLocator()
Возвращает локатор файлов, используемый этим загрузчиком.
Возвращаемое значение
| FileLocatorInterface |
load(string $file, string|null $type = null)
Загружает аннотации из файла.
Параметры
| string | $file | Путь к файлу PHP |
| string|null | $type | Тип ресурса или null, если неизвестен |
Исключения
| InvalidArgumentException | Если файл не существует или его маршруты не могут быть обработаны |
bool supports(mixed $resource, string|null $type = null)
Возвращает, поддерживает ли этот класс данный ресурс.
Параметры
| mixed | $resource | Ресурс |
| string|null | $type | Тип ресурса или null, если неизвестен |
Возвращаемое значение
| bool | True, если этот класс поддерживает данный ресурс, иначе false |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Routing/Loader/AnnotationFileLoader.html
