Manages information related to REST modules, such as routes and specs. More...

Public Member Functions
	__construct (ServiceOptions $options, array $extensionModuleFiles, BagOStuff $srvCache, ResponseFactory $responseFactory)

	getApiSpecs ()
	Returns the available choices for APIs to explore.

	getDisabledRouteFiles ()
	Useful for testing or error status.

	getModuleMode (string $moduleId)
	Gets the module mode for a given module id.

	getRouteFiles ()

	hasApiSpecs ()
	Returns true if any api specs are available, or false otherwise.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Detailed Description

Manages information related to REST modules, such as routes and specs.

TODO: consider whether some code in Router or SpecBasedModule might be better placed here. TODO: consider whether ModuleManager and Router can share caching.

Since: 1.46

Definition at line 19 of file ModuleManager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Module\ModuleManager::__construct	(	ServiceOptions	$options,
		array	$extensionModuleFiles,
		BagOStuff	$srvCache,
		ResponseFactory	$responseFactory )

Parameters

ServiceOptions	$options
string[]	$extensionModuleFiles
BagOStuff	$srvCache	Optional BagOStuff instance to an APC-style cache.
ResponseFactory	$responseFactory

Access: internal

Definition at line 83 of file ModuleManager.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\MainConfigNames\ExtensionDirectory, MediaWiki\Config\ServiceOptions\get(), MediaWiki\MainConfigNames\RestAPIAdditionalRouteFiles, MediaWiki\MainConfigNames\RestExternalModules, MediaWiki\MainConfigNames\RestModuleOverrides, MediaWiki\MainConfigNames\RestSandboxSpecs, and MediaWiki\MainConfigNames\ScriptPath.

Member Function Documentation

◆ getApiSpecs()

MediaWiki\Rest\Module\ModuleManager::getApiSpecs ( )

Returns the available choices for APIs to explore.

Returns: array<string,array<string,string>>

Definition at line 220 of file ModuleManager.php.

◆ getDisabledRouteFiles()

MediaWiki\Rest\Module\ModuleManager::getDisabledRouteFiles ( )

Useful for testing or error status.

The return value will include route files that were disabled by either audience designation or configuration.

Since: 1.47

Returns: string[]

Definition at line 153 of file ModuleManager.php.

◆ getModuleMode()

MediaWiki\Rest\Module\ModuleManager::getModuleMode ( string $moduleId )

Gets the module mode for a given module id.

Parameters

string $moduleId The module id

Returns: ModuleMode

Since: 1.47

Definition at line 108 of file ModuleManager.php.

◆ getRouteFiles()

MediaWiki\Rest\Module\ModuleManager::getRouteFiles ( )

Returns: string[]

Definition at line 138 of file ModuleManager.php.

Referenced by MediaWiki\Rest\Router\__construct().

◆ hasApiSpecs()

MediaWiki\Rest\Module\ModuleManager::hasApiSpecs ( )

Returns true if any api specs are available, or false otherwise.

Returns: bool

Definition at line 207 of file ModuleManager.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Rest\Module\ModuleManager::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::ExtensionDirectory,
        MainConfigNames::RestAPIAdditionalRouteFiles,
        MainConfigNames::RestSandboxSpecs,
        MainConfigNames::RestExternalModules,
        MainConfigNames::RestModuleOverrides,
        MainConfigNames::ScriptPath
    ]

Access: internal

Definition at line 66 of file ModuleManager.php.

The documentation for this class was generated from the following file:

includes/Rest/Module/ModuleManager.php

Public Member Functions

Public Attributes