ApiModuleManager.php

Go to the documentation of this file.

<?php
class ApiModuleManager extends ContextSource {

    private $mParent;
    private $mInstances = array();
    private $mGroups = array();
    private $mModules = array();

    public function __construct( ApiBase $parentModule ) {
        $this->mParent = $parentModule;
    }

    public function addModules( array $modules, $group ) {
        foreach ( $modules as $name => $class ) {
            $this->addModule( $name, $group, $class );
        }
    }

    public function addModule( $name, $group, $class ) {
        $this->mGroups[$group] = null;
        $this->mModules[$name] = array( $group, $class );
    }

    public function getModule( $moduleName, $group = null, $ignoreCache = false ) {
        if ( !isset( $this->mModules[$moduleName] ) ) {
            return null;
        }
        $grpCls = $this->mModules[$moduleName];
        if ( $group !== null && $grpCls[0] !== $group ) {
            return null;
        }
        if ( !$ignoreCache && isset( $this->mInstances[$moduleName] ) ) {
            // already exists
            return $this->mInstances[$moduleName];
        } else {
            // new instance
            $class = $grpCls[1];
            $instance = new $class ( $this->mParent, $moduleName );
            if ( !$ignoreCache ) {
                // cache this instance in case it is needed later
                $this->mInstances[$moduleName] = $instance;
            }
            return $instance;
        }
    }

    public function getNames( $group = null ) {
        if ( $group === null ) {
            return array_keys( $this->mModules );
        }
        $result = array();
        foreach ( $this->mModules as $name => $grpCls ) {
            if ( $grpCls[0] === $group ) {
                $result[] = $name;
            }
        }
        return $result;
    }

    public function getNamesWithClasses( $group = null ) {
        $result = array();
        foreach ( $this->mModules as $name => $grpCls ) {
            if ( $group === null || $grpCls[0] === $group ) {
                $result[$name] = $grpCls[1];
            }
        }
        return $result;
    }

    public function isDefined( $moduleName, $group = null ) {
        if ( isset( $this->mModules[$moduleName] ) ) {
            return $group === null || $this->mModules[$moduleName][0] === $group;
        } else {
            return false;
        }
    }

    public function getModuleGroup( $moduleName ) {
        if ( isset( $this->mModules[$moduleName] ) ) {
            return $this->mModules[$moduleName][0];
        } else {
            return null;
        }
    }

    public function getGroups() {
        return array_keys( $this->mGroups );
    }
}