Получить сервис ServiceLocator::get

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

Метод ServiceLocator::get возвращает объект сервиса. Если объекта еще нет, метод создает его по описанию сервиса. Для класса, который не зарегистрирован, метод создает объект сам и подставляет зависимости конструктора.

Сигнатура метода в классе Bitrix\Main\DI\ServiceLocator:

public function get(string $id): mixed

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
id* string Задает код сервиса, имя интерфейса или класса

Возвращаемое значение

Метод возвращает объект сервиса. Как метод получает объект, зависит от id.

Случай Что делает метод
Объект уже создан или добавлен через addInstance Возвращает его
Зарегистрированный интерфейс или абстрактный класс Создает объект класса className и подставляет зависимости по типам, constructorParams при этом не использует. Если задан constructor, вызывает функцию с аргументами из массива constructorParams
Другой зарегистрированный код Вызывает функцию constructor без аргументов или создает объект className с аргументами из constructorParams. Если constructorParams — функция, метод вызывает ее и берет аргументы из результата
Незарегистрированное имя класса Создает объект класса и подставляет в конструктор объекты по типам параметров

При подстановке зависимостей у каждого параметра конструктора должен быть один именованный тип. Параметр со значением по умолчанию получает это значение, тип у него может быть и скалярным. Для параметра без значения по умолчанию тип должен быть существующим классом или интерфейсом, метод получает объект через get по имени типа.

Метод запоминает созданный объект и при следующих вызовах возвращает его же. Исключение — сервис, зарегистрированный с singleton => false. Для такого сервиса метод каждый раз создает новый объект.

Исключения

Исключение Когда возникает
Bitrix\Main\DI\Exception\ServiceNotFoundException Код не зарегистрирован, и класса с таким именем нет, в том числе если это незарегистрированный интерфейс. Конструктор класса не публичный. У параметра конструктора нет именованного типа. У параметра без значения по умолчанию тип не указывает на существующий класс или интерфейс
Bitrix\Main\DI\Exception\CircularDependencyException Классы зависят друг от друга по кругу
\Error У зарегистрированного кода в className указан класс, которого нет

Примеры

Пример. Код получает объект класса без регистрации. Метод сам создает объект и подставляет зависимость конструктора:

<?php
use Bitrix\Main\DI\ServiceLocator;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

class DemoUnitRepository
{
}

class DemoUnitService
{
    public function __construct(public DemoUnitRepository $repository)
    {
    }
}

$service = ServiceLocator::getInstance()->get(DemoUnitService::class);

echo get_class($service->repository);

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