Контейнер
класс Container реализует ResettableContainerInterface
Контейнер — это контейнер инъекции зависимостей.
Он предоставляет доступ к экземплярам объектов (сервисов).
Сервисы и параметры — это простые хранилища ключ/значение.
Ключи параметров и сервисов нечувствительны к регистру.
Идентификатор сервиса может содержать строчные буквы, цифры, символы подчеркивания и точки. Подчеркивания используются для разделения слов, а точки — для группировки сервисов в пространствах имен:
- request
- mysql_session_storage
- symfony.mysql_session_storage
Сервис также можно определить, создав метод с именем getXXXService(), где XXX — это кемализированная версия идентификатора:
- request -> getRequestService()
- mysql_session_storage -> getMysqlSessionStorageService()
- symfony.mysql_session_storage -> getSymfony_MysqlSessionStorageService()
У контейнера могут быть три варианта поведения, когда сервис не существует:
- EXCEPTIONONINVALID_REFERENCE: Выбрасывает исключение (по умолчанию)
- NULLONINVALID_REFERENCE: Возвращает null
- IGNOREONINVALID_REFERENCE: Игнорирует команду обращения к ссылке (например, игнорирует setter, если сервис не существует)
Методы
| __construct(ParameterBagInterface $parameterBag = null) | ||
| compile() Компилирует контейнер. | ||
| bool | isFrozen() Возвращает 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 = self::EXCEPTION_ON_INVALID_REFERENCE) Получает сервис. | |
| bool | initialized(string $id) Возвращает true, если данный сервис был фактически инициализирован. | |
| reset() Сбрасывает общие сервисы из контейнера. | ||
| array | getServiceIds() Получает все идентификаторы сервисов. | |
| static string | camelize(string $id) Кемализирует строку. | |
| static string | underscore(string $id) Преобразует строку в нижний регистр с подчеркиваниями. |
Подробности
__construct(ParameterBagInterface $parameterBag = null)
Параметры
| ParameterBagInterface | $parameterBag | Экземпляр ParameterBagInterface |
compile()
Компилирует контейнер.
Этот метод выполняет два действия:
- Значения параметров разрешаются;
- Пакет параметров замораживается.
bool isFrozen()
Возвращает 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 = self::EXCEPTION_ON_INVALID_REFERENCE)
Получает сервис.
Если сервис определен как с помощью метода 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 | Массив всех определенных идентификаторов сервисов |
static string camelize(string $id)
Кемализирует строку.
Параметры
| string | $id | Строка для кемализации |
Значение возврата
| string | Кемализированная строка |
static string underscore(string $id)
Преобразует строку в нижний регистр с подчеркиваниями.
Параметры
| string | $id | Строка для преобразования |
Значение возврата
| string | Строка в нижнем регистре с подчеркиваниями |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/DependencyInjection/Container.html
