MediaWiki  master
ApiParamInfo.php
Go to the documentation of this file.
1 <?php
26 class ApiParamInfo extends ApiBase {
27 
28  private $helpFormat;
29  private $context;
30 
31  public function __construct( ApiMain $main, $action ) {
32  parent::__construct( $main, $action );
33  }
34 
35  public function execute() {
36  // Get parameters
37  $params = $this->extractRequestParams();
38 
39  $this->helpFormat = $params['helpformat'];
40  $this->context = new RequestContext;
41  $this->context->setUser( new User ); // anon to avoid caching issues
42  $this->context->setLanguage( $this->getMain()->getLanguage() );
43 
44  if ( is_array( $params['modules'] ) ) {
45  $modules = [];
46  foreach ( $params['modules'] as $path ) {
47  if ( $path === '*' || $path === '**' ) {
48  $path = "main+$path";
49  }
50  if ( substr( $path, -2 ) === '+*' || substr( $path, -2 ) === ' *' ) {
51  $submodules = true;
52  $path = substr( $path, 0, -2 );
53  $recursive = false;
54  } elseif ( substr( $path, -3 ) === '+**' || substr( $path, -3 ) === ' **' ) {
55  $submodules = true;
56  $path = substr( $path, 0, -3 );
57  $recursive = true;
58  } else {
59  $submodules = false;
60  }
61 
62  if ( $submodules ) {
63  try {
64  $module = $this->getModuleFromPath( $path );
65  } catch ( ApiUsageException $ex ) {
66  foreach ( $ex->getStatusValue()->getErrors() as $error ) {
67  $this->addWarning( $error );
68  }
69  continue;
70  }
71  $submodules = $this->listAllSubmodules( $module, $recursive );
72  if ( $submodules ) {
73  $modules = array_merge( $modules, $submodules );
74  } else {
75  $this->addWarning( [ 'apierror-badmodule-nosubmodules', $path ], 'badmodule' );
76  }
77  } else {
78  $modules[] = $path;
79  }
80  }
81  } else {
82  $modules = [];
83  }
84 
85  if ( is_array( $params['querymodules'] ) ) {
86  $queryModules = $params['querymodules'];
87  foreach ( $queryModules as $m ) {
88  $modules[] = 'query+' . $m;
89  }
90  } else {
91  $queryModules = [];
92  }
93 
94  if ( is_array( $params['formatmodules'] ) ) {
95  $formatModules = $params['formatmodules'];
96  foreach ( $formatModules as $m ) {
97  $modules[] = $m;
98  }
99  } else {
100  $formatModules = [];
101  }
102 
103  $modules = array_unique( $modules );
104 
105  $res = [];
106 
107  foreach ( $modules as $m ) {
108  try {
109  $module = $this->getModuleFromPath( $m );
110  } catch ( ApiUsageException $ex ) {
111  foreach ( $ex->getStatusValue()->getErrors() as $error ) {
112  $this->addWarning( $error );
113  }
114  continue;
115  }
116  $key = 'modules';
117 
118  // Back compat
119  $isBCQuery = false;
120  if ( $module->getParent() && $module->getParent()->getModuleName() == 'query' &&
121  in_array( $module->getModuleName(), $queryModules )
122  ) {
123  $isBCQuery = true;
124  $key = 'querymodules';
125  }
126  if ( in_array( $module->getModuleName(), $formatModules ) ) {
127  $key = 'formatmodules';
128  }
129 
130  $item = $this->getModuleInfo( $module );
131  if ( $isBCQuery ) {
132  $item['querytype'] = $item['group'];
133  }
134  $res[$key][] = $item;
135  }
136 
137  $result = $this->getResult();
138  $result->addValue( [ $this->getModuleName() ], 'helpformat', $this->helpFormat );
139 
140  foreach ( $res as $key => $stuff ) {
141  ApiResult::setIndexedTagName( $res[$key], 'module' );
142  }
143 
144  if ( $params['mainmodule'] ) {
145  $res['mainmodule'] = $this->getModuleInfo( $this->getMain() );
146  }
147 
148  if ( $params['pagesetmodule'] ) {
149  $pageSet = new ApiPageSet( $this->getMain()->getModuleManager()->getModule( 'query' ) );
150  $res['pagesetmodule'] = $this->getModuleInfo( $pageSet );
151  unset( $res['pagesetmodule']['name'] );
152  unset( $res['pagesetmodule']['path'] );
153  unset( $res['pagesetmodule']['group'] );
154  }
155 
156  $result->addValue( null, $this->getModuleName(), $res );
157  }
158 
165  private function listAllSubmodules( ApiBase $module, $recursive ) {
166  $manager = $module->getModuleManager();
167  if ( $manager ) {
168  $paths = [];
169  $names = $manager->getNames();
170  sort( $names );
171  foreach ( $names as $name ) {
172  $submodule = $manager->getModule( $name );
173  $paths[] = $submodule->getModulePath();
174  if ( $recursive && $submodule->getModuleManager() ) {
175  $paths = array_merge( $paths, $this->listAllSubmodules( $submodule, $recursive ) );
176  }
177  }
178  }
179  return $paths;
180  }
181 
188  protected function formatHelpMessages( array &$res, $key, array $msgs, $joinLists = false ) {
189  switch ( $this->helpFormat ) {
190  case 'none':
191  break;
192 
193  case 'wikitext':
194  $ret = [];
195  foreach ( $msgs as $m ) {
196  $ret[] = $m->setContext( $this->context )->text();
197  }
198  $res[$key] = implode( "\n\n", $ret );
199  if ( $joinLists ) {
200  $res[$key] = preg_replace( '!^(([*#:;])[^\n]*)\n\n(?=\2)!m', "$1\n", $res[$key] );
201  }
202  break;
203 
204  case 'html':
205  $ret = [];
206  foreach ( $msgs as $m ) {
207  $ret[] = $m->setContext( $this->context )->parseAsBlock();
208  }
209  $ret = implode( "\n", $ret );
210  if ( $joinLists ) {
211  $ret = preg_replace( '!\s*</([oud]l)>\s*<\1>\s*!', "\n", $ret );
212  }
213  $res[$key] = Parser::stripOuterParagraph( $ret );
214  break;
215 
216  case 'raw':
217  $res[$key] = [];
218  foreach ( $msgs as $m ) {
219  $a = [
220  'key' => $m->getKey(),
221  'params' => $m->getParams(),
222  ];
223  ApiResult::setIndexedTagName( $a['params'], 'param' );
224  if ( $m instanceof ApiHelpParamValueMessage ) {
225  $a['forvalue'] = $m->getParamValue();
226  }
227  $res[$key][] = $a;
228  }
229  ApiResult::setIndexedTagName( $res[$key], 'msg' );
230  break;
231  }
232  }
233 
238  private function getModuleInfo( $module ) {
239  $ret = [];
240  $path = $module->getModulePath();
241 
242  $ret['name'] = $module->getModuleName();
243  $ret['classname'] = get_class( $module );
244  $ret['path'] = $path;
245  if ( !$module->isMain() ) {
246  $ret['group'] = $module->getParent()->getModuleManager()->getModuleGroup(
247  $module->getModuleName()
248  );
249  }
250  $ret['prefix'] = $module->getModulePrefix();
251 
252  $sourceInfo = $module->getModuleSourceInfo();
253  if ( $sourceInfo ) {
254  $ret['source'] = $sourceInfo['name'];
255  if ( isset( $sourceInfo['namemsg'] ) ) {
256  $ret['sourcename'] = $this->context->msg( $sourceInfo['namemsg'] )->text();
257  } else {
258  $ret['sourcename'] = $ret['source'];
259  }
260 
261  $link = SpecialPage::getTitleFor( 'Version', 'License/' . $sourceInfo['name'] )->getFullURL();
262  if ( isset( $sourceInfo['license-name'] ) ) {
263  $ret['licensetag'] = $sourceInfo['license-name'];
264  $ret['licenselink'] = (string)$link;
265  } elseif ( SpecialVersion::getExtLicenseFileName( dirname( $sourceInfo['path'] ) ) ) {
266  $ret['licenselink'] = (string)$link;
267  }
268  }
269 
270  $this->formatHelpMessages( $ret, 'description', $module->getFinalDescription() );
271 
272  foreach ( $module->getHelpFlags() as $flag ) {
273  $ret[$flag] = true;
274  }
275 
276  $ret['helpurls'] = (array)$module->getHelpUrls();
277  if ( isset( $ret['helpurls'][0] ) && $ret['helpurls'][0] === false ) {
278  $ret['helpurls'] = [];
279  }
280  ApiResult::setIndexedTagName( $ret['helpurls'], 'helpurl' );
281 
282  if ( $this->helpFormat !== 'none' ) {
283  $ret['examples'] = [];
284  $examples = $module->getExamplesMessages();
285  foreach ( $examples as $qs => $msg ) {
286  $item = [
287  'query' => $qs
288  ];
289  $msg = ApiBase::makeMessage( $msg, $this->context, [
290  $module->getModulePrefix(),
291  $module->getModuleName(),
292  $module->getModulePath()
293  ] );
294  $this->formatHelpMessages( $item, 'description', [ $msg ] );
295  if ( isset( $item['description'] ) ) {
296  if ( is_array( $item['description'] ) ) {
297  $item['description'] = $item['description'][0];
298  } else {
299  ApiResult::setSubelementsList( $item, 'description' );
300  }
301  }
302  $ret['examples'][] = $item;
303  }
304  ApiResult::setIndexedTagName( $ret['examples'], 'example' );
305  }
306 
307  $ret['parameters'] = [];
308  $ret['templatedparameters'] = [];
309  $params = $module->getFinalParams( ApiBase::GET_VALUES_FOR_HELP );
310  $paramDesc = $module->getFinalParamDescription();
311  $index = 0;
312  foreach ( $params as $name => $settings ) {
313  if ( !is_array( $settings ) ) {
314  $settings = [ ApiBase::PARAM_DFLT => $settings ];
315  }
316 
317  $item = [
318  'index' => ++$index,
319  'name' => $name,
320  ];
321 
322  if ( !empty( $settings[ApiBase::PARAM_TEMPLATE_VARS] ) ) {
323  $item['templatevars'] = $settings[ApiBase::PARAM_TEMPLATE_VARS];
324  ApiResult::setIndexedTagName( $item['templatevars'], 'var' );
325  }
326 
327  if ( isset( $paramDesc[$name] ) ) {
328  $this->formatHelpMessages( $item, 'description', $paramDesc[$name], true );
329  }
330 
331  $item['required'] = !empty( $settings[ApiBase::PARAM_REQUIRED] );
332 
333  if ( !empty( $settings[ApiBase::PARAM_DEPRECATED] ) ) {
334  $item['deprecated'] = true;
335  }
336 
337  if ( $name === 'token' && $module->needsToken() ) {
338  $item['tokentype'] = $module->needsToken();
339  }
340 
341  if ( !isset( $settings[ApiBase::PARAM_TYPE] ) ) {
342  $dflt = $settings[ApiBase::PARAM_DFLT] ?? null;
343  if ( is_bool( $dflt ) ) {
344  $settings[ApiBase::PARAM_TYPE] = 'boolean';
345  } elseif ( is_string( $dflt ) || is_null( $dflt ) ) {
346  $settings[ApiBase::PARAM_TYPE] = 'string';
347  } elseif ( is_int( $dflt ) ) {
348  $settings[ApiBase::PARAM_TYPE] = 'integer';
349  }
350  }
351 
352  if ( isset( $settings[ApiBase::PARAM_DFLT] ) ) {
353  switch ( $settings[ApiBase::PARAM_TYPE] ) {
354  case 'boolean':
355  $item['default'] = (bool)$settings[ApiBase::PARAM_DFLT];
356  break;
357  case 'string':
358  case 'text':
359  case 'password':
360  $item['default'] = strval( $settings[ApiBase::PARAM_DFLT] );
361  break;
362  case 'integer':
363  case 'limit':
364  $item['default'] = (int)$settings[ApiBase::PARAM_DFLT];
365  break;
366  case 'timestamp':
367  $item['default'] = wfTimestamp( TS_ISO_8601, $settings[ApiBase::PARAM_DFLT] );
368  break;
369  default:
370  $item['default'] = $settings[ApiBase::PARAM_DFLT];
371  break;
372  }
373  }
374 
375  $item['multi'] = !empty( $settings[ApiBase::PARAM_ISMULTI] );
376  if ( $item['multi'] ) {
377  $item['lowlimit'] = !empty( $settings[ApiBase::PARAM_ISMULTI_LIMIT1] )
378  ? $settings[ApiBase::PARAM_ISMULTI_LIMIT1]
380  $item['highlimit'] = !empty( $settings[ApiBase::PARAM_ISMULTI_LIMIT2] )
381  ? $settings[ApiBase::PARAM_ISMULTI_LIMIT2]
383  $item['limit'] = $this->getMain()->canApiHighLimits()
384  ? $item['highlimit']
385  : $item['lowlimit'];
386  }
387 
388  if ( !empty( $settings[ApiBase::PARAM_ALLOW_DUPLICATES] ) ) {
389  $item['allowsduplicates'] = true;
390  }
391 
392  if ( isset( $settings[ApiBase::PARAM_TYPE] ) ) {
393  if ( $settings[ApiBase::PARAM_TYPE] === 'submodule' ) {
394  if ( isset( $settings[ApiBase::PARAM_SUBMODULE_MAP] ) ) {
395  ksort( $settings[ApiBase::PARAM_SUBMODULE_MAP] );
396  $item['type'] = array_keys( $settings[ApiBase::PARAM_SUBMODULE_MAP] );
397  $item['submodules'] = $settings[ApiBase::PARAM_SUBMODULE_MAP];
398  } else {
399  $item['type'] = $module->getModuleManager()->getNames( $name );
400  sort( $item['type'] );
401  $prefix = $module->isMain()
402  ? '' : ( $module->getModulePath() . '+' );
403  $item['submodules'] = [];
404  foreach ( $item['type'] as $v ) {
405  $item['submodules'][$v] = $prefix . $v;
406  }
407  }
408  if ( isset( $settings[ApiBase::PARAM_SUBMODULE_PARAM_PREFIX] ) ) {
409  $item['submoduleparamprefix'] = $settings[ApiBase::PARAM_SUBMODULE_PARAM_PREFIX];
410  }
411 
412  $deprecatedSubmodules = [];
413  foreach ( $item['submodules'] as $v => $submodulePath ) {
414  try {
415  $submod = $this->getModuleFromPath( $submodulePath );
416  if ( $submod && $submod->isDeprecated() ) {
417  $deprecatedSubmodules[] = $v;
418  }
419  } catch ( ApiUsageException $ex ) {
420  // Ignore
421  }
422  }
423  if ( $deprecatedSubmodules ) {
424  $item['type'] = array_merge(
425  array_diff( $item['type'], $deprecatedSubmodules ),
426  $deprecatedSubmodules
427  );
428  $item['deprecatedvalues'] = $deprecatedSubmodules;
429  }
430  } elseif ( $settings[ApiBase::PARAM_TYPE] === 'tags' ) {
431  $item['type'] = ChangeTags::listExplicitlyDefinedTags();
432  } else {
433  $item['type'] = $settings[ApiBase::PARAM_TYPE];
434  }
435  if ( is_array( $item['type'] ) ) {
436  // To prevent sparse arrays from being serialized to JSON as objects
437  $item['type'] = array_values( $item['type'] );
438  ApiResult::setIndexedTagName( $item['type'], 't' );
439  }
440 
441  // Add 'allspecifier' if applicable
442  if ( $item['type'] === 'namespace' ) {
443  $allowAll = true;
444  $allSpecifier = ApiBase::ALL_DEFAULT_STRING;
445  } else {
446  $allowAll = $settings[ApiBase::PARAM_ALL] ?? false;
447  $allSpecifier = ( is_string( $allowAll ) ? $allowAll : ApiBase::ALL_DEFAULT_STRING );
448  }
449  if ( $allowAll && $item['multi'] &&
450  ( is_array( $item['type'] ) || $item['type'] === 'namespace' ) ) {
451  $item['allspecifier'] = $allSpecifier;
452  }
453 
454  if ( $item['type'] === 'namespace' &&
455  isset( $settings[ApiBase::PARAM_EXTRA_NAMESPACES] ) &&
456  is_array( $settings[ApiBase::PARAM_EXTRA_NAMESPACES] )
457  ) {
458  $item['extranamespaces'] = $settings[ApiBase::PARAM_EXTRA_NAMESPACES];
459  ApiResult::setArrayType( $item['extranamespaces'], 'array' );
460  ApiResult::setIndexedTagName( $item['extranamespaces'], 'ns' );
461  }
462  }
463  if ( isset( $settings[ApiBase::PARAM_MAX] ) ) {
464  $item['max'] = $settings[ApiBase::PARAM_MAX];
465  }
466  if ( isset( $settings[ApiBase::PARAM_MAX2] ) ) {
467  $item['highmax'] = $settings[ApiBase::PARAM_MAX2];
468  }
469  if ( isset( $settings[ApiBase::PARAM_MIN] ) ) {
470  $item['min'] = $settings[ApiBase::PARAM_MIN];
471  }
472  if ( !empty( $settings[ApiBase::PARAM_RANGE_ENFORCE] ) ) {
473  $item['enforcerange'] = true;
474  }
475  if ( isset( $settings[self::PARAM_MAX_BYTES] ) ) {
476  $item['maxbytes'] = $settings[self::PARAM_MAX_BYTES];
477  }
478  if ( isset( $settings[self::PARAM_MAX_CHARS] ) ) {
479  $item['maxchars'] = $settings[self::PARAM_MAX_CHARS];
480  }
481  if ( !empty( $settings[ApiBase::PARAM_DEPRECATED_VALUES] ) ) {
482  $deprecatedValues = array_keys( $settings[ApiBase::PARAM_DEPRECATED_VALUES] );
483  if ( is_array( $item['type'] ) ) {
484  $deprecatedValues = array_intersect( $deprecatedValues, $item['type'] );
485  }
486  if ( $deprecatedValues ) {
487  $item['deprecatedvalues'] = array_values( $deprecatedValues );
488  ApiResult::setIndexedTagName( $item['deprecatedvalues'], 'v' );
489  }
490  }
491 
492  if ( !empty( $settings[ApiBase::PARAM_HELP_MSG_INFO] ) ) {
493  $item['info'] = [];
494  foreach ( $settings[ApiBase::PARAM_HELP_MSG_INFO] as $i ) {
495  $tag = array_shift( $i );
496  $info = [
497  'name' => $tag,
498  ];
499  if ( count( $i ) ) {
500  $info['values'] = $i;
501  ApiResult::setIndexedTagName( $info['values'], 'v' );
502  }
503  $this->formatHelpMessages( $info, 'text', [
504  $this->context->msg( "apihelp-{$path}-paraminfo-{$tag}" )
505  ->numParams( count( $i ) )
506  ->params( $this->context->getLanguage()->commaList( $i ) )
507  ->params( $module->getModulePrefix() )
508  ] );
509  ApiResult::setSubelementsList( $info, 'text' );
510  $item['info'][] = $info;
511  }
512  ApiResult::setIndexedTagName( $item['info'], 'i' );
513  }
514 
515  $key = empty( $settings[ApiBase::PARAM_TEMPLATE_VARS] ) ? 'parameters' : 'templatedparameters';
516  $ret[$key][] = $item;
517  }
518  ApiResult::setIndexedTagName( $ret['parameters'], 'param' );
519  ApiResult::setIndexedTagName( $ret['templatedparameters'], 'param' );
520 
521  $dynamicParams = $module->dynamicParameterDocumentation();
522  if ( $dynamicParams !== null ) {
523  if ( $this->helpFormat === 'none' ) {
524  $ret['dynamicparameters'] = true;
525  } else {
526  $dynamicParams = ApiBase::makeMessage( $dynamicParams, $this->context, [
527  $module->getModulePrefix(),
528  $module->getModuleName(),
529  $module->getModulePath()
530  ] );
531  $this->formatHelpMessages( $ret, 'dynamicparameters', [ $dynamicParams ] );
532  }
533  }
534 
535  return $ret;
536  }
537 
538  public function isReadMode() {
539  return false;
540  }
541 
542  public function getAllowedParams() {
543  // back compat
544  $querymodules = $this->getMain()->getModuleManager()
545  ->getModule( 'query' )->getModuleManager()->getNames();
546  sort( $querymodules );
547  $formatmodules = $this->getMain()->getModuleManager()->getNames( 'format' );
548  sort( $formatmodules );
549 
550  return [
551  'modules' => [
552  ApiBase::PARAM_ISMULTI => true,
553  ],
554  'helpformat' => [
555  ApiBase::PARAM_DFLT => 'none',
556  ApiBase::PARAM_TYPE => [ 'html', 'wikitext', 'raw', 'none' ],
557  ],
558 
559  'querymodules' => [
561  ApiBase::PARAM_ISMULTI => true,
562  ApiBase::PARAM_TYPE => $querymodules,
563  ],
564  'mainmodule' => [
566  ],
567  'pagesetmodule' => [
569  ],
570  'formatmodules' => [
572  ApiBase::PARAM_ISMULTI => true,
573  ApiBase::PARAM_TYPE => $formatmodules,
574  ]
575  ];
576  }
577 
578  protected function getExamplesMessages() {
579  return [
580  'action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo'
581  => 'apihelp-paraminfo-example-1',
582  'action=paraminfo&modules=query%2B*'
583  => 'apihelp-paraminfo-example-2',
584  ];
585  }
586 
587  public function getHelpUrls() {
588  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parameter_information';
589  }
590 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getResult()
Get the result object.
Definition: ApiBase.php:640
Message subclass that prepends wikitext for API help.
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1971
__construct(ApiMain $main, $action)
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
getMain()
Get the main module.
Definition: ApiBase.php:536
const GET_VALUES_FOR_HELP
getAllowedParams() flag: When set, the result could take longer to generate, but should be more thoro...
Definition: ApiBase.php:272
Exception used to abort API execution with an error.
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:118
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:148
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
static listExplicitlyDefinedTags()
Lists tags explicitly defined in the change_tag_def table of the database.
const PARAM_ALL
(boolean|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true...
Definition: ApiBase.php:187
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
const PARAM_ISMULTI_LIMIT1
(integer) Maximum number of values, for normal users.
Definition: ApiBase.php:215
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:1969
static makeMessage( $msg, IContextSource $context, array $params=null)
Create a Message from a string or array.
Definition: ApiBase.php:1795
static stripOuterParagraph( $html)
Strip outer.
Definition: Parser.php:6414
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3038
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$modules
const PARAM_SUBMODULE_PARAM_PREFIX
(string) When PARAM_TYPE is &#39;submodule&#39;, used to indicate the &#39;g&#39; prefix added by ApiQueryGeneratorBa...
Definition: ApiBase.php:179
const PARAM_ISMULTI_LIMIT2
(integer) Maximum number of values, for users with the apihighimits right.
Definition: ApiBase.php:222
const PARAM_RANGE_ENFORCE
(boolean) For PARAM_TYPE &#39;integer&#39;, enforce PARAM_MIN and PARAM_MAX?
Definition: ApiBase.php:124
$res
Definition: database.txt:21
formatHelpMessages(array &$res, $key, array $msgs, $joinLists=false)
const LIMIT_SML2
Slow query, apihighlimits limit.
Definition: ApiBase.php:265
const PARAM_SUBMODULE_MAP
(string[]) When PARAM_TYPE is &#39;submodule&#39;, map parameter values to submodule paths.
Definition: ApiBase.php:172
$params
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:41
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:767
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
static getExtLicenseFileName( $extDir)
Obtains the full path of an extensions copying or license file if one exists.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
getModuleFromPath( $path)
Get a module from its module path.
Definition: ApiBase.php:602
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
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
static setSubelementsList(array &$arr, $names)
Causes the elements with the specified names to be output as subelements rather than attributes...
Definition: ApiResult.php:565
const LIMIT_SML1
Slow query, standard limit.
Definition: ApiBase.php:263
const PARAM_TEMPLATE_VARS
(array) Indicate that this is a templated parameter, and specify replacements.
Definition: ApiBase.php:252
getModuleManager()
Get the module manager, or null if this module has no sub-modules.
Definition: ApiBase.php:341
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
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1928
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
Definition: ApiBase.php:209
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
const ALL_DEFAULT_STRING
Definition: ApiBase.php:256
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:42
const PARAM_EXTRA_NAMESPACES
(int[]) When PARAM_TYPE is &#39;namespace&#39;, include these as additional possible values.
Definition: ApiBase.php:193
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:112
getModuleInfo( $module)
getStatusValue()
Fetch the error status.
listAllSubmodules(ApiBase $module, $recursive)
List all submodules of a module.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
const PARAM_ALLOW_DUPLICATES
(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true?
Definition: ApiBase.php:109