AnnotationFileLoader
class AnnotationFileLoader extends FileLoader
AnnotationFileLoader загружает информацию о маршрутизации из аннотаций, установленных в PHP-классе и его методах.
Методы
| LoaderResolverInterface | getResolver() Получает решатель загрузчика. | from Loader |
| setResolver(LoaderResolverInterface $resolver) Устанавливает решатель загрузчика. | from Loader | |
| mixed | import(mixed $resource, string|null $type = null, bool $ignoreErrors = false, string|null $sourceResource = null) Импортирует ресурс. | from FileLoader |
| $this|LoaderInterface | resolve(mixed $resource, string|null $type = null) Находит загрузчик, способный загрузить импортированный ресурс. | from Loader |
| __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader) | ||
| setCurrentDir(string $dir) Устанавливает текущую директорию. | from FileLoader | |
| FileLocatorInterface | getLocator() Возвращает локатор файлов, используемый этим загрузчиком. | from FileLoader |
| load(string $file, string|null $type = null) Загружает аннотации из файла. | ||
| bool | supports(mixed $resource, string|null $type = null) Возвращает, поддерживает ли этот класс данный ресурс. |
Подробности
Интерфейс разрешителя загрузчиков getResolver()
Возвращает разрешитель загрузчиков.
Результат
| Интерфейс разрешителя загрузчиков | Экземпляр LoaderResolverInterface |
setResolver(Интерфейс разрешителя загрузчиков $resolver)
Устанавливает разрешитель загрузчиков.
Параметры
| Интерфейс разрешителя загрузчиков | $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 |
Исключения
| Исключение загрузки загрузчика файла | |
| Исключение циклической ссылки импорта загрузчика файла | |
| Исключение отсутствия файла локатора файла |
$this|Интерфейс загрузчика resolve(mixed $resource, string|null $type = null)
Находит загрузчик, способный загрузить импортированный ресурс.
Параметры
| mixed | $resource | Ресурс |
| string|null | $type | Тип ресурса или null, если неизвестен |
Результат
| $this|Интерфейс загрузчика |
Исключения
| Исключение загрузки загрузчика файла | Если загрузчик не найден |
__construct(Интерфейс локатора файлов $locator, AnnotationClassLoader $loader)
Параметры
| Интерфейс локатора файлов | $locator | |
| AnnotationClassLoader | $loader |
Исключения
| RuntimeException |
setCurrentDir(string $dir)
Устанавливает текущую директорию.
Параметры
| string | $dir |
Интерфейс локатора файлов getLocator()
Возвращает локатор файлов, используемый этим загрузчиком.
Результат
| Интерфейс локатора файлов |
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/4.0/Symfony/Component/Routing/Loader/AnnotationFileLoader.html
