ServiceLocator — реестр сервисов

Пространство имен: Bitrix\Main\DI

Модуль: main — подключать отдельно не нужно

Доступно с версии: 20.5.0

Когда использовать

Класс ServiceLocator хранит сервисы приложения и создает их объекты по требованию. Сервисы регистрируют в секции services файла .settings.php сайта или модуля либо из кода. Класс реализует интерфейс Psr\Container\ContainerInterface.

Метод getInstance возвращает единственный на процесс объект класса. Конструктор закрытый.

Ядро регистрирует сервисы из .settings.php сайта и сервисы модуля main при запуске приложения. Сервисы другого модуля ядро регистрирует при первом успешном подключении модуля через Loader::includeModule.

Методы класса

Метод Описание С версии
getInstance Возвращает единственный объект класса
get Возвращает объект сервиса и при необходимости создает его
has Проверяет, зарегистрирован ли сервис
addInstance Регистрирует готовый объект сервиса
addInstanceLazy Регистрирует сервис и создает его объект при первом вызове get
registerByModuleSettings Регистрирует сервисы из .settings.php модуля
registerByGlobalSettings Регистрирует сервисы из .settings.php сайта

Исключения класса

Исключение Родитель Интерфейс PSR
Bitrix\Main\DI\Exception\ServiceNotFoundException Bitrix\Main\ObjectNotFoundException NotFoundExceptionInterface
Bitrix\Main\DI\Exception\CircularDependencyException Bitrix\Main\SystemException ContainerExceptionInterface
Bitrix\Main\DI\Exception\RegistrationException Bitrix\Main\SystemException ContainerExceptionInterface

Смотрите также

Следующая