MediaWiki  1.28.0
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( [
104  'mediawiki.hlist',
105  'mediawiki.apihelp',
106  ] );
107  if ( !empty( $options['toc'] ) ) {
108  $out->addModules( 'mediawiki.toc' );
109  }
110  $out->setPageTitle( $context->msg( 'api-help-title' ) );
111 
113  $cacheKey = null;
114  if ( count( $modules ) == 1 && $modules[0] instanceof ApiMain &&
115  $options['recursivesubmodules'] && $context->getLanguage() === $wgContLang
116  ) {
117  $cacheHelpTimeout = $context->getConfig()->get( 'APICacheHelpTimeout' );
118  if ( $cacheHelpTimeout > 0 ) {
119  // Get help text from cache if present
120  $cacheKey = wfMemcKey( 'apihelp', $modules[0]->getModulePath(),
121  (int)!empty( $options['toc'] ),
122  str_replace( ' ', '_', SpecialVersion::getVersion( 'nodb' ) ) );
123  $cached = $cache->get( $cacheKey );
124  if ( $cached ) {
125  $out->addHTML( $cached );
126  return;
127  }
128  }
129  }
130  if ( $out->getHTML() !== '' ) {
131  // Don't save to cache, there's someone else's content in the page
132  // already
133  $cacheKey = null;
134  }
135 
136  $options['recursivesubmodules'] = !empty( $options['recursivesubmodules'] );
137  $options['submodules'] = $options['recursivesubmodules'] || !empty( $options['submodules'] );
138 
139  // Prepend lead
140  if ( empty( $options['nolead'] ) ) {
141  $msg = $context->msg( 'api-help-lead' );
142  if ( !$msg->isDisabled() ) {
143  $out->addHTML( $msg->parseAsBlock() );
144  }
145  }
146 
147  $haveModules = [];
148  $html = self::getHelpInternal( $context, $modules, $options, $haveModules );
149  if ( !empty( $options['toc'] ) && $haveModules ) {
150  $out->addHTML( Linker::generateTOC( $haveModules, $context->getLanguage() ) );
151  }
152  $out->addHTML( $html );
153 
154  $helptitle = isset( $options['helptitle'] ) ? $options['helptitle'] : null;
155  $html = self::fixHelpLinks( $out->getHTML(), $helptitle, $haveModules );
156  $out->clearHTML();
157  $out->addHTML( $html );
158 
159  if ( $cacheKey !== null ) {
160  $cache->set( $cacheKey, $out->getHTML(), $cacheHelpTimeout );
161  }
162  }
163 
172  public static function fixHelpLinks( $html, $helptitle = null, $localModules = [] ) {
173  $formatter = new HtmlFormatter( $html );
174  $doc = $formatter->getDoc();
175  $xpath = new DOMXPath( $doc );
176  $nodes = $xpath->query( '//a[@href][not(contains(@class,\'apihelp-linktrail\'))]' );
177  foreach ( $nodes as $node ) {
178  $href = $node->getAttribute( 'href' );
179  do {
180  $old = $href;
181  $href = rawurldecode( $href );
182  } while ( $old !== $href );
183  if ( preg_match( '!Special:ApiHelp/([^&/|#]+)((?:#.*)?)!', $href, $m ) ) {
184  if ( isset( $localModules[$m[1]] ) ) {
185  $href = $m[2] === '' ? '#' . $m[1] : $m[2];
186  } elseif ( $helptitle !== null ) {
187  $href = Title::newFromText( str_replace( '$1', $m[1], $helptitle ) . $m[2] )
188  ->getFullURL();
189  } else {
190  $href = wfAppendQuery( wfScript( 'api' ), [
191  'action' => 'help',
192  'modules' => $m[1],
193  ] ) . $m[2];
194  }
195  $node->setAttribute( 'href', $href );
196  $node->removeAttribute( 'title' );
197  }
198  }
199 
200  return $formatter->getText();
201  }
202 
211  private static function wrap( Message $msg, $class, $tag = 'span' ) {
212  return Html::rawElement( $tag, [ 'class' => $class ],
213  $msg->parse()
214  );
215  }
216 
227  array $options, &$haveModules
228  ) {
229  $out = '';
230 
231  $level = empty( $options['headerlevel'] ) ? 2 : $options['headerlevel'];
232  if ( empty( $options['tocnumber'] ) ) {
233  $tocnumber = [ 2 => 0 ];
234  } else {
235  $tocnumber = &$options['tocnumber'];
236  }
237 
238  foreach ( $modules as $module ) {
239  $tocnumber[$level]++;
240  $path = $module->getModulePath();
241  $module->setContext( $context );
242  $help = [
243  'header' => '',
244  'flags' => '',
245  'description' => '',
246  'help-urls' => '',
247  'parameters' => '',
248  'examples' => '',
249  'submodules' => '',
250  ];
251 
252  if ( empty( $options['noheader'] ) || !empty( $options['toc'] ) ) {
253  $anchor = $path;
254  $i = 1;
255  while ( isset( $haveModules[$anchor] ) ) {
256  $anchor = $path . '|' . ++$i;
257  }
258 
259  if ( $module->isMain() ) {
260  $headerContent = $context->msg( 'api-help-main-header' )->parse();
261  $headerAttr = [
262  'class' => 'apihelp-header',
263  ];
264  } else {
265  $name = $module->getModuleName();
266  $headerContent = $module->getParent()->getModuleManager()->getModuleGroup( $name ) .
267  "=$name";
268  if ( $module->getModulePrefix() !== '' ) {
269  $headerContent .= ' ' .
270  $context->msg( 'parentheses', $module->getModulePrefix() )->parse();
271  }
272  // Module names are always in English and not localized,
273  // so English language and direction must be set explicitly,
274  // otherwise parentheses will get broken in RTL wikis
275  $headerAttr = [
276  'class' => 'apihelp-header apihelp-module-name',
277  'dir' => 'ltr',
278  'lang' => 'en',
279  ];
280  }
281 
282  $headerAttr['id'] = $anchor;
283 
284  $haveModules[$anchor] = [
285  'toclevel' => count( $tocnumber ),
286  'level' => $level,
287  'anchor' => $anchor,
288  'line' => $headerContent,
289  'number' => implode( '.', $tocnumber ),
290  'index' => false,
291  ];
292  if ( empty( $options['noheader'] ) ) {
293  $help['header'] .= Html::element(
294  'h' . min( 6, $level ),
295  $headerAttr,
296  $headerContent
297  );
298  }
299  } else {
300  $haveModules[$path] = true;
301  }
302 
303  $links = [];
304  $any = false;
305  for ( $m = $module; $m !== null; $m = $m->getParent() ) {
306  $name = $m->getModuleName();
307  if ( $name === 'main_int' ) {
308  $name = 'main';
309  }
310 
311  if ( count( $modules ) === 1 && $m === $modules[0] &&
312  !( !empty( $options['submodules'] ) && $m->getModuleManager() )
313  ) {
314  $link = Html::element( 'b', [ 'dir' => 'ltr', 'lang' => 'en' ], $name );
315  } else {
316  $link = SpecialPage::getTitleFor( 'ApiHelp', $m->getModulePath() )->getLocalURL();
317  $link = Html::element( 'a',
318  [ 'href' => $link, 'class' => 'apihelp-linktrail', 'dir' => 'ltr', 'lang' => 'en' ],
319  $name
320  );
321  $any = true;
322  }
323  array_unshift( $links, $link );
324  }
325  if ( $any ) {
326  $help['header'] .= self::wrap(
327  $context->msg( 'parentheses' )
328  ->rawParams( $context->getLanguage()->pipeList( $links ) ),
329  'apihelp-linktrail', 'div'
330  );
331  }
332 
333  $flags = $module->getHelpFlags();
334  $help['flags'] .= Html::openElement( 'div',
335  [ 'class' => 'apihelp-block apihelp-flags' ] );
336  $msg = $context->msg( 'api-help-flags' );
337  if ( !$msg->isDisabled() ) {
338  $help['flags'] .= self::wrap(
339  $msg->numParams( count( $flags ) ), 'apihelp-block-head', 'div'
340  );
341  }
342  $help['flags'] .= Html::openElement( 'ul' );
343  foreach ( $flags as $flag ) {
344  $help['flags'] .= Html::rawElement( 'li', null,
345  self::wrap( $context->msg( "api-help-flag-$flag" ), "apihelp-flag-$flag" )
346  );
347  }
348  $sourceInfo = $module->getModuleSourceInfo();
349  if ( $sourceInfo ) {
350  if ( isset( $sourceInfo['namemsg'] ) ) {
351  $extname = $context->msg( $sourceInfo['namemsg'] )->text();
352  } else {
353  // Probably English, so wrap it.
354  $extname = Html::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $sourceInfo['name'] );
355  }
356  $help['flags'] .= Html::rawElement( 'li', null,
357  self::wrap(
358  $context->msg( 'api-help-source', $extname, $sourceInfo['name'] ),
359  'apihelp-source'
360  )
361  );
362 
363  $link = SpecialPage::getTitleFor( 'Version', 'License/' . $sourceInfo['name'] );
364  if ( isset( $sourceInfo['license-name'] ) ) {
365  $msg = $context->msg( 'api-help-license', $link,
366  Html::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $sourceInfo['license-name'] )
367  );
368  } elseif ( SpecialVersion::getExtLicenseFileName( dirname( $sourceInfo['path'] ) ) ) {
369  $msg = $context->msg( 'api-help-license-noname', $link );
370  } else {
371  $msg = $context->msg( 'api-help-license-unknown' );
372  }
373  $help['flags'] .= Html::rawElement( 'li', null,
374  self::wrap( $msg, 'apihelp-license' )
375  );
376  } else {
377  $help['flags'] .= Html::rawElement( 'li', null,
378  self::wrap( $context->msg( 'api-help-source-unknown' ), 'apihelp-source' )
379  );
380  $help['flags'] .= Html::rawElement( 'li', null,
381  self::wrap( $context->msg( 'api-help-license-unknown' ), 'apihelp-license' )
382  );
383  }
384  $help['flags'] .= Html::closeElement( 'ul' );
385  $help['flags'] .= Html::closeElement( 'div' );
386 
387  foreach ( $module->getFinalDescription() as $msg ) {
388  $msg->setContext( $context );
389  $help['description'] .= $msg->parseAsBlock();
390  }
391 
392  $urls = $module->getHelpUrls();
393  if ( $urls ) {
394  $help['help-urls'] .= Html::openElement( 'div',
395  [ 'class' => 'apihelp-block apihelp-help-urls' ]
396  );
397  $msg = $context->msg( 'api-help-help-urls' );
398  if ( !$msg->isDisabled() ) {
399  $help['help-urls'] .= self::wrap(
400  $msg->numParams( count( $urls ) ), 'apihelp-block-head', 'div'
401  );
402  }
403  if ( !is_array( $urls ) ) {
404  $urls = [ $urls ];
405  }
406  $help['help-urls'] .= Html::openElement( 'ul' );
407  foreach ( $urls as $url ) {
408  $help['help-urls'] .= Html::rawElement( 'li', null,
409  Html::element( 'a', [ 'href' => $url, 'dir' => 'ltr' ], $url )
410  );
411  }
412  $help['help-urls'] .= Html::closeElement( 'ul' );
413  $help['help-urls'] .= Html::closeElement( 'div' );
414  }
415 
416  $params = $module->getFinalParams( ApiBase::GET_VALUES_FOR_HELP );
417  $dynamicParams = $module->dynamicParameterDocumentation();
418  $groups = [];
419  if ( $params || $dynamicParams !== null ) {
420  $help['parameters'] .= Html::openElement( 'div',
421  [ 'class' => 'apihelp-block apihelp-parameters' ]
422  );
423  $msg = $context->msg( 'api-help-parameters' );
424  if ( !$msg->isDisabled() ) {
425  $help['parameters'] .= self::wrap(
426  $msg->numParams( count( $params ) ), 'apihelp-block-head', 'div'
427  );
428  }
429  $help['parameters'] .= Html::openElement( 'dl' );
430 
431  $descriptions = $module->getFinalParamDescription();
432 
433  foreach ( $params as $name => $settings ) {
434  if ( !is_array( $settings ) ) {
435  $settings = [ ApiBase::PARAM_DFLT => $settings ];
436  }
437 
438  $help['parameters'] .= Html::rawElement( 'dt', null,
439  Html::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $module->encodeParamName( $name ) )
440  );
441 
442  // Add description
443  $description = [];
444  if ( isset( $descriptions[$name] ) ) {
445  foreach ( $descriptions[$name] as $msg ) {
446  $msg->setContext( $context );
447  $description[] = $msg->parseAsBlock();
448  }
449  }
450 
451  // Add usage info
452  $info = [];
453 
454  // Required?
455  if ( !empty( $settings[ApiBase::PARAM_REQUIRED] ) ) {
456  $info[] = $context->msg( 'api-help-param-required' )->parse();
457  }
458 
459  // Custom info?
460  if ( !empty( $settings[ApiBase::PARAM_HELP_MSG_INFO] ) ) {
461  foreach ( $settings[ApiBase::PARAM_HELP_MSG_INFO] as $i ) {
462  $tag = array_shift( $i );
463  $info[] = $context->msg( "apihelp-{$path}-paraminfo-{$tag}" )
464  ->numParams( count( $i ) )
465  ->params( $context->getLanguage()->commaList( $i ) )
466  ->params( $module->getModulePrefix() )
467  ->parse();
468  }
469  }
470 
471  // Type documentation
472  if ( !isset( $settings[ApiBase::PARAM_TYPE] ) ) {
473  $dflt = isset( $settings[ApiBase::PARAM_DFLT] )
474  ? $settings[ApiBase::PARAM_DFLT]
475  : null;
476  if ( is_bool( $dflt ) ) {
477  $settings[ApiBase::PARAM_TYPE] = 'boolean';
478  } elseif ( is_string( $dflt ) || is_null( $dflt ) ) {
479  $settings[ApiBase::PARAM_TYPE] = 'string';
480  } elseif ( is_int( $dflt ) ) {
481  $settings[ApiBase::PARAM_TYPE] = 'integer';
482  }
483  }
484  if ( isset( $settings[ApiBase::PARAM_TYPE] ) ) {
485  $type = $settings[ApiBase::PARAM_TYPE];
486  $multi = !empty( $settings[ApiBase::PARAM_ISMULTI] );
487  $hintPipeSeparated = true;
489 
490  if ( is_array( $type ) ) {
491  $count = count( $type );
492  $links = isset( $settings[ApiBase::PARAM_VALUE_LINKS] )
493  ? $settings[ApiBase::PARAM_VALUE_LINKS]
494  : [];
495  $values = array_map( function ( $v ) use ( $links ) {
496  // We can't know whether this contains LTR or RTL text.
497  $ret = $v === '' ? $v : Html::element( 'span', [ 'dir' => 'auto' ], $v );
498  if ( isset( $links[$v] ) ) {
499  $ret = "[[{$links[$v]}|$ret]]";
500  }
501  return $ret;
502  }, $type );
503  $i = array_search( '', $type, true );
504  if ( $i === false ) {
505  $values = $context->getLanguage()->commaList( $values );
506  } else {
507  unset( $values[$i] );
508  $values = $context->msg( 'api-help-param-list-can-be-empty' )
509  ->numParams( count( $values ) )
510  ->params( $context->getLanguage()->commaList( $values ) )
511  ->parse();
512  }
513  $info[] = $context->msg( 'api-help-param-list' )
514  ->params( $multi ? 2 : 1 )
515  ->params( $values )
516  ->parse();
517  $hintPipeSeparated = false;
518  } else {
519  switch ( $type ) {
520  case 'submodule':
521  $groups[] = $name;
522  if ( isset( $settings[ApiBase::PARAM_SUBMODULE_MAP] ) ) {
523  $map = $settings[ApiBase::PARAM_SUBMODULE_MAP];
524  ksort( $map );
525  $submodules = [];
526  foreach ( $map as $v => $m ) {
527  $submodules[] = "[[Special:ApiHelp/{$m}|{$v}]]";
528  }
529  } else {
530  $submodules = $module->getModuleManager()->getNames( $name );
531  sort( $submodules );
532  $prefix = $module->isMain()
533  ? '' : ( $module->getModulePath() . '+' );
534  $submodules = array_map( function ( $name ) use ( $prefix ) {
535  $text = Html::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $name );
536  return "[[Special:ApiHelp/{$prefix}{$name}|{$text}]]";
537  }, $submodules );
538  }
539  $count = count( $submodules );
540  $info[] = $context->msg( 'api-help-param-list' )
541  ->params( $multi ? 2 : 1 )
542  ->params( $context->getLanguage()->commaList( $submodules ) )
543  ->parse();
544  $hintPipeSeparated = false;
545  // No type message necessary, we have a list of values.
546  $type = null;
547  break;
548 
549  case 'namespace':
551  $count = count( $namespaces );
552  $info[] = $context->msg( 'api-help-param-list' )
553  ->params( $multi ? 2 : 1 )
554  ->params( $context->getLanguage()->commaList( $namespaces ) )
555  ->parse();
556  $hintPipeSeparated = false;
557  // No type message necessary, we have a list of values.
558  $type = null;
559  break;
560 
561  case 'tags':
563  $count = count( $tags );
564  $info[] = $context->msg( 'api-help-param-list' )
565  ->params( $multi ? 2 : 1 )
566  ->params( $context->getLanguage()->commaList( $tags ) )
567  ->parse();
568  $hintPipeSeparated = false;
569  $type = null;
570  break;
571 
572  case 'limit':
573  if ( isset( $settings[ApiBase::PARAM_MAX2] ) ) {
574  $info[] = $context->msg( 'api-help-param-limit2' )
575  ->numParams( $settings[ApiBase::PARAM_MAX] )
576  ->numParams( $settings[ApiBase::PARAM_MAX2] )
577  ->parse();
578  } else {
579  $info[] = $context->msg( 'api-help-param-limit' )
580  ->numParams( $settings[ApiBase::PARAM_MAX] )
581  ->parse();
582  }
583  break;
584 
585  case 'integer':
586  // Possible messages:
587  // api-help-param-integer-min,
588  // api-help-param-integer-max,
589  // api-help-param-integer-minmax
590  $suffix = '';
591  $min = $max = 0;
592  if ( isset( $settings[ApiBase::PARAM_MIN] ) ) {
593  $suffix .= 'min';
594  $min = $settings[ApiBase::PARAM_MIN];
595  }
596  if ( isset( $settings[ApiBase::PARAM_MAX] ) ) {
597  $suffix .= 'max';
598  $max = $settings[ApiBase::PARAM_MAX];
599  }
600  if ( $suffix !== '' ) {
601  $info[] =
602  $context->msg( "api-help-param-integer-$suffix" )
603  ->params( $multi ? 2 : 1 )
604  ->numParams( $min, $max )
605  ->parse();
606  }
607  break;
608 
609  case 'upload':
610  $info[] = $context->msg( 'api-help-param-upload' )
611  ->parse();
612  // No type message necessary, api-help-param-upload should handle it.
613  $type = null;
614  break;
615 
616  case 'string':
617  case 'text':
618  // Displaying a type message here would be useless.
619  $type = null;
620  break;
621  }
622  }
623 
624  // Add type. Messages for grep: api-help-param-type-limit
625  // api-help-param-type-integer api-help-param-type-boolean
626  // api-help-param-type-timestamp api-help-param-type-user
627  // api-help-param-type-password
628  if ( is_string( $type ) ) {
629  $msg = $context->msg( "api-help-param-type-$type" );
630  if ( !$msg->isDisabled() ) {
631  $info[] = $msg->params( $multi ? 2 : 1 )->parse();
632  }
633  }
634 
635  if ( $multi ) {
636  $extra = [];
637  if ( $hintPipeSeparated ) {
638  $extra[] = $context->msg( 'api-help-param-multi-separate' )->parse();
639  }
640  if ( $count > ApiBase::LIMIT_SML1 ) {
641  $extra[] = $context->msg( 'api-help-param-multi-max' )
643  ->parse();
644  }
645  if ( $extra ) {
646  $info[] = implode( ' ', $extra );
647  }
648  }
649  }
650 
651  // Add default
652  $default = isset( $settings[ApiBase::PARAM_DFLT] )
653  ? $settings[ApiBase::PARAM_DFLT]
654  : null;
655  if ( $default === '' ) {
656  $info[] = $context->msg( 'api-help-param-default-empty' )
657  ->parse();
658  } elseif ( $default !== null && $default !== false ) {
659  // We can't know whether this contains LTR or RTL text.
660  $info[] = $context->msg( 'api-help-param-default' )
661  ->params( Html::element( 'span', [ 'dir' => 'auto' ], $default ) )
662  ->parse();
663  }
664 
665  if ( !array_filter( $description ) ) {
666  $description = [ self::wrap(
667  $context->msg( 'api-help-param-no-description' ),
668  'apihelp-empty'
669  ) ];
670  }
671 
672  // Add "deprecated" flag
673  if ( !empty( $settings[ApiBase::PARAM_DEPRECATED] ) ) {
674  $help['parameters'] .= Html::openElement( 'dd',
675  [ 'class' => 'info' ] );
676  $help['parameters'] .= self::wrap(
677  $context->msg( 'api-help-param-deprecated' ),
678  'apihelp-deprecated', 'strong'
679  );
680  $help['parameters'] .= Html::closeElement( 'dd' );
681  }
682 
683  if ( $description ) {
684  $description = implode( '', $description );
685  $description = preg_replace( '!\s*</([oud]l)>\s*<\1>\s*!', "\n", $description );
686  $help['parameters'] .= Html::rawElement( 'dd',
687  [ 'class' => 'description' ], $description );
688  }
689 
690  foreach ( $info as $i ) {
691  $help['parameters'] .= Html::rawElement( 'dd', [ 'class' => 'info' ], $i );
692  }
693  }
694 
695  if ( $dynamicParams !== null ) {
696  $dynamicParams = ApiBase::makeMessage( $dynamicParams, $context, [
697  $module->getModulePrefix(),
698  $module->getModuleName(),
699  $module->getModulePath()
700  ] );
701  $help['parameters'] .= Html::element( 'dt', null, '*' );
702  $help['parameters'] .= Html::rawElement( 'dd',
703  [ 'class' => 'description' ], $dynamicParams->parse() );
704  }
705 
706  $help['parameters'] .= Html::closeElement( 'dl' );
707  $help['parameters'] .= Html::closeElement( 'div' );
708  }
709 
710  $examples = $module->getExamplesMessages();
711  if ( $examples ) {
712  $help['examples'] .= Html::openElement( 'div',
713  [ 'class' => 'apihelp-block apihelp-examples' ] );
714  $msg = $context->msg( 'api-help-examples' );
715  if ( !$msg->isDisabled() ) {
716  $help['examples'] .= self::wrap(
717  $msg->numParams( count( $examples ) ), 'apihelp-block-head', 'div'
718  );
719  }
720 
721  $help['examples'] .= Html::openElement( 'dl' );
722  foreach ( $examples as $qs => $msg ) {
723  $msg = ApiBase::makeMessage( $msg, $context, [
724  $module->getModulePrefix(),
725  $module->getModuleName(),
726  $module->getModulePath()
727  ] );
728 
729  $link = wfAppendQuery( wfScript( 'api' ), $qs );
730  $sandbox = SpecialPage::getTitleFor( 'ApiSandbox' )->getLocalURL() . '#' . $qs;
731  $help['examples'] .= Html::rawElement( 'dt', null, $msg->parse() );
732  $help['examples'] .= Html::rawElement( 'dd', null,
733  Html::element( 'a', [ 'href' => $link, 'dir' => 'ltr' ], "api.php?$qs" ) . ' ' .
734  Html::rawElement( 'a', [ 'href' => $sandbox ],
735  $context->msg( 'api-help-open-in-apisandbox' )->parse() )
736  );
737  }
738  $help['examples'] .= Html::closeElement( 'dl' );
739  $help['examples'] .= Html::closeElement( 'div' );
740  }
741 
742  $subtocnumber = $tocnumber;
743  $subtocnumber[$level + 1] = 0;
744  $suboptions = [
745  'submodules' => $options['recursivesubmodules'],
746  'headerlevel' => $level + 1,
747  'tocnumber' => &$subtocnumber,
748  'noheader' => false,
749  ] + $options;
750 
751  if ( $options['submodules'] && $module->getModuleManager() ) {
752  $manager = $module->getModuleManager();
753  $submodules = [];
754  foreach ( $groups as $group ) {
755  $names = $manager->getNames( $group );
756  sort( $names );
757  foreach ( $names as $name ) {
758  $submodules[] = $manager->getModule( $name );
759  }
760  }
761  $help['submodules'] .= self::getHelpInternal(
762  $context,
763  $submodules,
764  $suboptions,
765  $haveModules
766  );
767  }
768 
769  $module->modifyHelp( $help, $suboptions, $haveModules );
770 
771  Hooks::run( 'APIHelpModifyOutput', [ $module, &$help, $suboptions, &$haveModules ] );
772 
773  $out .= implode( "\n", $help );
774  }
775 
776  return $out;
777  }
778 
779  public function shouldCheckMaxlag() {
780  return false;
781  }
782 
783  public function isReadMode() {
784  return false;
785  }
786 
787  public function getCustomPrinter() {
788  $params = $this->extractRequestParams();
789  if ( $params['wrap'] ) {
790  return null;
791  }
792 
793  $main = $this->getMain();
794  $errorPrinter = $main->createPrinterByName( $main->getParameter( 'format' ) );
795  return new ApiFormatRaw( $main, $errorPrinter );
796  }
797 
798  public function getAllowedParams() {
799  return [
800  'modules' => [
801  ApiBase::PARAM_DFLT => 'main',
802  ApiBase::PARAM_ISMULTI => true,
803  ],
804  'submodules' => false,
805  'recursivesubmodules' => false,
806  'wrap' => false,
807  'toc' => false,
808  ];
809  }
810 
811  protected function getExamplesMessages() {
812  return [
813  'action=help'
814  => 'apihelp-help-example-main',
815  'action=help&modules=query&submodules=1'
816  => 'apihelp-help-example-submodules',
817  'action=help&recursivesubmodules=1'
818  => 'apihelp-help-example-recursive',
819  'action=help&modules=help'
820  => 'apihelp-help-example-help',
821  'action=help&modules=query+info|query+categorymembers'
822  => 'apihelp-help-example-query',
823  ];
824  }
825 
826  public function getHelpUrls() {
827  return [
828  'https://www.mediawiki.org/wiki/API:Main_page',
829  'https://www.mediawiki.org/wiki/API:FAQ',
830  'https://www.mediawiki.org/wiki/API:Quick_start_guide',
831  ];
832  }
833 }
static generateTOC($tree, $lang=false)
Generate a table of contents from a section tree.
Definition: Linker.php:1663
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:305
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:1936
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:802
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...
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:1936
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 If you don't need a full Title object...
Definition: SpecialPage.php:82
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:209
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:1511
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
static fixHelpLinks($html, $helptitle=null, $localModules=[])
Replace Special:ApiHelp links with links to api.php.
Definition: ApiHelp.php:172
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:262
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:826
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':DEPRECATED!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:1934
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
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:247
$modules
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:811
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:1046
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:783
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:43
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:1007
$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:953
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:43
parse()
Fully parse the text from wikitext to HTML.
Definition: Message.php:888
static wrap(Message $msg, $class, $tag= 'span')
Wrap a message in HTML with a class.
Definition: ApiHelp.php:211
getAllowedParams()
Definition: ApiHelp.php:798
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:779
getCustomPrinter()
Definition: ApiHelp.php:787
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:229
static getHelpInternal(IContextSource $context, array $modules, array $options, &$haveModules)
Recursively-called function to actually construct the help.
Definition: ApiHelp.php:226
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:2491
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:300