LockManagerGroup.php

Go to the documentation of this file.

<?php
class LockManagerGroup {
    protected static $instances = array();

    protected $domain; // string; domain (usually wiki ID)

    protected $managers = array();

    protected function __construct( $domain ) {
        $this->domain = $domain;
    }

    public static function singleton( $domain = false ) {
        $domain = ( $domain === false ) ? wfWikiID() : $domain;
        if ( !isset( self::$instances[$domain] ) ) {
            self::$instances[$domain] = new self( $domain );
            self::$instances[$domain]->initFromGlobals();
        }

        return self::$instances[$domain];
    }

    public static function destroySingletons() {
        self::$instances = array();
    }

    protected function initFromGlobals() {
        global $wgLockManagers;

        $this->register( $wgLockManagers );
    }

    protected function register( array $configs ) {
        foreach ( $configs as $config ) {
            $config['domain'] = $this->domain;
            if ( !isset( $config['name'] ) ) {
                throw new MWException( "Cannot register a lock manager with no name." );
            }
            $name = $config['name'];
            if ( !isset( $config['class'] ) ) {
                throw new MWException( "Cannot register lock manager `{$name}` with no class." );
            }
            $class = $config['class'];
            unset( $config['class'] ); // lock manager won't need this
            $this->managers[$name] = array(
                'class' => $class,
                'config' => $config,
                'instance' => null
            );
        }
    }

    public function get( $name ) {
        if ( !isset( $this->managers[$name] ) ) {
            throw new MWException( "No lock manager defined with the name `$name`." );
        }
        // Lazy-load the actual lock manager instance
        if ( !isset( $this->managers[$name]['instance'] ) ) {
            $class = $this->managers[$name]['class'];
            $config = $this->managers[$name]['config'];
            $this->managers[$name]['instance'] = new $class( $config );
        }

        return $this->managers[$name]['instance'];
    }

    public function config( $name ) {
        if ( !isset( $this->managers[$name] ) ) {
            throw new MWException( "No lock manager defined with the name `$name`." );
        }
        $class = $this->managers[$name]['class'];

        return array( 'class' => $class ) + $this->managers[$name]['config'];
    }

    public function getDefault() {
        return isset( $this->managers['default'] )
            ? $this->get( 'default' )
            : new NullLockManager( array() );
    }

    public function getAny() {
        return isset( $this->managers['default'] )
            ? $this->get( 'default' )
            : $this->get( 'fsLockManager' );
    }
}