MediaWiki REL1_30
|
ServiceContainer provides a generic service to manage named services using lazy instantiation based on instantiator callback functions. More...
Public Member Functions | |
__construct (array $extraInstantiationParams=[]) | |
applyWiring (array $serviceInstantiators) | |
Registers multiple services (aka a "wiring"). | |
defineService ( $name, callable $instantiator) | |
Define a new service. | |
destroy () | |
Destroys all contained service instances that implement the DestructibleService interface. | |
disableService ( $name) | |
Disables a service. | |
getService ( $name) | |
Returns a service object of the kind associated with $name. | |
getServiceNames () | |
hasService ( $name) | |
Returns true if a service is defined for $name, that is, if a call to getService( $name ) would return a service instance. | |
importWiring (ServiceContainer $container, $skip=[]) | |
Imports all wiring defined in $container. | |
isServiceDisabled ( $name) | |
loadWiringFiles (array $wiringFiles) | |
peekService ( $name) | |
Returns the service instance for $name only if that service has already been instantiated. | |
redefineService ( $name, callable $instantiator) | |
Replace an already defined service. | |
Protected Member Functions | |
resetService ( $name, $destroy=true) | |
Resets a service by dropping the service instance. | |
Private Member Functions | |
createService ( $name) | |
Private Attributes | |
bool | $destroyed = false |
bool[] | $disabled = [] |
disabled status, per service name | |
array | $extraInstantiationParams |
callable[] | $serviceInstantiators = [] |
object[] | $services = [] |
ServiceContainer provides a generic service to manage named services using lazy instantiation based on instantiator callback functions.
Services managed by an instance of ServiceContainer may or may not implement a common interface.
Definition at line 46 of file ServiceContainer.php.
MediaWiki\Services\ServiceContainer::__construct | ( | array | $extraInstantiationParams = [] | ) |
array | $extraInstantiationParams | Any additional parameters to be passed to the instantiator function when creating a service. This is typically used to provide access to additional ServiceContainers or Config objects. |
Definition at line 78 of file ServiceContainer.php.
References MediaWiki\Services\ServiceContainer\$extraInstantiationParams.
MediaWiki\Services\ServiceContainer::applyWiring | ( | array | $serviceInstantiators | ) |
Registers multiple services (aka a "wiring").
array | $serviceInstantiators | An associative array mapping service names to instantiator functions. |
Definition at line 126 of file ServiceContainer.php.
References MediaWiki\Services\ServiceContainer\$serviceInstantiators, and MediaWiki\Services\ServiceContainer\defineService().
Referenced by MediaWiki\Services\ServiceContainer\loadWiringFiles().
|
private |
string | $name |
InvalidArgumentException | if $name is not a known service. |
Definition at line 356 of file ServiceContainer.php.
Referenced by MediaWiki\Services\ServiceContainer\getService().
MediaWiki\Services\ServiceContainer::defineService | ( | $name, | |
callable | $instantiator ) |
Define a new service.
The service must not be known already.
string | $name | The name of the service to register, for use with getService(). |
callable | $instantiator | Callback that returns a service instance. Will be called with this MediaWikiServices instance as the only parameter. Any extra instantiation parameters provided to the constructor will be passed as subsequent parameters when invoking the instantiator. |
RuntimeException | if there is already a service registered as $name. |
Definition at line 212 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\hasService().
Referenced by MediaWiki\Services\ServiceContainer\applyWiring().
MediaWiki\Services\ServiceContainer::destroy | ( | ) |
Destroys all contained service instances that implement the DestructibleService interface.
This will render all services obtained from this MediaWikiServices instance unusable. In particular, this will disable access to the storage backend via any of these services. Any future call to getService() will throw an exception.
Implements MediaWiki\Services\DestructibleService.
Definition at line 90 of file ServiceContainer.php.
References MediaWiki\Services\ServiceContainer\getServiceNames(), and MediaWiki\Services\ServiceContainer\peekService().
MediaWiki\Services\ServiceContainer::disableService | ( | $name | ) |
Disables a service.
string | $name | The name of the service to disable. |
RuntimeException | if $name is not a known service. |
Definition at line 272 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\resetService().
MediaWiki\Services\ServiceContainer::getService | ( | $name | ) |
Returns a service object of the kind associated with $name.
Services instances are instantiated lazily, on demand. This method may or may not return the same service instance when called multiple times with the same $name.
string | $name | The service name |
NoSuchServiceException | if $name is not a known service. |
ContainerDisabledException | if this container has already been destroyed. |
ServiceDisabledException | if the requested service has been disabled. |
Definition at line 334 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\createService().
MediaWiki\Services\ServiceContainer::getServiceNames | ( | ) |
Definition at line 194 of file ServiceContainer.php.
Referenced by MediaWiki\Services\ServiceContainer\destroy().
MediaWiki\Services\ServiceContainer::hasService | ( | $name | ) |
Returns true if a service is defined for $name, that is, if a call to getService( $name ) would return a service instance.
string | $name |
Definition at line 164 of file ServiceContainer.php.
Referenced by MediaWiki\Services\ServiceContainer\defineService(), MediaWiki\Services\ServiceContainer\peekService(), and MediaWiki\Services\ServiceContainer\redefineService().
MediaWiki\Services\ServiceContainer::importWiring | ( | ServiceContainer | $container, |
$skip = [] ) |
Imports all wiring defined in $container.
Wiring defined in $container will override any wiring already defined locally. However, already existing service instances will be preserved.
ServiceContainer | $container | |
string[] | $skip | A list of service names to skip during import |
Definition at line 144 of file ServiceContainer.php.
MediaWiki\Services\ServiceContainer::isServiceDisabled | ( | $name | ) |
string | $name |
Definition at line 375 of file ServiceContainer.php.
MediaWiki\Services\ServiceContainer::loadWiringFiles | ( | array | $wiringFiles | ) |
array | $wiringFiles | A list of PHP files to load wiring information from. Each file is loaded using PHP's include mechanism. Each file is expected to return an associative array that maps service names to instantiator functions. |
Definition at line 106 of file ServiceContainer.php.
References MediaWiki\Services\ServiceContainer\applyWiring().
MediaWiki\Services\ServiceContainer::peekService | ( | $name | ) |
Returns the service instance for $name only if that service has already been instantiated.
This is intended for situations where services get destroyed/cleaned up, so we can avoid creating a service just to destroy it again.
string | $name |
RuntimeException | if $name does not refer to a known service. |
Definition at line 183 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\hasService().
Referenced by MediaWiki\Services\ServiceContainer\destroy(), and MediaWiki\Services\ServiceContainer\resetService().
MediaWiki\Services\ServiceContainer::redefineService | ( | $name, | |
callable | $instantiator ) |
Replace an already defined service.
string | $name | The name of the service to register. |
callable | $instantiator | Callback function that returns a service instance. Will be called with this MediaWikiServices instance as the only parameter. The instantiator must return a service compatible with the originally defined service. Any extra instantiation parameters provided to the constructor will be passed as subsequent parameters when invoking the instantiator. |
RuntimeException | if $name is not a known service. |
Definition at line 238 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\hasService().
|
finalprotected |
Resets a service by dropping the service instance.
If the service instances implements DestructibleService, destroy() is called on the service instance.
string | $name | The name of the service to reset. |
bool | $destroy | Whether the service instance should be destroyed if it exists. When set to false, any existing service instance will effectively be detached from the container. |
RuntimeException | if $name is not a known service. |
Definition at line 301 of file ServiceContainer.php.
References MediaWiki\Services\ServiceContainer\peekService().
Referenced by MediaWiki\Services\ServiceContainer\disableService().
|
private |
Definition at line 71 of file ServiceContainer.php.
|
private |
disabled status, per service name
Definition at line 61 of file ServiceContainer.php.
|
private |
Definition at line 66 of file ServiceContainer.php.
Referenced by MediaWiki\Services\ServiceContainer\__construct().
|
private |
Definition at line 56 of file ServiceContainer.php.
Referenced by MediaWiki\Services\ServiceContainer\applyWiring().
|
private |
Definition at line 51 of file ServiceContainer.php.