MediaWiki  1.23.2
Go to the documentation of this file.
1 <?php
32 class ApiHelp extends ApiBase {
36  public function execute() {
37  // Get parameters
38  $params = $this->extractRequestParams();
40  if ( !isset( $params['modules'] ) && !isset( $params['querymodules'] ) ) {
41  $this->dieUsage( '', 'help' );
42  }
44  $this->getMain()->setHelp();
45  $result = $this->getResult();
47  if ( is_array( $params['modules'] ) ) {
48  $modules = $params['modules'];
49  } else {
50  $modules = array();
51  }
53  if ( is_array( $params['querymodules'] ) ) {
54  $queryModules = $params['querymodules'];
55  foreach ( $queryModules as $m ) {
56  $modules[] = 'query+' . $m;
57  }
58  } else {
59  $queryModules = array();
60  }
62  $r = array();
63  foreach ( $modules as $m ) {
64  // sub-modules could be given in the form of "name[+name[+name...]]"
65  $subNames = explode( '+', $m );
66  if ( count( $subNames ) === 1 ) {
67  // In case the '+' was typed into URL, it resolves as a space
68  $subNames = explode( ' ', $m );
69  }
71  $module = $this->getMain();
72  $subNamesCount = count( $subNames );
73  for ( $i = 0; $i < $subNamesCount; $i++ ) {
74  $subs = $module->getModuleManager();
75  if ( $subs === null ) {
76  $module = null;
77  } else {
78  $module = $subs->getModule( $subNames[$i] );
79  }
81  if ( $module === null ) {
82  if ( count( $subNames ) === 2
83  && $i === 1
84  && $subNames[0] === 'query'
85  && in_array( $subNames[1], $queryModules )
86  ) {
87  // Legacy: This is one of the renamed 'querymodule=...' parameters,
88  // do not use '+' notation in the output, use submodule's name instead.
89  $name = $subNames[1];
90  } else {
91  $name = implode( '+', array_slice( $subNames, 0, $i + 1 ) );
92  }
93  $r[] = array( 'name' => $name, 'missing' => '' );
94  break;
95  } else {
96  $type = $subs->getModuleGroup( $subNames[$i] );
97  }
98  }
100  if ( $module !== null ) {
101  $r[] = $this->buildModuleHelp( $module, $type );
102  }
103  }
105  $result->setIndexedTagName( $r, 'module' );
106  $result->addValue( null, $this->getModuleName(), $r );
107  }
114  private function buildModuleHelp( $module, $type ) {
115  $msg = ApiMain::makeHelpMsgHeader( $module, $type );
117  $msg2 = $module->makeHelpMsg();
118  if ( $msg2 !== false ) {
119  $msg .= $msg2;
120  }
122  return $msg;
123  }
125  public function shouldCheckMaxlag() {
126  return false;
127  }
129  public function isReadMode() {
130  return false;
131  }
133  public function getAllowedParams() {
134  return array(
135  'modules' => array(
136  ApiBase::PARAM_ISMULTI => true
137  ),
138  'querymodules' => array(
139  ApiBase::PARAM_ISMULTI => true,
141  ),
142  );
143  }
145  public function getParamDescription() {
146  return array(
147  'modules' => 'List of module names (value of the action= parameter). ' .
148  'Can specify submodules with a \'+\'',
149  'querymodules' => 'Use modules=query+value instead. List of query ' .
150  'module names (value of prop=, meta= or list= parameter)',
151  );
152  }
154  public function getDescription() {
155  return 'Display this help screen. Or the help screen for the specified module.';
156  }
158  public function getExamples() {
159  return array(
160  'api.php?action=help' => 'Whole help page',
161  'api.php?action=help&modules=protect' => 'Module (action) help page',
162  'api.php?action=help&modules=query+categorymembers'
163  => 'Help for the query/categorymembers module',
164  'api.php?action=help&modules=login|query+info'
165  => 'Help for the login and query/info modules',
166  );
167  }
169  public function getHelpUrls() {
170  return array(
171  '',
172  '',
173  '',
174  );
175  }
176 }
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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers '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) '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. '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:1528
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
Indicates whether this module requires read rights.
Definition: ApiHelp.php:129
Get the result object.
Definition: ApiBase.php:205
Definition: styleTest.css.php:40
Returns the description string for this module.
Definition: ApiHelp.php:154
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
Definition: ApiBase.php:60
Returns usage examples for this module.
Definition: ApiHelp.php:158
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
Definition: ApiHelp.php:169
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiHelp.php:133
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1363
Returns an array of parameter descriptions.
Definition: ApiHelp.php:145
static makeHelpMsgHeader( $module, $paramName)
Definition: ApiMain.php:1312
Module for displaying help.
Definition: ApiHelp.php:36
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
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
Definition: ApiBase.php:48
Indicates if this module needs maxlag to be checked.
Definition: ApiHelp.php:125
Get the main module.
Definition: ApiBase.php:188
buildModuleHelp( $module, $type)
Definition: ApiHelp.php:114
Definition: testCompression.php:46
This is a simple class to handle action=help.
Definition: ApiHelp.php:32