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