MediaWiki  1.27.1
ApiHelp.php
Go to the documentation of this file.
1 <?php
28 
35 class ApiHelp extends ApiBase {
36  public function execute() {
37  $params = $this->extractRequestParams();
38  $modules = [];
39 
40  foreach ( $params['modules'] as $path ) {
41  $modules[] = $this->getModuleFromPath( $path );
42  }
43 
44  // Get the help
45  $context = new DerivativeContext( $this->getMain()->getContext() );
46  $context->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'apioutput' ) );
47  $context->setLanguage( $this->getMain()->getLanguage() );
48  $context->setTitle( SpecialPage::getTitleFor( 'ApiHelp' ) );
49  $out = new OutputPage( $context );
50  $out->setCopyrightUrl( 'https://www.mediawiki.org/wiki/Special:MyLanguage/Copyright' );
51  $context->setOutput( $out );
52 
53  self::getHelp( $context, $modules, $params );
54 
55  // Grab the output from the skin
56  ob_start();
57  $context->getOutput()->output();
58  $html = ob_get_clean();
59 
60  $result = $this->getResult();
61  if ( $params['wrap'] ) {
62  $data = [
63  'mime' => 'text/html',
64  'help' => $html,
65  ];
66  ApiResult::setSubelementsList( $data, 'help' );
67  $result->addValue( null, $this->getModuleName(), $data );
68  } else {
69  $result->reset();
70  $result->addValue( null, 'text', $html, ApiResult::NO_SIZE_CHECK );
71  $result->addValue( null, 'mime', 'text/html', ApiResult::NO_SIZE_CHECK );
72  }
73  }
74 
95  public static function getHelp( IContextSource $context, $modules, array $options ) {
97 
98  if ( !is_array( $modules ) ) {
99  $modules = [ $modules ];
100  }
101 
102  $out = $context->getOutput();
103  $out->addModuleStyles( 'mediawiki.hlist' );
104  $out->addModuleStyles( 'mediawiki.apihelp' );
105  if ( !empty( $options['toc'] ) ) {
106  $out->addModules( 'mediawiki.toc' );
107  }
108  $out->setPageTitle( $context->msg( 'api-help-title' ) );
109 
111  $cacheKey = null;
112  if ( count( $modules ) == 1 && $modules[0] instanceof ApiMain &&
113  $options['recursivesubmodules'] && $context->getLanguage() === $wgContLang
114  ) {
115  $cacheHelpTimeout = $context->getConfig()->get( 'APICacheHelpTimeout' );
116  if ( $cacheHelpTimeout > 0 ) {
117  // Get help text from cache if present
118  $cacheKey = wfMemcKey( 'apihelp', $modules[0]->getModulePath(),
119  (int)!empty( $options['toc'] ),
120  str_replace( ' ', '_', SpecialVersion::getVersion( 'nodb' ) ) );
121  $cached = $cache->get( $cacheKey );
122  if ( $cached ) {
123  $out->addHTML( $cached );
124  return;
125  }
126  }
127  }
128  if ( $out->getHTML() !== '' ) {
129  // Don't save to cache, there's someone else's content in the page
130  // already
131  $cacheKey = null;
132  }
133 
134  $options['recursivesubmodules'] = !empty( $options['recursivesubmodules'] );
135  $options['submodules'] = $options['recursivesubmodules'] || !empty( $options['submodules'] );
136 
137  // Prepend lead
138  if ( empty( $options['nolead'] ) ) {
139  $msg = $context->msg( 'api-help-lead' );
140  if ( !$msg->isDisabled() ) {
141  $out->addHTML( $msg->parseAsBlock() );
142  }
143  }
144 
145  $haveModules = [];
146  $html = self::getHelpInternal( $context, $modules, $options, $haveModules );
147  if ( !empty( $options['toc'] ) && $haveModules ) {
148  $out->addHTML( Linker::generateTOC( $haveModules, $context->getLanguage() ) );
149  }
150  $out->addHTML( $html );
151 
152  $helptitle = isset( $options['helptitle'] ) ? $options['helptitle'] : null;
153  $html = self::fixHelpLinks( $out->getHTML(), $helptitle, $haveModules );
154  $out->clearHTML();
155  $out->addHTML( $html );
156 
157  if ( $cacheKey !== null ) {
158  $cache->set( $cacheKey, $out->getHTML(), $cacheHelpTimeout );
159  }
160  }
161 
170  public static function fixHelpLinks( $html, $helptitle = null, $localModules = [] ) {
171  $formatter = new HtmlFormatter( $html );
172  $doc = $formatter->getDoc();
173  $xpath = new DOMXPath( $doc );
174  $nodes = $xpath->query( '//a[@href][not(contains(@class,\'apihelp-linktrail\'))]' );
175  foreach ( $nodes as $node ) {
176  $href = $node->getAttribute( 'href' );
177  do {
178  $old = $href;
179  $href = rawurldecode( $href );
180  } while ( $old !== $href );
181  if ( preg_match( '!Special:ApiHelp/([^&/|#]+)((?:#.*)?)!', $href, $m ) ) {
182  if ( isset( $localModules[$m[1]] ) ) {
183  $href = $m[2] === '' ? '#' . $m[1] : $m[2];
184  } elseif ( $helptitle !== null ) {
185  $href = Title::newFromText( str_replace( '$1', $m[1], $helptitle ) . $m[2] )
186  ->getFullURL();
187  } else {
188  $href = wfAppendQuery( wfScript( 'api' ), [
189  'action' => 'help',
190  'modules' => $m[1],
191  ] ) . $m[2];
192  }
193  $node->setAttribute( 'href', $href );
194  $node->removeAttribute( 'title' );
195  }
196  }
197 
198  return $formatter->getText();
199  }
200 
209  private static function wrap( Message $msg, $class, $tag = 'span' ) {
210  return Html::rawElement( $tag, [ 'class' => $class ],
211  $msg->parse()
212  );
213  }
214 
224  private static function getHelpInternal( IContextSource $context, array $modules,
225  array $options, &$haveModules
226  ) {
227  $out = '';
228 
229  $level = empty( $options['headerlevel'] ) ? 2 : $options['headerlevel'];
230  if ( empty( $options['tocnumber'] ) ) {
231  $tocnumber = [ 2 => 0 ];
232  } else {
233  $tocnumber = &$options['tocnumber'];
234  }
235 
236  foreach ( $modules as $module ) {
237  $tocnumber[$level]++;
238  $path = $module->getModulePath();
239  $module->setContext( $context );
240  $help = [
241  'header' => '',
242  'flags' => '',
243  'description' => '',
244  'help-urls' => '',
245  'parameters' => '',
246  'examples' => '',
247  'submodules' => '',
248  ];
249 
250  if ( empty( $options['noheader'] ) || !empty( $options['toc'] ) ) {
251  $anchor = $path;
252  $i = 1;
253  while ( isset( $haveModules[$anchor] ) ) {
254  $anchor = $path . '|' . ++$i;
255  }
256 
257  if ( $module->isMain() ) {
258  $headerContent = $context->msg( 'api-help-main-header' )->parse();
259  $headerAttr = [
260  'class' => 'apihelp-header',
261  ];
262  } else {
263  $name = $module->getModuleName();
264  $headerContent = $module->getParent()->getModuleManager()->getModuleGroup( $name ) .
265  "=$name";
266  if ( $module->getModulePrefix() !== '' ) {
267  $headerContent .= ' ' .
268  $context->msg( 'parentheses', $module->getModulePrefix() )->parse();
269  }
270  // Module names are always in English and not localized,
271  // so English language and direction must be set explicitly,
272  // otherwise parentheses will get broken in RTL wikis
273  $headerAttr = [
274  'class' => 'apihelp-header apihelp-module-name',
275  'dir' => 'ltr',
276  'lang' => 'en',
277  ];
278  }
279 
280  $headerAttr['id'] = $anchor;
281 
282  $haveModules[$anchor] = [
283  'toclevel' => count( $tocnumber ),
284  'level' => $level,
285  'anchor' => $anchor,
286  'line' => $headerContent,
287  'number' => implode( '.', $tocnumber ),
288  'index' => false,
289  ];
290  if ( empty( $options['noheader'] ) ) {
291  $help['header'] .= Html::element(
292  'h' . min( 6, $level ),
293  $headerAttr,
294  $headerContent
295  );
296  }
297  } else {
298  $haveModules[$path] = true;
299  }
300 
301  $links = [];
302  $any = false;
303  for ( $m = $module; $m !== null; $m = $m->getParent() ) {
304  $name = $m->getModuleName();
305  if ( $name === 'main_int' ) {
306  $name = 'main';
307  }
308 
309  if ( count( $modules ) === 1 && $m === $modules[0] &&
310  !( !empty( $options['submodules'] ) && $m->getModuleManager() )
311  ) {
312  $link = Html::element( 'b', null, $name );
313  } else {
314  $link = SpecialPage::getTitleFor( 'ApiHelp', $m->getModulePath() )->getLocalURL();
315  $link = Html::element( 'a',
316  [ 'href' => $link, 'class' => 'apihelp-linktrail' ],
317  $name
318  );
319  $any = true;
320  }
321  array_unshift( $links, $link );
322  }
323  if ( $any ) {
324  $help['header'] .= self::wrap(
325  $context->msg( 'parentheses' )
326  ->rawParams( $context->getLanguage()->pipeList( $links ) ),
327  'apihelp-linktrail', 'div'
328  );
329  }
330 
331  $flags = $module->getHelpFlags();
332  $help['flags'] .= Html::openElement( 'div',
333  [ 'class' => 'apihelp-block apihelp-flags' ] );
334  $msg = $context->msg( 'api-help-flags' );
335  if ( !$msg->isDisabled() ) {
336  $help['flags'] .= self::wrap(
337  $msg->numParams( count( $flags ) ), 'apihelp-block-head', 'div'
338  );
339  }
340  $help['flags'] .= Html::openElement( 'ul' );
341  foreach ( $flags as $flag ) {
342  $help['flags'] .= Html::rawElement( 'li', null,
343  self::wrap( $context->msg( "api-help-flag-$flag" ), "apihelp-flag-$flag" )
344  );
345  }
346  $sourceInfo = $module->getModuleSourceInfo();
347  if ( $sourceInfo ) {
348  if ( isset( $sourceInfo['namemsg'] ) ) {
349  $extname = $context->msg( $sourceInfo['namemsg'] )->text();
350  } else {
351  $extname = $sourceInfo['name'];
352  }
353  $help['flags'] .= Html::rawElement( 'li', null,
354  self::wrap(
355  $context->msg( 'api-help-source', $extname, $sourceInfo['name'] ),
356  'apihelp-source'
357  )
358  );
359 
360  $link = SpecialPage::getTitleFor( 'Version', 'License/' . $sourceInfo['name'] );
361  if ( isset( $sourceInfo['license-name'] ) ) {
362  $msg = $context->msg( 'api-help-license', $link, $sourceInfo['license-name'] );
363  } elseif ( SpecialVersion::getExtLicenseFileName( dirname( $sourceInfo['path'] ) ) ) {
364  $msg = $context->msg( 'api-help-license-noname', $link );
365  } else {
366  $msg = $context->msg( 'api-help-license-unknown' );
367  }
368  $help['flags'] .= Html::rawElement( 'li', null,
369  self::wrap( $msg, 'apihelp-license' )
370  );
371  } else {
372  $help['flags'] .= Html::rawElement( 'li', null,
373  self::wrap( $context->msg( 'api-help-source-unknown' ), 'apihelp-source' )
374  );
375  $help['flags'] .= Html::rawElement( 'li', null,
376  self::wrap( $context->msg( 'api-help-license-unknown' ), 'apihelp-license' )
377  );
378  }
379  $help['flags'] .= Html::closeElement( 'ul' );
380  $help['flags'] .= Html::closeElement( 'div' );
381 
382  foreach ( $module->getFinalDescription() as $msg ) {
383  $msg->setContext( $context );
384  $help['description'] .= $msg->parseAsBlock();
385  }
386 
387  $urls = $module->getHelpUrls();
388  if ( $urls ) {
389  $help['help-urls'] .= Html::openElement( 'div',
390  [ 'class' => 'apihelp-block apihelp-help-urls' ]
391  );
392  $msg = $context->msg( 'api-help-help-urls' );
393  if ( !$msg->isDisabled() ) {
394  $help['help-urls'] .= self::wrap(
395  $msg->numParams( count( $urls ) ), 'apihelp-block-head', 'div'
396  );
397  }
398  if ( !is_array( $urls ) ) {
399  $urls = [ $urls ];
400  }
401  $help['help-urls'] .= Html::openElement( 'ul' );
402  foreach ( $urls as $url ) {
403  $help['help-urls'] .= Html::rawElement( 'li', null,
404  Html::element( 'a', [ 'href' => $url ], $url )
405  );
406  }
407  $help['help-urls'] .= Html::closeElement( 'ul' );
408  $help['help-urls'] .= Html::closeElement( 'div' );
409  }
410 
411  $params = $module->getFinalParams( ApiBase::GET_VALUES_FOR_HELP );
412  $dynamicParams = $module->dynamicParameterDocumentation();
413  $groups = [];
414  if ( $params || $dynamicParams !== null ) {
415  $help['parameters'] .= Html::openElement( 'div',
416  [ 'class' => 'apihelp-block apihelp-parameters' ]
417  );
418  $msg = $context->msg( 'api-help-parameters' );
419  if ( !$msg->isDisabled() ) {
420  $help['parameters'] .= self::wrap(
421  $msg->numParams( count( $params ) ), 'apihelp-block-head', 'div'
422  );
423  }
424  $help['parameters'] .= Html::openElement( 'dl' );
425 
426  $descriptions = $module->getFinalParamDescription();
427 
428  foreach ( $params as $name => $settings ) {
429  if ( !is_array( $settings ) ) {
430  $settings = [ ApiBase::PARAM_DFLT => $settings ];
431  }
432 
433  $help['parameters'] .= Html::element( 'dt', null,
434  $module->encodeParamName( $name ) );
435 
436  // Add description
437  $description = [];
438  if ( isset( $descriptions[$name] ) ) {
439  foreach ( $descriptions[$name] as $msg ) {
440  $msg->setContext( $context );
441  $description[] = $msg->parseAsBlock();
442  }
443  }
444 
445  // Add usage info
446  $info = [];
447 
448  // Required?
449  if ( !empty( $settings[ApiBase::PARAM_REQUIRED] ) ) {
450  $info[] = $context->msg( 'api-help-param-required' )->parse();
451  }
452 
453  // Custom info?
454  if ( !empty( $settings[ApiBase::PARAM_HELP_MSG_INFO] ) ) {
455  foreach ( $settings[ApiBase::PARAM_HELP_MSG_INFO] as $i ) {
456  $tag = array_shift( $i );
457  $info[] = $context->msg( "apihelp-{$path}-paraminfo-{$tag}" )
458  ->numParams( count( $i ) )
459  ->params( $context->getLanguage()->commaList( $i ) )
460  ->params( $module->getModulePrefix() )
461  ->parse();
462  }
463  }
464 
465  // Type documentation
466  if ( !isset( $settings[ApiBase::PARAM_TYPE] ) ) {
467  $dflt = isset( $settings[ApiBase::PARAM_DFLT] )
468  ? $settings[ApiBase::PARAM_DFLT]
469  : null;
470  if ( is_bool( $dflt ) ) {
471  $settings[ApiBase::PARAM_TYPE] = 'boolean';
472  } elseif ( is_string( $dflt ) || is_null( $dflt ) ) {
473  $settings[ApiBase::PARAM_TYPE] = 'string';
474  } elseif ( is_int( $dflt ) ) {
475  $settings[ApiBase::PARAM_TYPE] = 'integer';
476  }
477  }
478  if ( isset( $settings[ApiBase::PARAM_TYPE] ) ) {
479  $type = $settings[ApiBase::PARAM_TYPE];
480  $multi = !empty( $settings[ApiBase::PARAM_ISMULTI] );
481  $hintPipeSeparated = true;
483 
484  if ( is_array( $type ) ) {
485  $count = count( $type );
486  $links = isset( $settings[ApiBase::PARAM_VALUE_LINKS] )
487  ? $settings[ApiBase::PARAM_VALUE_LINKS]
488  : [];
489  $type = array_map( function ( $v ) use ( $links ) {
490  $ret = wfEscapeWikiText( $v );
491  if ( isset( $links[$v] ) ) {
492  $ret = "[[{$links[$v]}|$ret]]";
493  }
494  return $ret;
495  }, $type );
496  $i = array_search( '', $type, true );
497  if ( $i === false ) {
498  $type = $context->getLanguage()->commaList( $type );
499  } else {
500  unset( $type[$i] );
501  $type = $context->msg( 'api-help-param-list-can-be-empty' )
502  ->numParams( count( $type ) )
503  ->params( $context->getLanguage()->commaList( $type ) )
504  ->parse();
505  }
506  $info[] = $context->msg( 'api-help-param-list' )
507  ->params( $multi ? 2 : 1 )
508  ->params( $type )
509  ->parse();
510  $hintPipeSeparated = false;
511  } else {
512  switch ( $type ) {
513  case 'submodule':
514  $groups[] = $name;
515  if ( isset( $settings[ApiBase::PARAM_SUBMODULE_MAP] ) ) {
516  $map = $settings[ApiBase::PARAM_SUBMODULE_MAP];
517  ksort( $map );
518  $submodules = [];
519  foreach ( $map as $v => $m ) {
520  $submodules[] = "[[Special:ApiHelp/{$m}|{$v}]]";
521  }
522  } else {
523  $submodules = $module->getModuleManager()->getNames( $name );
524  sort( $submodules );
525  $prefix = $module->isMain()
526  ? '' : ( $module->getModulePath() . '+' );
527  $submodules = array_map( function ( $name ) use ( $prefix ) {
528  return "[[Special:ApiHelp/{$prefix}{$name}|{$name}]]";
529  }, $submodules );
530  }
531  $count = count( $submodules );
532  $info[] = $context->msg( 'api-help-param-list' )
533  ->params( $multi ? 2 : 1 )
534  ->params( $context->getLanguage()->commaList( $submodules ) )
535  ->parse();
536  $hintPipeSeparated = false;
537  // No type message necessary, we have a list of values.
538  $type = null;
539  break;
540 
541  case 'namespace':
543  $count = count( $namespaces );
544  $info[] = $context->msg( 'api-help-param-list' )
545  ->params( $multi ? 2 : 1 )
546  ->params( $context->getLanguage()->commaList( $namespaces ) )
547  ->parse();
548  $hintPipeSeparated = false;
549  // No type message necessary, we have a list of values.
550  $type = null;
551  break;
552 
553  case 'tags':
555  $count = count( $tags );
556  $info[] = $context->msg( 'api-help-param-list' )
557  ->params( $multi ? 2 : 1 )
558  ->params( $context->getLanguage()->commaList( $tags ) )
559  ->parse();
560  $hintPipeSeparated = false;
561  $type = null;
562  break;
563 
564  case 'limit':
565  if ( isset( $settings[ApiBase::PARAM_MAX2] ) ) {
566  $info[] = $context->msg( 'api-help-param-limit2' )
567  ->numParams( $settings[ApiBase::PARAM_MAX] )
568  ->numParams( $settings[ApiBase::PARAM_MAX2] )
569  ->parse();
570  } else {
571  $info[] = $context->msg( 'api-help-param-limit' )
572  ->numParams( $settings[ApiBase::PARAM_MAX] )
573  ->parse();
574  }
575  break;
576 
577  case 'integer':
578  // Possible messages:
579  // api-help-param-integer-min,
580  // api-help-param-integer-max,
581  // api-help-param-integer-minmax
582  $suffix = '';
583  $min = $max = 0;
584  if ( isset( $settings[ApiBase::PARAM_MIN] ) ) {
585  $suffix .= 'min';
586  $min = $settings[ApiBase::PARAM_MIN];
587  }
588  if ( isset( $settings[ApiBase::PARAM_MAX] ) ) {
589  $suffix .= 'max';
590  $max = $settings[ApiBase::PARAM_MAX];
591  }
592  if ( $suffix !== '' ) {
593  $info[] =
594  $context->msg( "api-help-param-integer-$suffix" )
595  ->params( $multi ? 2 : 1 )
596  ->numParams( $min, $max )
597  ->parse();
598  }
599  break;
600 
601  case 'upload':
602  $info[] = $context->msg( 'api-help-param-upload' )
603  ->parse();
604  // No type message necessary, api-help-param-upload should handle it.
605  $type = null;
606  break;
607 
608  case 'string':
609  case 'text':
610  // Displaying a type message here would be useless.
611  $type = null;
612  break;
613  }
614  }
615 
616  // Add type. Messages for grep: api-help-param-type-limit
617  // api-help-param-type-integer api-help-param-type-boolean
618  // api-help-param-type-timestamp api-help-param-type-user
619  // api-help-param-type-password
620  if ( is_string( $type ) ) {
621  $msg = $context->msg( "api-help-param-type-$type" );
622  if ( !$msg->isDisabled() ) {
623  $info[] = $msg->params( $multi ? 2 : 1 )->parse();
624  }
625  }
626 
627  if ( $multi ) {
628  $extra = [];
629  if ( $hintPipeSeparated ) {
630  $extra[] = $context->msg( 'api-help-param-multi-separate' )->parse();
631  }
632  if ( $count > ApiBase::LIMIT_SML1 ) {
633  $extra[] = $context->msg( 'api-help-param-multi-max' )
635  ->parse();
636  }
637  if ( $extra ) {
638  $info[] = implode( ' ', $extra );
639  }
640  }
641  }
642 
643  // Add default
644  $default = isset( $settings[ApiBase::PARAM_DFLT] )
645  ? $settings[ApiBase::PARAM_DFLT]
646  : null;
647  if ( $default === '' ) {
648  $info[] = $context->msg( 'api-help-param-default-empty' )
649  ->parse();
650  } elseif ( $default !== null && $default !== false ) {
651  $info[] = $context->msg( 'api-help-param-default' )
652  ->params( wfEscapeWikiText( $default ) )
653  ->parse();
654  }
655 
656  if ( !array_filter( $description ) ) {
657  $description = [ self::wrap(
658  $context->msg( 'api-help-param-no-description' ),
659  'apihelp-empty'
660  ) ];
661  }
662 
663  // Add "deprecated" flag
664  if ( !empty( $settings[ApiBase::PARAM_DEPRECATED] ) ) {
665  $help['parameters'] .= Html::openElement( 'dd',
666  [ 'class' => 'info' ] );
667  $help['parameters'] .= self::wrap(
668  $context->msg( 'api-help-param-deprecated' ),
669  'apihelp-deprecated', 'strong'
670  );
671  $help['parameters'] .= Html::closeElement( 'dd' );
672  }
673 
674  if ( $description ) {
675  $description = implode( '', $description );
676  $description = preg_replace( '!\s*</([oud]l)>\s*<\1>\s*!', "\n", $description );
677  $help['parameters'] .= Html::rawElement( 'dd',
678  [ 'class' => 'description' ], $description );
679  }
680 
681  foreach ( $info as $i ) {
682  $help['parameters'] .= Html::rawElement( 'dd', [ 'class' => 'info' ], $i );
683  }
684  }
685 
686  if ( $dynamicParams !== null ) {
687  $dynamicParams = ApiBase::makeMessage( $dynamicParams, $context, [
688  $module->getModulePrefix(),
689  $module->getModuleName(),
690  $module->getModulePath()
691  ] );
692  $help['parameters'] .= Html::element( 'dt', null, '*' );
693  $help['parameters'] .= Html::rawElement( 'dd',
694  [ 'class' => 'description' ], $dynamicParams->parse() );
695  }
696 
697  $help['parameters'] .= Html::closeElement( 'dl' );
698  $help['parameters'] .= Html::closeElement( 'div' );
699  }
700 
701  $examples = $module->getExamplesMessages();
702  if ( $examples ) {
703  $help['examples'] .= Html::openElement( 'div',
704  [ 'class' => 'apihelp-block apihelp-examples' ] );
705  $msg = $context->msg( 'api-help-examples' );
706  if ( !$msg->isDisabled() ) {
707  $help['examples'] .= self::wrap(
708  $msg->numParams( count( $examples ) ), 'apihelp-block-head', 'div'
709  );
710  }
711 
712  $help['examples'] .= Html::openElement( 'dl' );
713  foreach ( $examples as $qs => $msg ) {
714  $msg = ApiBase::makeMessage( $msg, $context, [
715  $module->getModulePrefix(),
716  $module->getModuleName(),
717  $module->getModulePath()
718  ] );
719 
720  $link = wfAppendQuery( wfScript( 'api' ), $qs );
721  $sandbox = SpecialPage::getTitleFor( 'ApiSandbox' )->getLocalURL() . '#' . $qs;
722  $help['examples'] .= Html::rawElement( 'dt', null, $msg->parse() );
723  $help['examples'] .= Html::rawElement( 'dd', null,
724  Html::element( 'a', [ 'href' => $link ], "api.php?$qs" ) . ' ' .
725  Html::rawElement( 'a', [ 'href' => $sandbox ],
726  $context->msg( 'api-help-open-in-apisandbox' )->parse() )
727  );
728  }
729  $help['examples'] .= Html::closeElement( 'dl' );
730  $help['examples'] .= Html::closeElement( 'div' );
731  }
732 
733  $subtocnumber = $tocnumber;
734  $subtocnumber[$level + 1] = 0;
735  $suboptions = [
736  'submodules' => $options['recursivesubmodules'],
737  'headerlevel' => $level + 1,
738  'tocnumber' => &$subtocnumber,
739  'noheader' => false,
740  ] + $options;
741 
742  if ( $options['submodules'] && $module->getModuleManager() ) {
743  $manager = $module->getModuleManager();
744  $submodules = [];
745  foreach ( $groups as $group ) {
746  $names = $manager->getNames( $group );
747  sort( $names );
748  foreach ( $names as $name ) {
749  $submodules[] = $manager->getModule( $name );
750  }
751  }
752  $help['submodules'] .= self::getHelpInternal(
753  $context,
754  $submodules,
755  $suboptions,
756  $haveModules
757  );
758  }
759 
760  $module->modifyHelp( $help, $suboptions, $haveModules );
761 
762  Hooks::run( 'APIHelpModifyOutput', [ $module, &$help, $suboptions, &$haveModules ] );
763 
764  $out .= implode( "\n", $help );
765  }
766 
767  return $out;
768  }
769 
770  public function shouldCheckMaxlag() {
771  return false;
772  }
773 
774  public function isReadMode() {
775  return false;
776  }
777 
778  public function getCustomPrinter() {
779  $params = $this->extractRequestParams();
780  if ( $params['wrap'] ) {
781  return null;
782  }
783 
784  $main = $this->getMain();
785  $errorPrinter = $main->createPrinterByName( $main->getParameter( 'format' ) );
786  return new ApiFormatRaw( $main, $errorPrinter );
787  }
788 
789  public function getAllowedParams() {
790  return [
791  'modules' => [
792  ApiBase::PARAM_DFLT => 'main',
793  ApiBase::PARAM_ISMULTI => true,
794  ],
795  'submodules' => false,
796  'recursivesubmodules' => false,
797  'wrap' => false,
798  'toc' => false,
799  ];
800  }
801 
802  protected function getExamplesMessages() {
803  return [
804  'action=help'
805  => 'apihelp-help-example-main',
806  'action=help&modules=query&submodules=1'
807  => 'apihelp-help-example-submodules',
808  'action=help&recursivesubmodules=1'
809  => 'apihelp-help-example-recursive',
810  'action=help&modules=help'
811  => 'apihelp-help-example-help',
812  'action=help&modules=query+info|query+categorymembers'
813  => 'apihelp-help-example-query',
814  ];
815  }
816 
817  public function getHelpUrls() {
818  return [
819  'https://www.mediawiki.org/wiki/API:Main_page',
820  'https://www.mediawiki.org/wiki/API:FAQ',
821  'https://www.mediawiki.org/wiki/API:Quick_start_guide',
822  ];
823  }
824 }
static generateTOC($tree, $lang=false)
Generate a table of contents from a section tree.
Definition: Linker.php:1762
const PARAM_VALUE_LINKS
(string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles whic...
Definition: ApiBase.php:149
static closeElement($element)
Returns "".
Definition: Html.php:306
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
static getMainWANInstance()
Get the main WAN cache object.
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 just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1798
Interface for objects which can provide a MediaWiki context on request.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:762
the array() calling protocol came about after MediaWiki 1.4rc1.
getResult()
Get the result object.
Definition: ApiBase.php:577
getLanguage()
Get the Language object.
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name.
Definition: SpecialPage.php:75
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:1798
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
getMain()
Get the main module.
Definition: ApiBase.php:473
msg()
Get a Message object with context set.
const GET_VALUES_FOR_HELP
getAllowedParams() flag: When set, the result could take longer to generate, but should be more thoro...
Definition: ApiBase.php:190
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:210
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:91
An IContextSource implementation which will inherit context from another source but allow individual ...
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:112
Formatter that spits out anything you like with any desired MIME type.
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:142
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
static makeMessage($msg, IContextSource $context, array $params=null)
Create a Message from a string or array.
Definition: ApiBase.php:1418
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2548
static fixHelpLinks($html, $helptitle=null, $localModules=[])
Replace Special:ApiHelp links with links to api.php.
Definition: ApiHelp.php:170
static listExplicitlyDefinedTags()
Lists tags explicitly defined in the valid_tag table of the database.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:277
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
getHelpUrls()
Definition: ApiHelp.php:817
IContextSource $context
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. '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 '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. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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':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:1796
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
Definition: hooks.txt:2581
getConfig()
Get the site configuration.
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:248
wfEscapeWikiText($text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
wfAppendQuery($url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
getExamplesMessages()
Definition: ApiHelp.php:802
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1004
getModulePath()
Get the path to this module.
Definition: ApiBase.php:521
const LIMIT_SML2
Slow query, apihighlimits limit.
Definition: ApiBase.php:183
isReadMode()
Definition: ApiHelp.php:774
const PARAM_SUBMODULE_MAP
(string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths.
Definition: ApiBase.php:165
getContext()
Get the base IContextSource object.
$cache
Definition: mcc.php:33
$params
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:41
static getExtLicenseFileName($extDir)
Obtains the full path of an extensions copying or license file if one exists.
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Definition: ApiResult.php:56
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
static getHelp(IContextSource $context, $modules, array $options)
Generate help for the specified modules.
Definition: ApiHelp.php:95
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books $tag
Definition: hooks.txt:965
$help
Definition: mcc.php:32
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
getLanguage()
Get the Language object.
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:912
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
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:42
parse()
Fully parse the text from wikitext to HTML.
Definition: Message.php:878
static wrap(Message $msg, $class, $tag= 'span')
Wrap a message in HTML with a class.
Definition: ApiHelp.php:209
getAllowedParams()
Definition: ApiHelp.php:789
static setSubelementsList(array &$arr, $names)
Causes the elements with the specified names to be output as subelements rather than attributes...
Definition: ApiResult.php:567
const LIMIT_SML1
Slow query, standard limit.
Definition: ApiBase.php:181
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
shouldCheckMaxlag()
Definition: ApiHelp.php:770
getCustomPrinter()
Definition: ApiHelp.php:778
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
execute()
Definition: ApiHelp.php:36
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
$count
wfMemcKey()
Make a cache key for the local wiki.
getOutput()
Get the OutputPage object.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:106
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
Class to output help for an API module.
Definition: ApiHelp.php:35
static getVersion($flags= '', $lang=null)
Return a string of the MediaWiki version with Git revision if available.
static getValidNamespaces()
Returns an array of the namespaces (by integer id) that exist on the wiki.
static getDefaultInstance()
Definition: SkinFactory.php:50
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:230
static getHelpInternal(IContextSource $context, array $modules, array $options, &$haveModules)
Recursively-called function to actually construct the help.
Definition: ApiHelp.php:224
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2338
getModuleFromPath($path)
Get a module from its module path.
Definition: ApiBase.php:539
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310