Spec-Zone.ru › Symfony 3.4

Контейнер

класс Container реализует ResettableContainerInterface

Контейнер — это контейнер для инъекции зависимостей.

Он предоставляет доступ к экземплярам объектов (сервисы). Сервисы и параметры — это простые хранилища ключ/значение. Контейнер может иметь четыре возможных поведения, когда сервис не существует (или не инициализирован в последнем случае):

  • EXCEPTIONONINVALID_REFERENCE: Выбрасывает исключение (по умолчанию)
  • NULLONINVALID_REFERENCE: Возвращает null
  • IGNOREONINVALID_REFERENCE: Игнорирует команду, запрашивающую ссылку (например, игнорирует установщик, если сервис не существует)
  • IGNOREONUNINITIALIZED_REFERENCE: Игнорирует/возвращает null для неинициализированных сервисов или недопустимых ссылок

Методы

__construct(ParameterBagInterface $parameterBag = null)
compile()

Компилирует контейнер.

bool isCompiled()

Возвращает true, если контейнер скомпилирован.

bool isFrozen() deprecated

Возвращает true, если пакет параметров контейнера заморожен.

ParameterBagInterface getParameterBag()

Получает пакет параметров контейнера сервисов.

mixed getParameter(string $name)

Получает параметр.

bool hasParameter(string $name)

Проверяет, существует ли параметр.

setParameter(string $name, mixed $value)

Устанавливает параметр.

set(string $id, object $service)

Устанавливает сервис.

bool has(string $id)

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

object get(string $id, int $invalidBehavior = 1)

Получает сервис.

bool initialized(string $id)

Возвращает true, если заданный сервис был фактически инициализирован.

reset()

Сбрасывает общие сервисы из контейнера.

array getServiceIds()

Получает все идентификаторы сервисов.

array getRemovedIds()

Получает идентификаторы сервисов, которые существовали во время компиляции.

static string camelize(string $id)

Преобразует строку в camelCase.

static string underscore(string $id)

Преобразует строку в нижний регистр с подчеркиванием.

string normalizeId(string $id)

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

Подробности

__construct(ParameterBagInterface $parameterBag = null)

Параметры

ParameterBagInterface $parameterBag

compile()

Компилирует контейнер.

Этот метод выполняет два действия:

  • Значения параметров разрешаются;
  • Временной пакет параметров замораживается.

bool isCompiled()

Возвращает true, если контейнер скомпилирован.

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

bool

bool isFrozen() устаревший

устаревший

since версия 3.3, будет удален в 4.0.

Возвращает true, если пакет параметров контейнера заморожен.

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

bool true, если пакет параметров контейнера заморожен, иначе false

ParameterBagInterface getParameterBag()

Получает пакет параметров контейнера сервисов.

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

ParameterBagInterface Экземпляр ParameterBagInterface

mixed getParameter(string $name)

Получает параметр.

Параметры

string $name Имя параметра

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

mixed Значение параметра

Исключения

InvalidArgumentException если параметр не определен

bool hasParameter(string $name)

Проверяет, существует ли параметр.

Параметры

string $name Имя параметра

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

bool Присутствует ли параметр в контейнере

setParameter(string $name, mixed $value)

Устанавливает параметр.

Параметры

string $name Имя параметра
mixed $value Значение параметра

set(string $id, object $service)

Устанавливает сервис.

Установка сервиса в null сбрасывает сервис: has() возвращает false, и get() ведет себя так же, как если бы сервис никогда не создавался.

Параметры

string $id Идентификатор сервиса
object $service Экземпляр сервиса

bool has(string $id)

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

Параметры

string $id Идентификатор сервиса

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

bool true, если сервис определен, иначе false

object get(string $id, int $invalidBehavior = 1)

Получает сервис.

Если сервис определен как через метод set(), так и с помощью метода get{$id}Service(), приоритет всегда отдается первому.

Параметры

string $id Идентификатор сервиса
int $invalidBehavior Поведение при отсутствии сервиса

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

object Связанный сервис

Исключения

ServiceCircularReferenceException При обнаружении циклической ссылки
ServiceNotFoundException Если сервис не определен
Исключение если при разрешении сервиса было выброшено исключение

См. также

Ссылка

bool initialized(string $id)

Возвращает true, если данный сервис был фактически инициализирован.

Параметры

string $id

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

bool true, если сервис был инициализирован, иначе false

reset()

Сбрасывает общие сервисы из контейнера.

Контейнер не предназначен для повторного использования после сброса в обычном рабочем процессе. Этот метод предназначен для освобождения ссылок для подсчёта ссылок. Последующий вызов ContainerInterface::get создаст новый экземпляр общего сервиса.

array getServiceIds()

Получает все идентификаторы сервисов.

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

array Массив всех определенных идентификаторов сервисов

array getRemovedIds()

Получает идентификаторы сервисов, которые существовали во время компиляции.

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

array

static string camelize(string $id)

Приводит строку к верблюжьему регистру.

Параметры

string $id Строка для преобразования

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

string Преобразованная строка

static string underscore(string $id)

Преобразует строку в нижний регистр с разделителями подчеркивания.

Параметры

string $id Строка для преобразования

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

string Преобразованная строка

string normalizeId(string $id)

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

Параметры

string $id

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

string

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/DependencyInjection/Container.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API