MediaWikiServices.php

Go to the documentation of this file.

<?php
namespace MediaWiki;

use ConfigFactory;
use EventRelayerGroup;
use GlobalVarConfig;
use Config;
use Hooks;
use Liuggio\StatsdClient\Factory\StatsdDataFactory;
use MediaWiki\Services\ServiceContainer;
use SearchEngine;
use SearchEngineConfig;
use SearchEngineFactory;
use SiteLookup;
use SiteStore;
use SkinFactory;

class MediaWikiServices extends ServiceContainer {

    public static function getInstance() {
        static $instance = null;

        if ( $instance === null ) {
            // NOTE: constructing GlobalVarConfig here is not particularly pretty,
            // but some information from the global scope has to be injected here,
            // even if it's just a file name or database credentials to load
            // configuration from.
            $config = new GlobalVarConfig();
            $instance = new self( $config );

            // Load the default wiring from the specified files.
            $wiringFiles = $config->get( 'ServiceWiringFiles' );
            $instance->loadWiringFiles( $wiringFiles );

            // Provide a traditional hook point to allow extensions to configure services.
            Hooks::run( 'MediaWikiServices', [ $instance ] );
        }

        return $instance;
    }

    public function __construct( Config $config ) {
        parent::__construct();

        // register the given Config object as the bootstrap config service.
        $this->defineService( 'BootstrapConfig', function() use ( $config ) {
            return $config;
        } );
    }

    public function getBootstrapConfig() {
        return $this->getService( 'BootstrapConfig' );
    }

    public function getConfigFactory() {
        return $this->getService( 'ConfigFactory' );
    }

    public function getMainConfig() {
        return $this->getService( 'MainConfig' );
    }

    public function getSiteLookup() {
        return $this->getService( 'SiteLookup' );
    }

    public function getSiteStore() {
        return $this->getService( 'SiteStore' );
    }

    public function getStatsdDataFactory() {
        return $this->getService( 'StatsdDataFactory' );
    }

    public function getEventRelayerGroup() {
        return $this->getService( 'EventRelayerGroup' );
    }

    public function newSearchEngine() {
        // New engine object every time, since they keep state
        return $this->getService( 'SearchEngineFactory' )->create();
    }

    public function getSearchEngineFactory() {
        return $this->getService( 'SearchEngineFactory' );
    }

    public function getSearchEngineConfig() {
        return $this->getService( 'SearchEngineConfig' );
    }

    public function getSkinFactory() {
        return $this->getService( 'SkinFactory' );
    }

    // NOTE: When adding a service getter here, don't forget to add a test
    // case for it in MediaWikiServicesTest::provideGetters() and in
    // MediaWikiServicesTest::provideGetService()!

}