XmlFileLoader

Интерфейс разрешения загрузчика 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)

Параметры

Интерфейс локатора файлов

$locator

setCurrentDir(string $dir)

Устанавливает текущую директорию.

Параметры

string

$dir

Интерфейс локатора файлов getLocator()

Возвращает локатор файлов, используемый этим загрузчиком.

Значение возврата

Интерфейс локатора файлов

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)

Загружает XML-файл.

Параметры

string	$file	Путь к XML-файлу
string|null	$type	Тип ресурса или null, если неизвестен

Исключения

Исключение неверного аргумента

при невозможности загрузки файла или при невозможности парсинга XML из-за несоответствия схеме

protected parseNode(Коллекция маршрутов $collection, DOMElement $node, string $path, string $file)

Парсит узел из загруженного XML-файла.

Параметры

Коллекция маршрутов	$collection	Коллекция для связывания с узлом
DOMElement	$node	Узел для парсинга
string	$path	Полный путь к обрабатываемому XML-файлу
string	$file	Загруженное имя файла

Исключения

Исключение неверного аргумента

При некорректном XML

bool supports(mixed $resource, string|null $type = null)

Возвращает, поддерживает ли данный класс указанный ресурс.

Параметры

mixed	$resource	Ресурс
string|null	$type	Тип ресурса или null, если неизвестен

Значение возврата

bool	True, если класс поддерживает данный ресурс, иначе false

protected parseRoute(Коллекция маршрутов $collection, DOMElement $node, string $path)

Парсит маршрут и добавляет его в RouteCollection.

Параметры

Коллекция маршрутов	$collection	Экземпляр RouteCollection
DOMElement	$node	Узел для парсинга, представляющий маршрут
string	$path	Полный путь к обрабатываемому XML-файлу

Исключения

Исключение неверного аргумента

При некорректном XML

protected parseImport(Коллекция маршрутов $collection, DOMElement $node, string $path, string $file)

Парсит импорт и добавляет маршруты из ресурса в RouteCollection.

Параметры

Коллекция маршрутов	$collection	Экземпляр RouteCollection
DOMElement	$node	Узел для парсинга, представляющий маршрут
string	$path	Полный путь к обрабатываемому XML-файлу
string	$file	Загруженное имя файла

Исключения

Исключение неверного аргумента

При некорректном XML

protected DOMDocument loadFile(string $file)

Загружает XML-файл.

Параметры

string

$file

Путь к XML-файлу

Значение возврата

DOMDocument

Исключения

Исключение неверного аргумента

При ошибке загрузки XML-файла из-за синтаксических ошибок или если структура XML не соответствует схеме - см. validate()