ApiModuleManager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use InvalidArgumentException;
use MediaWiki\Context\ContextSource;
use MediaWiki\MediaWikiServices;
use UnexpectedValueException;
use Wikimedia\ObjectFactory\ObjectFactory;
 
class ApiModuleManager extends ContextSource {
 
    private $mInstances = [];
    private $mGroups = [];
    private $mModules = [];
    private $objectFactory;
 
    public function __construct(
        private readonly ApiBase $parentModule,
        ?ObjectFactory $objectFactory = null,
    ) {
        $this->objectFactory = $objectFactory ?? MediaWikiServices::getInstance()->getObjectFactory();
    }
 
    public function addModules( array $modules, $group ) {
        foreach ( $modules as $name => $moduleSpec ) {
            $this->addModule( $name, $group, $moduleSpec );
        }
    }
 
    public function addModule( string $name, string $group, $spec, $factory = null ) {
        if ( is_string( $spec ) ) {
            $spec = [
                'class' => $spec
            ];
 
            if ( is_callable( $factory ) ) {
                wfDeprecated( __METHOD__ . ' with $class and $factory', '1.34' );
                $spec['factory'] = $factory;
            }
        } elseif ( !is_array( $spec ) ) {
            throw new InvalidArgumentException( '$spec must be a string or an array' );
        } elseif ( !isset( $spec['class'] ) ) {
            throw new InvalidArgumentException( '$spec must define a class name' );
        }
 
        $this->mGroups[$group] = null;
        $this->mModules[$name] = [ $group, $spec ];
    }
 
    public function getModule( $moduleName, $group = null, $ignoreCache = false ) {
        if ( !isset( $this->mModules[$moduleName] ) ) {
            return null;
        }
 
        [ $moduleGroup, $spec ] = $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, $spec );
 
            if ( !$ignoreCache ) {
                // cache this instance in case it is needed later
                $this->mInstances[$moduleName] = $instance;
            }
 
            return $instance;
        }
    }
 
    private function instantiateModule( $name, $spec ) {
        return $this->objectFactory->createObject(
            $spec,
            [
                'extraArgs' => [
                    $this->parentModule,
                    $name
                ],
                'assertClass' => $spec['class']
            ]
        );
    }
 
    public function getNames( $group = null ) {
        if ( $group === null ) {
            return array_keys( $this->mModules );
        }
        $result = [];
        foreach ( $this->mModules as $name => $groupAndSpec ) {
            if ( $groupAndSpec[0] === $group ) {
                $result[] = $name;
            }
        }
 
        return $result;
    }
 
    public function getNamesWithClasses( $group = null ) {
        $result = [];
        foreach ( $this->mModules as $name => $groupAndSpec ) {
            if ( $group === null || $groupAndSpec[0] === $group ) {
                $result[$name] = $groupAndSpec[1]['class'];
            }
        }
 
        return $result;
    }
 
    public function getClassName( $module ) {
        if ( isset( $this->mModules[$module] ) ) {
            return $this->mModules[$module][1]['class'];
        }
 
        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 );
    }
}
 
class_alias( ApiModuleManager::class, 'ApiModuleManager' );