3 * Copyright © 2014 Wikimedia Foundation and contributors
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use HtmlFormatter\HtmlFormatter
;
24 use MediaWiki\MediaWikiServices
;
27 * Class to output help for an API module
29 * @since 1.25 completely rewritten
32 class ApiHelp
extends ApiBase
{
33 public function execute() {
34 $params = $this->extractRequestParams();
37 foreach ( $params['modules'] as $path ) {
38 $modules[] = $this->getModuleFromPath( $path );
42 $context = new DerivativeContext( $this->getMain()->getContext() );
43 $context->setSkin( SkinFactory
::getDefaultInstance()->makeSkin( 'apioutput' ) );
44 $context->setLanguage( $this->getMain()->getLanguage() );
45 $context->setTitle( SpecialPage
::getTitleFor( 'ApiHelp' ) );
46 $out = new OutputPage( $context );
47 $out->setCopyrightUrl( 'https://www.mediawiki.org/wiki/Special:MyLanguage/Copyright' );
48 $context->setOutput( $out );
50 self
::getHelp( $context, $modules, $params );
52 // Grab the output from the skin
54 $context->getOutput()->output();
55 $html = ob_get_clean();
57 $result = $this->getResult();
58 if ( $params['wrap'] ) {
60 'mime' => 'text/html',
61 'filename' => 'api-help.html',
64 ApiResult
::setSubelementsList( $data, 'help' );
65 $result->addValue( null, $this->getModuleName(), $data );
68 $result->addValue( null, 'text', $html, ApiResult
::NO_SIZE_CHECK
);
69 $result->addValue( null, 'mime', 'text/html', ApiResult
::NO_SIZE_CHECK
);
70 $result->addValue( null, 'filename', 'api-help.html', ApiResult
::NO_SIZE_CHECK
);
75 * Generate help for the specified modules
77 * Help is placed into the OutputPage object returned by
78 * $context->getOutput().
80 * Recognized options include:
81 * - headerlevel: (int) Header tag level
82 * - nolead: (bool) Skip the inclusion of api-help-lead
83 * - noheader: (bool) Skip the inclusion of the top-level section headers
84 * - submodules: (bool) Include help for submodules of the current module
85 * - recursivesubmodules: (bool) Include help for submodules recursively
86 * - helptitle: (string) Title to link for additional modules' help. Should contain $1.
87 * - toc: (bool) Include a table of contents
89 * @param IContextSource $context
90 * @param ApiBase[]|ApiBase $modules
91 * @param array $options Formatting options (described above)
93 public static function getHelp( IContextSource
$context, $modules, array $options ) {
96 if ( !is_array( $modules ) ) {
97 $modules = [ $modules ];
100 $out = $context->getOutput();
101 $out->addModuleStyles( [
105 if ( !empty( $options['toc'] ) ) {
106 $out->addModules( 'mediawiki.toc' );
107 $out->addModuleStyles( 'mediawiki.toc.styles' );
109 $out->setPageTitle( $context->msg( 'api-help-title' ) );
111 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
113 if ( count( $modules ) == 1 && $modules[0] instanceof ApiMain
&&
114 $options['recursivesubmodules'] && $context->getLanguage() === $wgContLang
116 $cacheHelpTimeout = $context->getConfig()->get( 'APICacheHelpTimeout' );
117 if ( $cacheHelpTimeout > 0 ) {
118 // Get help text from cache if present
119 $cacheKey = $cache->makeKey( 'apihelp', $modules[0]->getModulePath(),
120 (int)!empty( $options['toc'] ),
121 str_replace( ' ', '_', SpecialVersion
::getVersion( 'nodb' ) ) );
122 $cached = $cache->get( $cacheKey );
124 $out->addHTML( $cached );
129 if ( $out->getHTML() !== '' ) {
130 // Don't save to cache, there's someone else's content in the page
135 $options['recursivesubmodules'] = !empty( $options['recursivesubmodules'] );
136 $options['submodules'] = $options['recursivesubmodules'] ||
!empty( $options['submodules'] );
139 if ( empty( $options['nolead'] ) ) {
140 $msg = $context->msg( 'api-help-lead' );
141 if ( !$msg->isDisabled() ) {
142 $out->addHTML( $msg->parseAsBlock() );
147 $html = self
::getHelpInternal( $context, $modules, $options, $haveModules );
148 if ( !empty( $options['toc'] ) && $haveModules ) {
149 $out->addHTML( Linker
::generateTOC( $haveModules, $context->getLanguage() ) );
151 $out->addHTML( $html );
153 $helptitle = isset( $options['helptitle'] ) ?
$options['helptitle'] : null;
154 $html = self
::fixHelpLinks( $out->getHTML(), $helptitle, $haveModules );
156 $out->addHTML( $html );
158 if ( $cacheKey !== null ) {
159 $cache->set( $cacheKey, $out->getHTML(), $cacheHelpTimeout );
164 * Replace Special:ApiHelp links with links to api.php
166 * @param string $html
167 * @param string|null $helptitle Title to link to rather than api.php, must contain '$1'
168 * @param array $localModules Keys are modules to link within the current page, values are ignored
171 public static function fixHelpLinks( $html, $helptitle = null, $localModules = [] ) {
172 $formatter = new HtmlFormatter( $html );
173 $doc = $formatter->getDoc();
174 $xpath = new DOMXPath( $doc );
175 $nodes = $xpath->query( '//a[@href][not(contains(@class,\'apihelp-linktrail\'))]' );
176 foreach ( $nodes as $node ) {
177 $href = $node->getAttribute( 'href' );
180 $href = rawurldecode( $href );
181 } while ( $old !== $href );
182 if ( preg_match( '!Special:ApiHelp/([^&/|#]+)((?:#.*)?)!', $href, $m ) ) {
183 if ( isset( $localModules[$m[1]] ) ) {
184 $href = $m[2] === '' ?
'#' . $m[1] : $m[2];
185 } elseif ( $helptitle !== null ) {
186 $href = Title
::newFromText( str_replace( '$1', $m[1], $helptitle ) . $m[2] )
189 $href = wfAppendQuery( wfScript( 'api' ), [
194 $node->setAttribute( 'href', $href );
195 $node->removeAttribute( 'title' );
199 return $formatter->getText();
203 * Wrap a message in HTML with a class.
205 * @param Message $msg
206 * @param string $class
210 private static function wrap( Message
$msg, $class, $tag = 'span' ) {
211 return Html
::rawElement( $tag, [ 'class' => $class ],
217 * Recursively-called function to actually construct the help
219 * @param IContextSource $context
220 * @param ApiBase[] $modules
221 * @param array $options
222 * @param array &$haveModules
225 private static function getHelpInternal( IContextSource
$context, array $modules,
226 array $options, &$haveModules
230 $level = empty( $options['headerlevel'] ) ?
2 : $options['headerlevel'];
231 if ( empty( $options['tocnumber'] ) ) {
232 $tocnumber = [ 2 => 0 ];
234 $tocnumber = &$options['tocnumber'];
237 foreach ( $modules as $module ) {
238 $tocnumber[$level]++
;
239 $path = $module->getModulePath();
240 $module->setContext( $context );
251 if ( empty( $options['noheader'] ) ||
!empty( $options['toc'] ) ) {
254 while ( isset( $haveModules[$anchor] ) ) {
255 $anchor = $path . '|' . ++
$i;
258 if ( $module->isMain() ) {
259 $headerContent = $context->msg( 'api-help-main-header' )->parse();
261 'class' => 'apihelp-header',
264 $name = $module->getModuleName();
265 $headerContent = $module->getParent()->getModuleManager()->getModuleGroup( $name ) .
267 if ( $module->getModulePrefix() !== '' ) {
268 $headerContent .= ' ' .
269 $context->msg( 'parentheses', $module->getModulePrefix() )->parse();
271 // Module names are always in English and not localized,
272 // so English language and direction must be set explicitly,
273 // otherwise parentheses will get broken in RTL wikis
275 'class' => 'apihelp-header apihelp-module-name',
281 $headerAttr['id'] = $anchor;
283 $haveModules[$anchor] = [
284 'toclevel' => count( $tocnumber ),
287 'line' => $headerContent,
288 'number' => implode( '.', $tocnumber ),
291 if ( empty( $options['noheader'] ) ) {
292 $help['header'] .= Html
::element(
293 'h' . min( 6, $level ),
299 $haveModules[$path] = true;
304 for ( $m = $module; $m !== null; $m = $m->getParent() ) {
305 $name = $m->getModuleName();
306 if ( $name === 'main_int' ) {
310 if ( count( $modules ) === 1 && $m === $modules[0] &&
311 !( !empty( $options['submodules'] ) && $m->getModuleManager() )
313 $link = Html
::element( 'b', [ 'dir' => 'ltr', 'lang' => 'en' ], $name );
315 $link = SpecialPage
::getTitleFor( 'ApiHelp', $m->getModulePath() )->getLocalURL();
316 $link = Html
::element( 'a',
317 [ 'href' => $link, 'class' => 'apihelp-linktrail', 'dir' => 'ltr', 'lang' => 'en' ],
322 array_unshift( $links, $link );
325 $help['header'] .= self
::wrap(
326 $context->msg( 'parentheses' )
327 ->rawParams( $context->getLanguage()->pipeList( $links ) ),
328 'apihelp-linktrail', 'div'
332 $flags = $module->getHelpFlags();
333 $help['flags'] .= Html
::openElement( 'div',
334 [ 'class' => 'apihelp-block apihelp-flags' ] );
335 $msg = $context->msg( 'api-help-flags' );
336 if ( !$msg->isDisabled() ) {
337 $help['flags'] .= self
::wrap(
338 $msg->numParams( count( $flags ) ), 'apihelp-block-head', 'div'
341 $help['flags'] .= Html
::openElement( 'ul' );
342 foreach ( $flags as $flag ) {
343 $help['flags'] .= Html
::rawElement( 'li', null,
344 self
::wrap( $context->msg( "api-help-flag-$flag" ), "apihelp-flag-$flag" )
347 $sourceInfo = $module->getModuleSourceInfo();
349 if ( isset( $sourceInfo['namemsg'] ) ) {
350 $extname = $context->msg( $sourceInfo['namemsg'] )->text();
352 // Probably English, so wrap it.
353 $extname = Html
::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $sourceInfo['name'] );
355 $help['flags'] .= Html
::rawElement( 'li', null,
357 $context->msg( 'api-help-source', $extname, $sourceInfo['name'] ),
362 $link = SpecialPage
::getTitleFor( 'Version', 'License/' . $sourceInfo['name'] );
363 if ( isset( $sourceInfo['license-name'] ) ) {
364 $msg = $context->msg( 'api-help-license', $link,
365 Html
::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $sourceInfo['license-name'] )
367 } elseif ( SpecialVersion
::getExtLicenseFileName( dirname( $sourceInfo['path'] ) ) ) {
368 $msg = $context->msg( 'api-help-license-noname', $link );
370 $msg = $context->msg( 'api-help-license-unknown' );
372 $help['flags'] .= Html
::rawElement( 'li', null,
373 self
::wrap( $msg, 'apihelp-license' )
376 $help['flags'] .= Html
::rawElement( 'li', null,
377 self
::wrap( $context->msg( 'api-help-source-unknown' ), 'apihelp-source' )
379 $help['flags'] .= Html
::rawElement( 'li', null,
380 self
::wrap( $context->msg( 'api-help-license-unknown' ), 'apihelp-license' )
383 $help['flags'] .= Html
::closeElement( 'ul' );
384 $help['flags'] .= Html
::closeElement( 'div' );
386 foreach ( $module->getFinalDescription() as $msg ) {
387 $msg->setContext( $context );
388 $help['description'] .= $msg->parseAsBlock();
391 $urls = $module->getHelpUrls();
393 $help['help-urls'] .= Html
::openElement( 'div',
394 [ 'class' => 'apihelp-block apihelp-help-urls' ]
396 $msg = $context->msg( 'api-help-help-urls' );
397 if ( !$msg->isDisabled() ) {
398 $help['help-urls'] .= self
::wrap(
399 $msg->numParams( count( $urls ) ), 'apihelp-block-head', 'div'
402 if ( !is_array( $urls ) ) {
405 $help['help-urls'] .= Html
::openElement( 'ul' );
406 foreach ( $urls as $url ) {
407 $help['help-urls'] .= Html
::rawElement( 'li', null,
408 Html
::element( 'a', [ 'href' => $url, 'dir' => 'ltr' ], $url )
411 $help['help-urls'] .= Html
::closeElement( 'ul' );
412 $help['help-urls'] .= Html
::closeElement( 'div' );
415 $params = $module->getFinalParams( ApiBase
::GET_VALUES_FOR_HELP
);
416 $dynamicParams = $module->dynamicParameterDocumentation();
418 if ( $params ||
$dynamicParams !== null ) {
419 $help['parameters'] .= Html
::openElement( 'div',
420 [ 'class' => 'apihelp-block apihelp-parameters' ]
422 $msg = $context->msg( 'api-help-parameters' );
423 if ( !$msg->isDisabled() ) {
424 $help['parameters'] .= self
::wrap(
425 $msg->numParams( count( $params ) ), 'apihelp-block-head', 'div'
428 $help['parameters'] .= Html
::openElement( 'dl' );
430 $descriptions = $module->getFinalParamDescription();
432 foreach ( $params as $name => $settings ) {
433 if ( !is_array( $settings ) ) {
434 $settings = [ ApiBase
::PARAM_DFLT
=> $settings ];
437 $help['parameters'] .= Html
::rawElement( 'dt', null,
438 Html
::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $module->encodeParamName( $name ) )
443 if ( isset( $descriptions[$name] ) ) {
444 foreach ( $descriptions[$name] as $msg ) {
445 $msg->setContext( $context );
446 $description[] = $msg->parseAsBlock();
454 if ( !empty( $settings[ApiBase
::PARAM_REQUIRED
] ) ) {
455 $info[] = $context->msg( 'api-help-param-required' )->parse();
459 if ( !empty( $settings[ApiBase
::PARAM_HELP_MSG_INFO
] ) ) {
460 foreach ( $settings[ApiBase
::PARAM_HELP_MSG_INFO
] as $i ) {
461 $tag = array_shift( $i );
462 $info[] = $context->msg( "apihelp-{$path}-paraminfo-{$tag}" )
463 ->numParams( count( $i ) )
464 ->params( $context->getLanguage()->commaList( $i ) )
465 ->params( $module->getModulePrefix() )
470 // Type documentation
471 if ( !isset( $settings[ApiBase
::PARAM_TYPE
] ) ) {
472 $dflt = isset( $settings[ApiBase
::PARAM_DFLT
] )
473 ?
$settings[ApiBase
::PARAM_DFLT
]
475 if ( is_bool( $dflt ) ) {
476 $settings[ApiBase
::PARAM_TYPE
] = 'boolean';
477 } elseif ( is_string( $dflt ) ||
is_null( $dflt ) ) {
478 $settings[ApiBase
::PARAM_TYPE
] = 'string';
479 } elseif ( is_int( $dflt ) ) {
480 $settings[ApiBase
::PARAM_TYPE
] = 'integer';
483 if ( isset( $settings[ApiBase
::PARAM_TYPE
] ) ) {
484 $type = $settings[ApiBase
::PARAM_TYPE
];
485 $multi = !empty( $settings[ApiBase
::PARAM_ISMULTI
] );
486 $hintPipeSeparated = true;
487 $count = !empty( $settings[ApiBase
::PARAM_ISMULTI_LIMIT2
] )
488 ?
$settings[ApiBase
::PARAM_ISMULTI_LIMIT2
] +
1
489 : ApiBase
::LIMIT_SML2 +
1;
491 if ( is_array( $type ) ) {
492 $count = count( $type );
493 $deprecatedValues = isset( $settings[ApiBase
::PARAM_DEPRECATED_VALUES
] )
494 ?
$settings[ApiBase
::PARAM_DEPRECATED_VALUES
]
496 $links = isset( $settings[ApiBase
::PARAM_VALUE_LINKS
] )
497 ?
$settings[ApiBase
::PARAM_VALUE_LINKS
]
499 $values = array_map( function ( $v ) use ( $links, $deprecatedValues ) {
502 // We can't know whether this contains LTR or RTL text.
503 $attr['dir'] = 'auto';
505 if ( isset( $deprecatedValues[$v] ) ) {
506 $attr['class'] = 'apihelp-deprecated-value';
508 $ret = $attr ? Html
::element( 'span', $attr, $v ) : $v;
509 if ( isset( $links[$v] ) ) {
510 $ret = "[[{$links[$v]}|$ret]]";
514 $i = array_search( '', $type, true );
515 if ( $i === false ) {
516 $values = $context->getLanguage()->commaList( $values );
518 unset( $values[$i] );
519 $values = $context->msg( 'api-help-param-list-can-be-empty' )
520 ->numParams( count( $values ) )
521 ->params( $context->getLanguage()->commaList( $values ) )
524 $info[] = $context->msg( 'api-help-param-list' )
525 ->params( $multi ?
2 : 1 )
528 $hintPipeSeparated = false;
534 if ( isset( $settings[ApiBase
::PARAM_SUBMODULE_MAP
] ) ) {
535 $map = $settings[ApiBase
::PARAM_SUBMODULE_MAP
];
538 $prefix = $module->isMain() ?
'' : ( $module->getModulePath() . '+' );
540 foreach ( $module->getModuleManager()->getNames( $name ) as $submoduleName ) {
541 $map[$submoduleName] = $prefix . $submoduleName;
543 $defaultAttrs = [ 'dir' => 'ltr', 'lang' => 'en' ];
548 $deprecatedSubmodules = [];
549 foreach ( $map as $v => $m ) {
550 $attrs = $defaultAttrs;
553 $submod = $module->getModuleFromPath( $m );
555 if ( $submod->isDeprecated() ) {
556 $arr = &$deprecatedSubmodules;
557 $attrs['class'] = 'apihelp-deprecated-value';
560 } catch ( ApiUsageException
$ex ) {
564 $v = Html
::element( 'span', $attrs, $v );
566 $arr[] = "[[Special:ApiHelp/{$m}|{$v}]]";
568 $submodules = array_merge( $submodules, $deprecatedSubmodules );
569 $count = count( $submodules );
570 $info[] = $context->msg( 'api-help-param-list' )
571 ->params( $multi ?
2 : 1 )
572 ->params( $context->getLanguage()->commaList( $submodules ) )
574 $hintPipeSeparated = false;
575 // No type message necessary, we have a list of values.
580 $namespaces = MWNamespace
::getValidNamespaces();
581 if ( isset( $settings[ApiBase
::PARAM_EXTRA_NAMESPACES
] ) &&
582 is_array( $settings[ApiBase
::PARAM_EXTRA_NAMESPACES
] )
584 $namespaces = array_merge( $namespaces, $settings[ApiBase
::PARAM_EXTRA_NAMESPACES
] );
587 $count = count( $namespaces );
588 $info[] = $context->msg( 'api-help-param-list' )
589 ->params( $multi ?
2 : 1 )
590 ->params( $context->getLanguage()->commaList( $namespaces ) )
592 $hintPipeSeparated = false;
593 // No type message necessary, we have a list of values.
598 $tags = ChangeTags
::listExplicitlyDefinedTags();
599 $count = count( $tags );
600 $info[] = $context->msg( 'api-help-param-list' )
601 ->params( $multi ?
2 : 1 )
602 ->params( $context->getLanguage()->commaList( $tags ) )
604 $hintPipeSeparated = false;
609 if ( isset( $settings[ApiBase
::PARAM_MAX2
] ) ) {
610 $info[] = $context->msg( 'api-help-param-limit2' )
611 ->numParams( $settings[ApiBase
::PARAM_MAX
] )
612 ->numParams( $settings[ApiBase
::PARAM_MAX2
] )
615 $info[] = $context->msg( 'api-help-param-limit' )
616 ->numParams( $settings[ApiBase
::PARAM_MAX
] )
622 // Possible messages:
623 // api-help-param-integer-min,
624 // api-help-param-integer-max,
625 // api-help-param-integer-minmax
628 if ( isset( $settings[ApiBase
::PARAM_MIN
] ) ) {
630 $min = $settings[ApiBase
::PARAM_MIN
];
632 if ( isset( $settings[ApiBase
::PARAM_MAX
] ) ) {
634 $max = $settings[ApiBase
::PARAM_MAX
];
636 if ( $suffix !== '' ) {
638 $context->msg( "api-help-param-integer-$suffix" )
639 ->params( $multi ?
2 : 1 )
640 ->numParams( $min, $max )
646 $info[] = $context->msg( 'api-help-param-upload' )
648 // No type message necessary, api-help-param-upload should handle it.
654 // Displaying a type message here would be useless.
660 // Add type. Messages for grep: api-help-param-type-limit
661 // api-help-param-type-integer api-help-param-type-boolean
662 // api-help-param-type-timestamp api-help-param-type-user
663 // api-help-param-type-password
664 if ( is_string( $type ) ) {
665 $msg = $context->msg( "api-help-param-type-$type" );
666 if ( !$msg->isDisabled() ) {
667 $info[] = $msg->params( $multi ?
2 : 1 )->parse();
673 $lowcount = !empty( $settings[ApiBase
::PARAM_ISMULTI_LIMIT1
] )
674 ?
$settings[ApiBase
::PARAM_ISMULTI_LIMIT1
]
675 : ApiBase
::LIMIT_SML1
;
676 $highcount = !empty( $settings[ApiBase
::PARAM_ISMULTI_LIMIT2
] )
677 ?
$settings[ApiBase
::PARAM_ISMULTI_LIMIT2
]
678 : ApiBase
::LIMIT_SML2
;
680 if ( $hintPipeSeparated ) {
681 $extra[] = $context->msg( 'api-help-param-multi-separate' )->parse();
683 if ( $count > $lowcount ) {
684 if ( $lowcount === $highcount ) {
685 $msg = $context->msg( 'api-help-param-multi-max-simple' )
686 ->numParams( $lowcount );
688 $msg = $context->msg( 'api-help-param-multi-max' )
689 ->numParams( $lowcount, $highcount );
691 $extra[] = $msg->parse();
694 $info[] = implode( ' ', $extra );
697 $allowAll = isset( $settings[ApiBase
::PARAM_ALL
] )
698 ?
$settings[ApiBase
::PARAM_ALL
]
700 if ( $allowAll ||
$settings[ApiBase
::PARAM_TYPE
] === 'namespace' ) {
701 if ( $settings[ApiBase
::PARAM_TYPE
] === 'namespace' ) {
702 $allSpecifier = ApiBase
::ALL_DEFAULT_STRING
;
704 $allSpecifier = ( is_string( $allowAll ) ?
$allowAll : ApiBase
::ALL_DEFAULT_STRING
);
706 $info[] = $context->msg( 'api-help-param-multi-all' )
707 ->params( $allSpecifier )
713 if ( isset( $settings[self
::PARAM_MAX_BYTES
] ) ) {
714 $info[] = $context->msg( 'api-help-param-maxbytes' )
715 ->numParams( $settings[self
::PARAM_MAX_BYTES
] );
717 if ( isset( $settings[self
::PARAM_MAX_CHARS
] ) ) {
718 $info[] = $context->msg( 'api-help-param-maxchars' )
719 ->numParams( $settings[self
::PARAM_MAX_CHARS
] );
723 $default = isset( $settings[ApiBase
::PARAM_DFLT
] )
724 ?
$settings[ApiBase
::PARAM_DFLT
]
726 if ( $default === '' ) {
727 $info[] = $context->msg( 'api-help-param-default-empty' )
729 } elseif ( $default !== null && $default !== false ) {
730 // We can't know whether this contains LTR or RTL text.
731 $info[] = $context->msg( 'api-help-param-default' )
732 ->params( Html
::element( 'span', [ 'dir' => 'auto' ], $default ) )
736 if ( !array_filter( $description ) ) {
737 $description = [ self
::wrap(
738 $context->msg( 'api-help-param-no-description' ),
743 // Add "deprecated" flag
744 if ( !empty( $settings[ApiBase
::PARAM_DEPRECATED
] ) ) {
745 $help['parameters'] .= Html
::openElement( 'dd',
746 [ 'class' => 'info' ] );
747 $help['parameters'] .= self
::wrap(
748 $context->msg( 'api-help-param-deprecated' ),
749 'apihelp-deprecated', 'strong'
751 $help['parameters'] .= Html
::closeElement( 'dd' );
754 if ( $description ) {
755 $description = implode( '', $description );
756 $description = preg_replace( '!\s*</([oud]l)>\s*<\1>\s*!', "\n", $description );
757 $help['parameters'] .= Html
::rawElement( 'dd',
758 [ 'class' => 'description' ], $description );
761 foreach ( $info as $i ) {
762 $help['parameters'] .= Html
::rawElement( 'dd', [ 'class' => 'info' ], $i );
766 if ( $dynamicParams !== null ) {
767 $dynamicParams = ApiBase
::makeMessage( $dynamicParams, $context, [
768 $module->getModulePrefix(),
769 $module->getModuleName(),
770 $module->getModulePath()
772 $help['parameters'] .= Html
::element( 'dt', null, '*' );
773 $help['parameters'] .= Html
::rawElement( 'dd',
774 [ 'class' => 'description' ], $dynamicParams->parse() );
777 $help['parameters'] .= Html
::closeElement( 'dl' );
778 $help['parameters'] .= Html
::closeElement( 'div' );
781 $examples = $module->getExamplesMessages();
783 $help['examples'] .= Html
::openElement( 'div',
784 [ 'class' => 'apihelp-block apihelp-examples' ] );
785 $msg = $context->msg( 'api-help-examples' );
786 if ( !$msg->isDisabled() ) {
787 $help['examples'] .= self
::wrap(
788 $msg->numParams( count( $examples ) ), 'apihelp-block-head', 'div'
792 $help['examples'] .= Html
::openElement( 'dl' );
793 foreach ( $examples as $qs => $msg ) {
794 $msg = ApiBase
::makeMessage( $msg, $context, [
795 $module->getModulePrefix(),
796 $module->getModuleName(),
797 $module->getModulePath()
800 $link = wfAppendQuery( wfScript( 'api' ), $qs );
801 $sandbox = SpecialPage
::getTitleFor( 'ApiSandbox' )->getLocalURL() . '#' . $qs;
802 $help['examples'] .= Html
::rawElement( 'dt', null, $msg->parse() );
803 $help['examples'] .= Html
::rawElement( 'dd', null,
804 Html
::element( 'a', [ 'href' => $link, 'dir' => 'ltr' ], "api.php?$qs" ) . ' ' .
805 Html
::rawElement( 'a', [ 'href' => $sandbox ],
806 $context->msg( 'api-help-open-in-apisandbox' )->parse() )
809 $help['examples'] .= Html
::closeElement( 'dl' );
810 $help['examples'] .= Html
::closeElement( 'div' );
813 $subtocnumber = $tocnumber;
814 $subtocnumber[$level +
1] = 0;
816 'submodules' => $options['recursivesubmodules'],
817 'headerlevel' => $level +
1,
818 'tocnumber' => &$subtocnumber,
822 if ( $options['submodules'] && $module->getModuleManager() ) {
823 $manager = $module->getModuleManager();
825 foreach ( $groups as $group ) {
826 $names = $manager->getNames( $group );
828 foreach ( $names as $name ) {
829 $submodules[] = $manager->getModule( $name );
832 $help['submodules'] .= self
::getHelpInternal(
840 $module->modifyHelp( $help, $suboptions, $haveModules );
842 Hooks
::run( 'APIHelpModifyOutput', [ $module, &$help, $suboptions, &$haveModules ] );
844 $out .= implode( "\n", $help );
850 public function shouldCheckMaxlag() {
854 public function isReadMode() {
858 public function getCustomPrinter() {
859 $params = $this->extractRequestParams();
860 if ( $params['wrap'] ) {
864 $main = $this->getMain();
865 $errorPrinter = $main->createPrinterByName( $main->getParameter( 'format' ) );
866 return new ApiFormatRaw( $main, $errorPrinter );
869 public function getAllowedParams() {
872 ApiBase
::PARAM_DFLT
=> 'main',
873 ApiBase
::PARAM_ISMULTI
=> true,
875 'submodules' => false,
876 'recursivesubmodules' => false,
882 protected function getExamplesMessages() {
885 => 'apihelp-help-example-main',
886 'action=help&modules=query&submodules=1'
887 => 'apihelp-help-example-submodules',
888 'action=help&recursivesubmodules=1'
889 => 'apihelp-help-example-recursive',
890 'action=help&modules=help'
891 => 'apihelp-help-example-help',
892 'action=help&modules=query+info|query+categorymembers'
893 => 'apihelp-help-example-query',
897 public function getHelpUrls() {
899 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page',
900 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:FAQ',
901 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Quick_start_guide',