MediaWiki  master
ApiModuleManager.php
Go to the documentation of this file.
1 <?php
31 
35  private $mParent;
39  private $mInstances = [];
43  private $mGroups = [];
47  private $mModules = [];
48 
53  public function __construct( ApiBase $parentModule ) {
54  $this->mParent = $parentModule;
55  }
56 
95  public function addModules( array $modules, $group ) {
96  foreach ( $modules as $name => $moduleSpec ) {
97  if ( is_array( $moduleSpec ) ) {
98  $class = $moduleSpec['class'];
99  $factory = ( $moduleSpec['factory'] ?? null );
100  } else {
101  $class = $moduleSpec;
102  $factory = null;
103  }
104 
105  $this->addModule( $name, $group, $class, $factory );
106  }
107  }
108 
121  public function addModule( $name, $group, $class, $factory = null ) {
122  if ( !is_string( $name ) ) {
123  throw new InvalidArgumentException( '$name must be a string' );
124  }
125 
126  if ( !is_string( $group ) ) {
127  throw new InvalidArgumentException( '$group must be a string' );
128  }
129 
130  if ( !is_string( $class ) ) {
131  throw new InvalidArgumentException( '$class must be a string' );
132  }
133 
134  if ( $factory !== null && !is_callable( $factory ) ) {
135  throw new InvalidArgumentException( '$factory must be a callable (or null)' );
136  }
137 
138  $this->mGroups[$group] = null;
139  $this->mModules[$name] = [ $group, $class, $factory ];
140  }
141 
151  public function getModule( $moduleName, $group = null, $ignoreCache = false ) {
152  if ( !isset( $this->mModules[$moduleName] ) ) {
153  return null;
154  }
155 
156  list( $moduleGroup, $moduleClass, $moduleFactory ) = $this->mModules[$moduleName];
157 
158  if ( $group !== null && $moduleGroup !== $group ) {
159  return null;
160  }
161 
162  if ( !$ignoreCache && isset( $this->mInstances[$moduleName] ) ) {
163  // already exists
164  return $this->mInstances[$moduleName];
165  } else {
166  // new instance
167  $instance = $this->instantiateModule( $moduleName, $moduleClass, $moduleFactory );
168 
169  if ( !$ignoreCache ) {
170  // cache this instance in case it is needed later
171  $this->mInstances[$moduleName] = $instance;
172  }
173 
174  return $instance;
175  }
176  }
177 
188  private function instantiateModule( $name, $class, $factory = null ) {
189  if ( $factory !== null ) {
190  // create instance from factory
191  $instance = call_user_func( $factory, $this->mParent, $name );
192 
193  if ( !$instance instanceof $class ) {
194  throw new MWException(
195  "The factory function for module $name did not return an instance of $class!"
196  );
197  }
198  } else {
199  // create instance from class name
200  $instance = new $class( $this->mParent, $name );
201  }
202 
203  return $instance;
204  }
205 
211  public function getNames( $group = null ) {
212  if ( $group === null ) {
213  return array_keys( $this->mModules );
214  }
215  $result = [];
216  foreach ( $this->mModules as $name => $grpCls ) {
217  if ( $grpCls[0] === $group ) {
218  $result[] = $name;
219  }
220  }
221 
222  return $result;
223  }
224 
230  public function getNamesWithClasses( $group = null ) {
231  $result = [];
232  foreach ( $this->mModules as $name => $grpCls ) {
233  if ( $group === null || $grpCls[0] === $group ) {
234  $result[$name] = $grpCls[1];
235  }
236  }
237 
238  return $result;
239  }
240 
248  public function getClassName( $module ) {
249  if ( isset( $this->mModules[$module] ) ) {
250  return $this->mModules[$module][1];
251  }
252 
253  return false;
254  }
255 
262  public function isDefined( $moduleName, $group = null ) {
263  if ( isset( $this->mModules[$moduleName] ) ) {
264  return $group === null || $this->mModules[$moduleName][0] === $group;
265  }
266 
267  return false;
268  }
269 
275  public function getModuleGroup( $moduleName ) {
276  if ( isset( $this->mModules[$moduleName] ) ) {
277  return $this->mModules[$moduleName][0];
278  }
279 
280  return null;
281  }
282 
287  public function getGroups() {
288  return array_keys( $this->mGroups );
289  }
290 }
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
This class holds a list of modules and handles instantiation.
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
addModules(array $modules, $group)
Add a list of modules to the manager.
getModule( $moduleName, $group=null, $ignoreCache=false)
Get module instance by name, or instantiate it if it does not exist.
getNames( $group=null)
Get an array of modules in a specific group or all if no group is set.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1981
addModule( $name, $group, $class, $factory=null)
Add or overwrite a module in this ApiMain instance.
getNamesWithClasses( $group=null)
Create an array of (moduleName => moduleClass) for a specific group or for all.
$modules
isDefined( $moduleName, $group=null)
Returns true if the specific module is defined at all or in a specific group.
getGroups()
Get a list of groups this manager contains.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
__construct(ApiBase $parentModule)
Construct new module manager.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
instantiateModule( $name, $class, $factory=null)
Instantiate the module using the given class or factory function.
getModuleGroup( $moduleName)
Returns the group name for the given module.
ApiBase [] $mInstances
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:42
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:277
getClassName( $module)
Returns the class name of the given module.