wikimedia/services

Generic service to manage named services using lazy instantiation based on instantiator callback functions

4.0.0 2024-11-08 15:57 UTC

Requires

• php: >=7.4.3
• psr/container: ^1.1 || ^2.0
• wikimedia/scoped-callback: ^3.0 || ^4.0 || ^5.0

Requires (Dev)

• mediawiki/mediawiki-codesniffer: 45.0.0
• mediawiki/mediawiki-phan-config: 0.14.0
• mediawiki/minus-x: 1.1.3
• ockcyp/covers-validator: 1.6.0
• php-parallel-lint/php-console-highlighter: 1.0.0
• php-parallel-lint/php-parallel-lint: 1.4.0
• phpunit/phpunit: 9.6.21

Provides

• psr/container-implementation: 1.0.0

GPL-2.0-or-later

• Daniel Kinzler

README

Services

A PSR-11-compliant services framework. Services are created by instantiators (callables), which are usually defined in separate wiring files.

Usage

$services = new ServiceContainer();

$services->defineService(
    'MyService',
    static function ( ServiceContainer $services ): MyService {
        return new MyService();
    }
);

$services->loadWiringFiles( [
    'path/to/ServiceWiring.php',
] );

Where ServiceWiring.php looks like this:

return [

    'MyOtherService' => static function ( ServiceContainer $services ): MyOtherService {
        return new MyOtherService( $services->get( 'MyService' ) );
    },

    // ...

];

Each instantiator receives the service container as the first argument, from which it may retrieve further services as needed. Additional arguments for each instantiator may be specified when constructing the ServiceContainer.

Custom subclasses of ServiceContainer may offer easier access to certain services:

class MyServiceContainer extends ServiceContainer {

    public function getMyService(): MyService {
        return $this->get( 'MyService' );
    }

    public function getMyOtherService(): MyOtherService {
        return $this->get( 'MyOtherService' );
    }

}

// ServiceWiring.php
return [

    'MyOtherService' => static function ( MyServiceContainer $services ): MyOtherService {
        return new MyOtherService( $services->getMyService() );
    },

];

Running tests

composer install --prefer-dist
composer test

History

This library was first introduced in MediaWiki 1.27 (I3c25c0ac17). It was split out of the MediaWiki codebase and published as an independent library during the MediaWiki 1.33 and MediaWiki 1.34 development cycles.