ApiModuleManager.php

Go to the documentation of this file.

<?php
class ApiModuleManager extends ContextSource {
 
    private $mParent;
    private $mInstances = [];
    private $mGroups = [];
    private $mModules = [];
 
    public function __construct( ApiBase $parentModule ) {
        $this->mParent = $parentModule;
    }
 
    public function addModules( array $modules, $group ) {
        foreach ( $modules as $name => $moduleSpec ) {
            if ( is_array( $moduleSpec ) ) {
                $class = $moduleSpec['class'];
                $factory = ( $moduleSpec['factory'] ?? null );
            } else {
                $class = $moduleSpec;
                $factory = null;
            }
 
            $this->addModule( $name, $group, $class, $factory );
        }
    }
 
    public function addModule( $name, $group, $class, $factory = null ) {
        if ( !is_string( $name ) ) {
            throw new InvalidArgumentException( '$name must be a string' );
        }
 
        if ( !is_string( $group ) ) {
            throw new InvalidArgumentException( '$group must be a string' );
        }
 
        if ( !is_string( $class ) ) {
            throw new InvalidArgumentException( '$class must be a string' );
        }
 
        if ( $factory !== null && !is_callable( $factory ) ) {
            throw new InvalidArgumentException( '$factory must be a callable (or null)' );
        }
 
        $this->mGroups[$group] = null;
        $this->mModules[$name] = [ $group, $class, $factory ];
    }
 
    public function getModule( $moduleName, $group = null, $ignoreCache = false ) {
        if ( !isset( $this->mModules[$moduleName] ) ) {
            return null;
        }
 
        list( $moduleGroup, $moduleClass, $moduleFactory ) = $this->mModules[$moduleName];
 
        if ( $group !== null && $moduleGroup !== $group ) {
            return null;
        }
 
        if ( !$ignoreCache && isset( $this->mInstances[$moduleName] ) ) {
            // already exists
            return $this->mInstances[$moduleName];
        } else {
            // new instance
            $instance = $this->instantiateModule( $moduleName, $moduleClass, $moduleFactory );
 
            if ( !$ignoreCache ) {
                // cache this instance in case it is needed later
                $this->mInstances[$moduleName] = $instance;
            }
 
            return $instance;
        }
    }
 
    private function instantiateModule( $name, $class, $factory = null ) {
        if ( $factory !== null ) {
            // create instance from factory
            $instance = call_user_func( $factory, $this->mParent, $name );
 
            if ( !$instance instanceof $class ) {
                throw new MWException(
                    "The factory function for module $name did not return an instance of $class!"
                );
            }
        } else {
            // create instance from class name
            $instance = new $class( $this->mParent, $name );
        }
 
        return $instance;
    }
 
    public function getNames( $group = null ) {
        if ( $group === null ) {
            return array_keys( $this->mModules );
        }
        $result = [];
        foreach ( $this->mModules as $name => $grpCls ) {
            if ( $grpCls[0] === $group ) {
                $result[] = $name;
            }
        }
 
        return $result;
    }
 
    public function getNamesWithClasses( $group = null ) {
        $result = [];
        foreach ( $this->mModules as $name => $grpCls ) {
            if ( $group === null || $grpCls[0] === $group ) {
                $result[$name] = $grpCls[1];
            }
        }
 
        return $result;
    }
 
    public function getClassName( $module ) {
        if ( isset( $this->mModules[$module] ) ) {
            return $this->mModules[$module][1];
        }
 
        return false;
    }
 
    public function isDefined( $moduleName, $group = null ) {
        if ( isset( $this->mModules[$moduleName] ) ) {
            return $group === null || $this->mModules[$moduleName][0] === $group;
        }
 
        return false;
    }
 
    public function getModuleGroup( $moduleName ) {
        if ( isset( $this->mModules[$moduleName] ) ) {
            return $this->mModules[$moduleName][0];
        }
 
        return null;
    }
 
    public function getGroups() {
        return array_keys( $this->mGroups );
    }
}