MediaWiki\Rest\Module Namespace Reference

Classes
class	ExtraRoutesModule
	A Module that is based on flat route definitions in the form originally introduced in MW 1.35. More...
class	MatcherBasedModule
	MatcherBasedModules respond to requests by matching the requested path against a list of known routes to identify the appropriate handler. More...
class	Module
	A REST module represents a collection of endpoints. More...
class	ModuleFormatException
	Exception indicating incorrect REST module format. More...
class	ModuleManager
	Manages information related to REST modules, such as routes and specs. More...
class	SpecBasedModule
	A Module that is based on a module definition file similar to an OpenAPI spec. More...

Enumerations
enum	AudienceDesignation : string { fromModuleId }
	Describes the set of audience designations available to REST modules. More...
enum	ModuleMode : string { getModuleMode }
	Describes the set of functionality applied to a module by the REST API framework. More...

Enumeration Type Documentation

AudienceDesignation

enum MediaWiki::Rest::Module::AudienceDesignation : string

Describes the set of audience designations available to REST modules.

Modules without a specific designation are assumed to be "public".

Since

1.47

Enumerator
fromModuleId	Gets a module's audience designation from its module id. Parameters string $moduleId The module id Returns ?AudienceDesignation

Definition at line 11 of file AudienceDesignation.php.

ModuleMode

enum MediaWiki::Rest::Module::ModuleMode : string

Describes the set of functionality applied to a module by the REST API framework.

Module modes are determined by the module's audience designation, and can be overridden by the RestModuleOverrides config variable.

Module modes are backed by strings corresponding to the modes in the RestModuleOverrides config variable.

Since

1.47

Enumerator
getModuleMode	Gets the module mode for a given audience designation. Parameters ?AudienceDesignation $ad The audience designation Returns ModuleMode

Definition at line 15 of file ModuleMode.php.