Skip to content

[Contracts][DependencyInjection] Add ServiceCollectionInterface #19370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 12, 2024
Merged

[Contracts][DependencyInjection] Add ServiceCollectionInterface #19370

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions service_container/service_subscribers_locators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,17 +110,36 @@ in the service subscriber::
that you have :ref:`autoconfigure <services-autoconfigure>` enabled. You
can also manually add the ``container.service_subscriber`` tag.

The injected service is an instance of :class:`Symfony\\Component\\DependencyInjection\\ServiceLocator`
which implements both the PSR-11 ``ContainerInterface`` and :class:`Symfony\\Contracts\\Service\\ServiceProviderInterface`.
It is also a callable and a countable::
A service locator is a PSR11 container that contains a set of services,
but only instantiates them when they are actually used. Let's take a closer
look at this part::

// ...
$handler = $this->locator->get($commandClass);

return $handler->handle($command);

In the example above, the ``$handler`` service is only instantiated when the
``$this->locator->get($commandClass)`` method is called.

You can also type-hint the service locator argument with
:class:`Symfony\\Contracts\\Service\\ServiceCollectionInterface` instead of
:class:`Psr\\Container\\ContainerInterface`. By doing so, you'll be able to
count and iterate over the services of the locator::

// ...
$numberOfHandlers = count($this->locator);
$nameOfHandlers = array_keys($this->locator->getProvidedServices());
// ...
$handler = ($this->locator)($commandClass);

return $handler->handle($command);
// you can iterate through all services of the locator
foreach ($this->locator as $serviceId => $service) {
// do something with the service, the service id or both
}

.. versionadded:: 7.1

The :class:`Symfony\\Contracts\\Service\\ServiceCollectionInterface` was
introduced in Symfony 7.1.

Including Services
------------------
Expand Down