Container
in package
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.
Table of Contents
- $container : RuntimeContainer
- The underlying container.
- __construct() : mixed
- Class constructor.
- get() : mixed
- Finds an entry of the container by its identifier and returns it.
- has() : bool
- Returns true if the container can return an entry for the given identifier.
- get_service_providers() : array<string|int, mixed>
- The list of service provider classes to register.
Properties
$container
The underlying container.
private
RuntimeContainer
$container
Methods
__construct()
Class constructor.
public
__construct() : mixed
Return values
mixed —get()
Finds an entry of the container by its identifier and returns it.
public
get(string $id) : mixed
See the comment about ContainerException in RuntimeContainer::get.
Parameters
- $id : string
-
Identifier of the entry to look for.
Tags
Return values
mixed — Resolved entry.has()
Returns true if the container can return an entry for the given identifier.
public
has(string $id) : bool
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.
Parameters
- $id : string
-
Identifier of the entry to look for.
Return values
bool —get_service_providers()
The list of service provider classes to register.
private
get_service_providers() : array<string|int, mixed>