Класс yii\di\ServiceLocator

$locator = new \yii\di\ServiceLocator;
$locator->setComponents([
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => 'sqlite:path/to/file.db',
    ],
    'cache' => [
        'class' => 'yii\caching\DbCache',
        'db' => 'db',
    ],
]);

$db = $locator->get('db');  // or $locator->db
$cache = $locator->get('cache');  // or $locator->cache

public array getComponents ( $returnDefinitions = true )
public void setComponents ( $components )

__get() общедоступный метод

Магический метод-геттер.

Этот метод переопределён для поддержки доступа к компонентам, например, чтения свойств.

общедоступный смешанный __get ( $name )
$name	строка	Имя компонента или свойства
return	смешанный	Значение указанного свойства

__isset() общедоступный метод

Проверяет, является ли значение свойства нулевым.

Этот метод переопределяет реализацию родительского класса, проверяя, загружен ли указанный компонент.

общедоступный булево __isset ( $name )
$name	строка	Имя свойства или имя события
return	булево	Является ли значение свойства нулевым

clear() общедоступный метод

Удаляет компонент из локетора.

общедоступный void clear ( $id )
$id	строка	Идентификатор компонента

get() общедоступный метод

Возвращает экземпляр компонента с заданным идентификатором.

См. также:

• has()
• set()

общедоступный объект|null get ( $id, $throwException = true )
$id	строка	Идентификатор компонента (например, db).
$throwException	булево	Вызывать ли исключение, если $id не зарегистрирован в локеторе ранее.
return	объект|null	Компонент с указанным идентификатором. Если $throwException равно false и $id не был зарегистрирован ранее, возвращается null.
throws	yii\base\InvalidConfigException	если $id ссылается на несуществующий идентификатор компонента

getComponents() общедоступный метод

Возвращает список определений компонентов или загруженных экземпляров компонентов.

общедоступный массив getComponents ( $returnDefinitions = true )
$returnDefinitions	булево	Возвращать определения компонентов вместо загруженных экземпляров компонентов.
return	массив	Список определений компонентов или загруженных экземпляров компонентов (ID => определение или экземпляр).

has() общедоступный метод

Возвращает значение, указывающее, содержит ли локетор указанное определение компонента или был ли компонент инициализирован.

Этот метод может возвращать разные результаты в зависимости от значения $checkInstance.

• Если $checkInstance равно false (по умолчанию), метод вернёт значение, указывающее, содержит ли локетор указанное определение компонента.
• Если $checkInstance равно true, метод вернёт значение, указывающее, инициализирован ли локетором указанный компонент.

См. также set().

общедоступный булево has ( $id, $checkInstance = false )
$id	строка	Идентификатор компонента (например, db).
$checkInstance	булево	Проверять ли, является ли компонент общим и инициализированным.
return	булево	Содержит ли локетор указанное определение компонента или инициализирован ли компонент.

set() общедоступный метод

Регистрирует определение компонента в этом локеторе.

Например,

// a class name
$locator->set('cache', 'yii\caching\FileCache');

// a configuration array
$locator->set('db', [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
]);

// an anonymous function
$locator->set('cache', function ($params) {
    return new \yii\caching\FileCache;
});

// an instance
$locator->set('cache', new \yii\caching\FileCache);

Если определение компонента с тем же ID уже существует, оно будет перезаписано.

общедоступный void set ( $id, $definition )
$id	строка	Идентификатор компонента (например, db).
$definition	смешанный	Определение компонента для регистрации в этом локеторе. Может быть одним из следующих: имя класса массив конфигурации: массив содержит пары имя-значение, которые будут использоваться для инициализации значений свойств вновь созданного объекта при вызове get(). Элемент class обязателен и указывает на класс создаваемого объекта. вызов PHP: либо анонимная функция, либо массив, представляющий метод класса (например, ['Foo', 'bar']). Вызов будет вызван методом get() для возврата объекта, связанного с указанным идентификатором компонента. объект: при вызове get() будет возвращён этот объект.
throws	yii\base\InvalidConfigException	если определение является недопустимым массивом конфигурации

setComponents() общедоступный метод

Регистрирует набор определений компонентов в этом локеторе.

Это объёмная версия set(). Параметр должен быть массивом, ключами которого являются идентификаторы компонентов, а значениями — соответствующие определения компонентов.

Подробнее о том, как указать идентификаторы и определения компонентов, см. set().

Если определение компонента с тем же ID уже существует, оно будет перезаписано.

Ниже приведён пример регистрации двух определений компонентов:

[
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => 'sqlite:path/to/file.db',
    ],
    'cache' => [
        'class' => 'yii\caching\DbCache',
        'db' => 'db',
    ],
]

общедоступный void setComponents ( $components )
$components	массив	Определения или экземпляры компонентов