ЗагрузчикАннотацийФайлов
класс ЗагрузчикАннотацийФайлов расширяет ЗагрузчикФайлов
ЗагрузчикАннотацийФайлов загружает информацию маршрутизации из аннотаций, заданных в PHP-классе и его методах.
Методы
| ИнтерфейсРезольвераЗагрузчика | getResolver() Возвращает резольвер загрузчика. | из Загрузчик |
| setResolver(ИнтерфейсРезольвераЗагрузчика $resolver) Устанавливает резольвер загрузчика. | из Загрузчик | |
| mixed | import(mixed $resource, string|null $type = null, bool $ignoreErrors = false, string|null $sourceResource = null) Импортирует ресурс. | из ЗагрузчикФайлов |
| $this|ИнтерфейсЗагрузчика | resolve(mixed $resource, string|null $type = null) Ищет загрузчик, способный загрузить импортированный ресурс. | из Загрузчик |
| __construct(ИнтерфейсЛокатораФайлов $locator, ЗагрузчикКлассовАннотаций $loader) | ||
| setCurrentDir(string $dir) Устанавливает текущую директорию. | из ЗагрузчикФайлов | |
| ИнтерфейсЛокатораФайлов | getLocator() Возвращает локатор файлов, используемый этим загрузчиком. | из ЗагрузчикФайлов |
| 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, ЗагрузчикКлассовАннотаций $loader)
Параметры
| ИнтерфейсЛокатораФайлов | $locator | |
| ЗагрузчикКлассовАннотаций | $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/3.3/Symfony/Component/Routing/Loader/AnnotationFileLoader.html
