4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\DependencyInjection;
15 * A ServiceSubscriber exposes its dependencies via the static {@link getSubscribedServices} method.
17 * The getSubscribedServices method returns an array of service types required by such instances,
18 * optionally keyed by the service names used internally. Service types that start with an interrogation
19 * mark "?" are optional, while the other ones are mandatory service dependencies.
21 * The injected service locators SHOULD NOT allow access to any other services not specified by the method.
23 * It is expected that ServiceSubscriber instances consume PSR-11-based service locators internally.
24 * This interface does not dictate any injection method for these service locators, although constructor
25 * injection is recommended.
27 * @author Nicolas Grekas <p@tchwork.com>
29 interface ServiceSubscriberInterface
32 * Returns an array of service types required by such instances, optionally keyed by the service names used internally.
34 * For mandatory dependencies:
36 * * array('logger' => 'Psr\Log\LoggerInterface') means the objects use the "logger" name
37 * internally to fetch a service which must implement Psr\Log\LoggerInterface.
38 * * array('Psr\Log\LoggerInterface') is a shortcut for
39 * * array('Psr\Log\LoggerInterface' => 'Psr\Log\LoggerInterface')
43 * * array('logger' => '?Psr\Log\LoggerInterface') denotes an optional dependency
44 * * array('?Psr\Log\LoggerInterface') is a shortcut for
45 * * array('Psr\Log\LoggerInterface' => '?Psr\Log\LoggerInterface')
47 * @return array The required service types, optionally keyed by service names
49 public static function getSubscribedServices();