YamlFileLoader
class YamlFileLoader extends FileLoader
YamlFileLoader загружает определения сервисов из YAML-файлов.
Свойства
| protected | $resolver | из Loader | |
| static protected | $loading | из FileLoader | |
| protected | $locator | из FileLoader | |
| protected | $container | из FileLoader | |
| protected | $isLoadingInstanceof | из FileLoader | |
| protected | $instanceof | из FileLoader |
Методы
| 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(ContainerBuilder $container, FileLocatorInterface $locator) | из FileLoader | |
| setCurrentDir(string $dir) Устанавливает текущую директорию. | из FileLoader | |
| FileLocatorInterface | getLocator() Возвращает локатор файлов, используемый этим загрузчиком. | из FileLoader |
| glob(string $pattern, bool $recursive, $resource = null, bool $ignoreErrors = false) | из FileLoader | |
| registerClasses(Definition $prototype, string $namespace, string $resource, string $exclude = null) Регистрирует набор классов как сервисы, используя PSR-4 для обнаружения. | из FileLoader | |
| setDefinition(string $id, Definition $definition) Регистрирует определение в контейнере с его условиями instanceof. | из FileLoader | |
| load(mixed $resource, string|null $type = null) Загружает ресурс. | ||
| bool | supports(mixed $resource, string|null $type = null) Возвращает, поддерживает ли этот класс данный ресурс. | |
| array | loadFile(string $file) Загружает YAML-файл. |
Детали
Интерфейс разрешения загрузчиков 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 |
Исключения
| FileLoaderLoadException | |
| FileLoaderImportCircularReferenceException | |
| FileLocatorFileNotFoundException |
$this|Интерфейс загрузчика resolve(mixed $resource, string|null $type = null)
Находит загрузчик, способный загрузить импортированный ресурс.
Параметры
| mixed | $resource | Ресурс |
| string|null | $type | Тип ресурса или null, если неизвестен |
Значение возврата
| $this|Интерфейс загрузчика |
Исключения
| FileLoaderLoadException | Если загрузчик не найден |
__construct(ContainerBuilder $container, FileLocatorInterface $locator)
Параметры
| ContainerBuilder | $container | |
| FileLocatorInterface | $locator |
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 |
registerClasses(Definition $prototype, string $namespace, string $resource, string $exclude = null)
Регистрирует набор классов в качестве сервисов, используя PSR-4 для обнаружения.
Параметры
| Definition | $prototype | Определение, используемое в качестве шаблона |
| string | $namespace | Префикс имени пространства имён классов в сканируемом каталоге |
| string | $resource | Каталог для поиска классов, разрешены шаблоны glob |
| string | $exclude | Путь файлов для исключения, с использованием шаблонов glob |
protected setDefinition(string $id, Definition $definition)
Регистрирует определение в контейнере с его instanceof-условиями.
Параметры
| string | $id | |
| Definition | $definition |
load(mixed $resource, string|null $type = null)
Загружает ресурс.
Параметры
| mixed | $resource | Ресурс |
| string|null | $type | Тип ресурса или null, если неизвестен |
Исключения
| Исключение | Если возникла ошибка |
bool supports(mixed $resource, string|null $type = null)
Возвращает, поддерживает ли данный класс данный ресурс.
Параметры
| mixed | $resource | Ресурс |
| string|null | $type | Тип ресурса или null, если неизвестен |
Значение возврата
| bool | True, если данный класс поддерживает данный ресурс, иначе false |
protected array loadFile(string $file)
Загружает YAML-файл.
Параметры
| string | $file |
Значение возврата
| array | Содержимое файла |
Исключения
| InvalidArgumentException | если заданный файл не является локальным файлом или не существует |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.html
