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