Container.php — WooCommerce 6.9.0

woocommerce / src / Container.php

woocommerce / src Last commit date

Admin 3 years ago Caching 3 years ago Checkout 5 years ago Database 3 years ago Internal 3 years ago Proxies 3 years ago Utilities 3 years ago Autoloader.php 5 years ago Container.php 3 years ago Packages.php 4 years ago

Container.php

118 lines

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