Admin
6 years ago
Blocks
6 years ago
Checkout
5 years ago
Internal
5 years ago
Proxies
5 years ago
Utilities
5 years ago
Autoloader.php
5 years ago
Container.php
5 years ago
Packages.php
5 years ago
Container.php
90 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Container class file. |
| 4 | */ |
| 5 | |
| 6 | namespace Automattic\WooCommerce; |
| 7 | |
| 8 | use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ProxiesServiceProvider; |
| 9 | use Automattic\WooCommerce\Internal\DependencyManagement\ExtendedContainer; |
| 10 | |
| 11 | /** |
| 12 | * PSR11 compliant dependency injection container for WooCommerce. |
| 13 | * |
| 14 | * Classes in the `src` directory should specify dependencies from that directory via constructor arguments |
| 15 | * with type hints. If an instance of the container itself is needed, the type hint to use is \Psr\Container\ContainerInterface. |
| 16 | * |
| 17 | * Classes in the `src` directory should interact with anything outside (especially code in the `includes` directory |
| 18 | * and WordPress functions) by using the classes in the `Proxies` directory. The exception is idempotent |
| 19 | * functions (e.g. `wp_parse_url`), those can be used directly. |
| 20 | * |
| 21 | * Classes in the `includes` directory should use the `wc_get_container` function to get the instance of the container when |
| 22 | * they need to get an instance of a class from the `src` directory. |
| 23 | * |
| 24 | * Class registration should be done via service providers that inherit from Automattic\WooCommerce\Internal\DependencyManagement |
| 25 | * and those should go in the `src\Internal\DependencyManagement\ServiceProviders` folder unless there's a good reason |
| 26 | * to put them elsewhere. All the service provider class names must be in the `SERVICE_PROVIDERS` constant. |
| 27 | */ |
| 28 | final class Container implements \Psr\Container\ContainerInterface { |
| 29 | /** |
| 30 | * The list of service provider classes to register. |
| 31 | * |
| 32 | * @var string[] |
| 33 | */ |
| 34 | private $service_providers = array( |
| 35 | ProxiesServiceProvider::class, |
| 36 | ); |
| 37 | |
| 38 | /** |
| 39 | * The underlying container. |
| 40 | * |
| 41 | * @var \League\Container\Container |
| 42 | */ |
| 43 | private $container; |
| 44 | |
| 45 | /** |
| 46 | * Class constructor. |
| 47 | */ |
| 48 | public function __construct() { |
| 49 | $this->container = new ExtendedContainer(); |
| 50 | |
| 51 | // Add ourselves as the shared instance of ContainerInterface, |
| 52 | // register everything else using service providers. |
| 53 | |
| 54 | $this->container->share( \Psr\Container\ContainerInterface::class, $this ); |
| 55 | |
| 56 | foreach ( $this->service_providers as $service_provider_class ) { |
| 57 | $this->container->addServiceProvider( $service_provider_class ); |
| 58 | } |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Finds an entry of the container by its identifier and returns it. |
| 63 | * |
| 64 | * @param string $id Identifier of the entry to look for. |
| 65 | * |
| 66 | * @throws NotFoundExceptionInterface No entry was found for **this** identifier. |
| 67 | * @throws Psr\Container\ContainerExceptionInterface Error while retrieving the entry. |
| 68 | * |
| 69 | * @return mixed Entry. |
| 70 | */ |
| 71 | public function get( $id ) { |
| 72 | return $this->container->get( $id ); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Returns true if the container can return an entry for the given identifier. |
| 77 | * Returns false otherwise. |
| 78 | * |
| 79 | * `has($id)` returning true does not mean that `get($id)` will not throw an exception. |
| 80 | * It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`. |
| 81 | * |
| 82 | * @param string $id Identifier of the entry to look for. |
| 83 | * |
| 84 | * @return bool |
| 85 | */ |
| 86 | public function has( $id ) { |
| 87 | return $this->container->has( $id ); |
| 88 | } |
| 89 | } |
| 90 |