Файл: vendor/symfony/service-contracts/ServiceSubscriberInterface.php
Строк: 118
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace SymfonyContractsService;
use SymfonyContractsServiceAttributeSubscribedService;
/**
* A ServiceSubscriber exposes its dependencies via the static {@link getSubscribedServices} method.
*
* The getSubscribedServices method returns an array of service types required by such instances,
* optionally keyed by the service names used internally. Service types that start with an interrogation
* mark "?" are optional, while the other ones are mandatory service dependencies.
*
* The injected service locators SHOULD NOT allow access to any other services not specified by the method.
*
* It is expected that ServiceSubscriber instances consume PSR-11-based service locators internally.
* This interface does not dictate any injection method for these service locators, although constructor
* injection is recommended.
*
* @author Nicolas Grekas <p@tchwork.com>
*/
interface ServiceSubscriberInterface
{
/**
* Returns an array of service types (or {@see SubscribedService} objects) required
* by such instances, optionally keyed by the service names used internally.
*
* For mandatory dependencies:
*
* * ['logger' => 'PsrLogLoggerInterface'] means the objects use the "logger" name
* internally to fetch a service which must implement PsrLogLoggerInterface.
* * ['loggers' => 'PsrLogLoggerInterface[]'] means the objects use the "loggers" name
* internally to fetch an iterable of PsrLogLoggerInterface instances.
* * ['PsrLogLoggerInterface'] is a shortcut for
* * ['PsrLogLoggerInterface' => 'PsrLogLoggerInterface']
*
* otherwise:
*
* * ['logger' => '?PsrLogLoggerInterface'] denotes an optional dependency
* * ['loggers' => '?PsrLogLoggerInterface[]'] denotes an optional iterable dependency
* * ['?PsrLogLoggerInterface'] is a shortcut for
* * ['PsrLogLoggerInterface' => '?PsrLogLoggerInterface']
*
* additionally, an array of {@see SubscribedService}'s can be returned:
*
* * [new SubscribedService('logger', PsrLogLoggerInterface::class)]
* * [new SubscribedService(type: PsrLogLoggerInterface::class, nullable: true)]
* * [new SubscribedService('http_client', HttpClientInterface::class, attributes: new Target('githubApi'))]
*
* @return string[]|SubscribedService[] The required service types, optionally keyed by service names
*/
public static function getSubscribedServices(): array;
}