MediaWiki REL1_27
|
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. | |
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. | |
loadWiringFiles (array $wiringFiles) | |
redefineService ( $name, callable $instantiator) | |
Replace an already defined service. | |
Private Member Functions | |
createService ( $name) | |
Private Attributes | |
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 68 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 97 of file ServiceContainer.php.
References $name, MediaWiki\Services\ServiceContainer\$serviceInstantiators, as, 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 209 of file ServiceContainer.php.
References $name.
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 138 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\hasService().
Referenced by MediaWiki\Services\ServiceContainer\applyWiring().
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 |
InvalidArgumentException | if $name is not a known service. |
Definition at line 195 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\createService().
MediaWiki\Services\ServiceContainer::getServiceNames | ( | ) |
Definition at line 120 of file ServiceContainer.php.
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 113 of file ServiceContainer.php.
References $name.
Referenced by MediaWiki\Services\ServiceContainer\defineService(), and MediaWiki\Services\ServiceContainer\redefineService().
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 77 of file ServiceContainer.php.
References MediaWiki\Services\ServiceContainer\applyWiring(), and as.
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 164 of file ServiceContainer.php.
References $name, and MediaWiki\Services\ServiceContainer\hasService().
|
private |
Definition at line 61 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.