1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

<?php
/**
 * Container class file.
 */

declare( strict_types=1 );

namespace Automattic\WooCommerce;

use Automattic\WooCommerce\Internal\DependencyManagement\ContainerException;
use Automattic\WooCommerce\Internal\DependencyManagement\ExtendedContainer;
use Automattic\WooCommerce\Internal\DependencyManagement\RuntimeContainer;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\AdminSettingsServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\CostOfGoodsSoldServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\COTMigrationServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\DownloadPermissionsAdjusterServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\AssignDefaultCategoryServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\EmailPreviewServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\EnginesServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\FeaturesServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\LoggingServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\MarketingServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\MarketplaceServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\OrdersControllersServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\OrderAdminServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\OrderMetaBoxServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ObjectCacheServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\OrdersDataStoreServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\OptionSanitizerServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\OrderAttributionServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ProductAttributesLookupServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ProductDownloadsServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ProductImageBySKUServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ProductReviewsServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ProxiesServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\RestockRefundedItemsAdjusterServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\AdminSuggestionsServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\UtilsClassesServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\BatchProcessingServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\LayoutTemplatesServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ComingSoonServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\StatsServiceProvider;
use Automattic\WooCommerce\Internal\DependencyManagement\ServiceProviders\ImportExportServiceProvider;

/**
 * PSR11 compliant dependency injection container for WooCommerce.
 *
 * Classes in the `src` directory should specify dependencies from that directory via an 'init' method having arguments
 * with type hints. If an instance of the container itself is needed, the type hint to use is \Psr\Container\ContainerInterface.
 *
 * Classes in the `src` directory should interact with anything outside (especially code in the `includes` directory
 * and WordPress functions) by using the classes in the `Proxies` directory. The exception is idempotent
 * functions (e.g. `wp_parse_url`), those can be used directly.
 *
 * Classes in the `includes` directory should use the `wc_get_container` function to get the instance of the container when
 * they need to get an instance of a class from the `src` directory.
 *
 * Class registration should be done via service providers that inherit from Automattic\WooCommerce\Internal\DependencyManagement
 * and those should go in the `src\Internal\DependencyManagement\ServiceProviders` folder unless there's a good reason
 * to put them elsewhere. All the service provider class names must be in the `SERVICE_PROVIDERS` constant.
 *
 * IMPORTANT NOTE: By default an instance of RuntimeContainer will be used as the underlying container,
 * but it's possible to use the old ExtendedContainer (backed by the PHP League's container package) instead,
 * see RuntimeContainer::should_use() for configuration instructions.
 * The League's container, the ExtendedContainer class and the related support code will be removed in WooCommerce 10.0.
 */
final class Container {
    /**
     * The underlying container.
     *
     * @var RuntimeContainer
     */
    private $container;

    /**
     * Class constructor.
     */
    public function __construct() {
        if ( RuntimeContainer::should_use() ) {
            // When the League container was in use we allowed to retrieve the container itself
            // by using 'Psr\Container\ContainerInterface' as the class identifier,
            // we continue allowing that for compatibility.
            $this->container = new RuntimeContainer(
                array(
                    __CLASS__                          => $this,
                    'Psr\Container\ContainerInterface' => $this,
                )
            );
            return;
        }

        $this->container = new ExtendedContainer();

        // Add ourselves as the shared instance of ContainerInterface,
        // register everything else using service providers.

        $this->container->share( __CLASS__, $this );

        foreach ( $this->get_service_providers() as $service_provider_class ) {
            $this->container->addServiceProvider( $service_provider_class );
        }
    }

    /**
     * Finds an entry of the container by its identifier and returns it.
     * See the comment about ContainerException in RuntimeContainer::get.
     *
     * @param string $id Identifier of the entry to look for.
     *
     * @return mixed Resolved entry.
     *
     * @throws NotFoundExceptionInterface No entry was found for the supplied identifier (only when using ExtendedContainer).
     * @throws Psr\Container\ContainerExceptionInterface Error while retrieving the entry.
     * @throws ContainerException Error when resolving the class to an object instance, or (when using RuntimeContainer) class not found.
     * @throws \Exception Exception thrown in the constructor or in the 'init' method of one of the resolved classes.
     */
    public function get( string $id ) {
        return $this->container->get( $id );
    }

    /**
     * Returns true if the container can return an entry for the given identifier.
     * Returns false otherwise.
     *
     * `has($id)` returning true does not mean that `get($id)` will not throw an exception.
     * It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`.
     *
     * @param string $id Identifier of the entry to look for.
     *
     * @return bool
     */
    public function has( string $id ): bool {
        return $this->container->has( $id );
    }

    /**
     * The list of service provider classes to register.
     *
     * @var string[]
     */
    private function get_service_providers(): array {
        return array(
            AssignDefaultCategoryServiceProvider::class,
            DownloadPermissionsAdjusterServiceProvider::class,
            EmailPreviewServiceProvider::class,
            OptionSanitizerServiceProvider::class,
            OrdersDataStoreServiceProvider::class,
            ProductAttributesLookupServiceProvider::class,
            ProductDownloadsServiceProvider::class,
            ProductImageBySKUServiceProvider::class,
            ProductReviewsServiceProvider::class,
            ProxiesServiceProvider::class,
            RestockRefundedItemsAdjusterServiceProvider::class,
            UtilsClassesServiceProvider::class,
            COTMigrationServiceProvider::class,
            OrdersControllersServiceProvider::class,
            OrderAttributionServiceProvider::class,
            ObjectCacheServiceProvider::class,
            BatchProcessingServiceProvider::class,
            OrderMetaBoxServiceProvider::class,
            OrderAdminServiceProvider::class,
            FeaturesServiceProvider::class,
            MarketingServiceProvider::class,
            MarketplaceServiceProvider::class,
            LayoutTemplatesServiceProvider::class,
            LoggingServiceProvider::class,
            EnginesServiceProvider::class,
            ComingSoonServiceProvider::class,
            StatsServiceProvider::class,
            ImportExportServiceProvider::class,
            CostOfGoodsSoldServiceProvider::class,
            AdminSettingsServiceProvider::class,
            AdminSuggestionsServiceProvider::class,
        );
    }
}