MediaWiki  1.23.14
ApiParamInfo.php
Go to the documentation of this file.
1 <?php
30 class ApiParamInfo extends ApiBase {
31 
35  protected $queryObj;
36 
37  public function __construct( $main, $action ) {
38  parent::__construct( $main, $action );
39  $this->queryObj = new ApiQuery( $this->getMain(), 'query' );
40  }
41 
42  public function execute() {
43  // Get parameters
44  $params = $this->extractRequestParams();
45  $resultObj = $this->getResult();
46 
47  $res = array();
48 
49  $this->addModulesInfo( $params, 'modules', $res, $resultObj );
50 
51  $this->addModulesInfo( $params, 'querymodules', $res, $resultObj );
52 
53  if ( $params['mainmodule'] ) {
54  $res['mainmodule'] = $this->getClassInfo( $this->getMain() );
55  }
56 
57  if ( $params['pagesetmodule'] ) {
58  $pageSet = new ApiPageSet( $this->queryObj );
59  $res['pagesetmodule'] = $this->getClassInfo( $pageSet );
60  }
61 
62  $this->addModulesInfo( $params, 'formatmodules', $res, $resultObj );
63 
64  $resultObj->addValue( null, $this->getModuleName(), $res );
65  }
66 
74  private function addModulesInfo( $params, $type, &$res, $resultObj ) {
75  if ( !is_array( $params[$type] ) ) {
76  return;
77  }
78  $isQuery = ( $type === 'querymodules' );
79  if ( $isQuery ) {
80  $mgr = $this->queryObj->getModuleManager();
81  } else {
82  $mgr = $this->getMain()->getModuleManager();
83  }
84  $res[$type] = array();
85  foreach ( $params[$type] as $mod ) {
86  if ( !$mgr->isDefined( $mod ) ) {
87  $res[$type][] = array( 'name' => $mod, 'missing' => '' );
88  continue;
89  }
90  $obj = $mgr->getModule( $mod );
91  $item = $this->getClassInfo( $obj );
92  $item['name'] = $mod;
93  if ( $isQuery ) {
94  $item['querytype'] = $mgr->getModuleGroup( $mod );
95  }
96  $res[$type][] = $item;
97  }
98  $resultObj->setIndexedTagName( $res[$type], 'module' );
99  }
100 
105  private function getClassInfo( $obj ) {
106  $result = $this->getResult();
107  $retval['classname'] = get_class( $obj );
108  $retval['description'] = implode( "\n", (array)$obj->getFinalDescription() );
109  $retval['examples'] = '';
110 
111  // version is deprecated since 1.21, but needs to be returned for v1
112  $retval['version'] = '';
113  $retval['prefix'] = $obj->getModulePrefix();
114 
115  if ( $obj->isReadMode() ) {
116  $retval['readrights'] = '';
117  }
118  if ( $obj->isWriteMode() ) {
119  $retval['writerights'] = '';
120  }
121  if ( $obj->mustBePosted() ) {
122  $retval['mustbeposted'] = '';
123  }
124  if ( $obj instanceof ApiQueryGeneratorBase ) {
125  $retval['generator'] = '';
126  }
127 
128  $allowedParams = $obj->getFinalParams( ApiBase::GET_VALUES_FOR_HELP );
129  if ( !is_array( $allowedParams ) ) {
130  return $retval;
131  }
132 
133  $retval['helpurls'] = (array)$obj->getHelpUrls();
134  if ( isset( $retval['helpurls'][0] ) && $retval['helpurls'][0] === false ) {
135  $retval['helpurls'] = array();
136  }
137  $result->setIndexedTagName( $retval['helpurls'], 'helpurl' );
138 
139  $examples = $obj->getExamples();
140  $retval['allexamples'] = array();
141  if ( $examples !== false ) {
142  if ( is_string( $examples ) ) {
143  $examples = array( $examples );
144  }
145  foreach ( $examples as $k => $v ) {
146  if ( strlen( $retval['examples'] ) ) {
147  $retval['examples'] .= ' ';
148  }
149  $item = array();
150  if ( is_numeric( $k ) ) {
151  $retval['examples'] .= $v;
152  ApiResult::setContent( $item, $v );
153  } else {
154  if ( !is_array( $v ) ) {
155  $item['description'] = $v;
156  } else {
157  $item['description'] = implode( $v, "\n" );
158  }
159  $retval['examples'] .= $item['description'] . ' ' . $k;
160  ApiResult::setContent( $item, $k );
161  }
162  $retval['allexamples'][] = $item;
163  }
164  }
165  $result->setIndexedTagName( $retval['allexamples'], 'example' );
166 
167  $retval['parameters'] = array();
168  $paramDesc = $obj->getFinalParamDescription();
169  foreach ( $allowedParams as $n => $p ) {
170  $a = array( 'name' => $n );
171  if ( isset( $paramDesc[$n] ) ) {
172  $a['description'] = implode( "\n", (array)$paramDesc[$n] );
173  }
174 
175  //handle shorthand
176  if ( !is_array( $p ) ) {
177  $p = array(
178  ApiBase::PARAM_DFLT => $p,
179  );
180  }
181 
182  //handle missing type
183  if ( !isset( $p[ApiBase::PARAM_TYPE] ) ) {
184  $dflt = isset( $p[ApiBase::PARAM_DFLT] ) ? $p[ApiBase::PARAM_DFLT] : null;
185  if ( is_bool( $dflt ) ) {
186  $p[ApiBase::PARAM_TYPE] = 'boolean';
187  } elseif ( is_string( $dflt ) || is_null( $dflt ) ) {
188  $p[ApiBase::PARAM_TYPE] = 'string';
189  } elseif ( is_int( $dflt ) ) {
190  $p[ApiBase::PARAM_TYPE] = 'integer';
191  }
192  }
193 
194  if ( isset( $p[ApiBase::PARAM_DEPRECATED] ) && $p[ApiBase::PARAM_DEPRECATED] ) {
195  $a['deprecated'] = '';
196  }
197  if ( isset( $p[ApiBase::PARAM_REQUIRED] ) && $p[ApiBase::PARAM_REQUIRED] ) {
198  $a['required'] = '';
199  }
200 
201  if ( isset( $p[ApiBase::PARAM_DFLT] ) ) {
203  if ( $type === 'boolean' ) {
204  $a['default'] = ( $p[ApiBase::PARAM_DFLT] ? 'true' : 'false' );
205  } elseif ( $type === 'string' ) {
206  $a['default'] = strval( $p[ApiBase::PARAM_DFLT] );
207  } elseif ( $type === 'integer' ) {
208  $a['default'] = intval( $p[ApiBase::PARAM_DFLT] );
209  } else {
210  $a['default'] = $p[ApiBase::PARAM_DFLT];
211  }
212  }
213  if ( isset( $p[ApiBase::PARAM_ISMULTI] ) && $p[ApiBase::PARAM_ISMULTI] ) {
214  $a['multi'] = '';
215  $a['limit'] = $this->getMain()->canApiHighLimits() ?
218  $a['lowlimit'] = ApiBase::LIMIT_SML1;
219  $a['highlimit'] = ApiBase::LIMIT_SML2;
220  }
221 
223  $a['allowsduplicates'] = '';
224  }
225 
226  if ( isset( $p[ApiBase::PARAM_TYPE] ) ) {
227  $a['type'] = $p[ApiBase::PARAM_TYPE];
228  if ( is_array( $a['type'] ) ) {
229  // To prevent sparse arrays from being serialized to JSON as objects
230  $a['type'] = array_values( $a['type'] );
231  $result->setIndexedTagName( $a['type'], 't' );
232  }
233  }
234  if ( isset( $p[ApiBase::PARAM_MAX] ) ) {
235  $a['max'] = $p[ApiBase::PARAM_MAX];
236  }
237  if ( isset( $p[ApiBase::PARAM_MAX2] ) ) {
238  $a['highmax'] = $p[ApiBase::PARAM_MAX2];
239  }
240  if ( isset( $p[ApiBase::PARAM_MIN] ) ) {
241  $a['min'] = $p[ApiBase::PARAM_MIN];
242  }
243  $retval['parameters'][] = $a;
244  }
245  $result->setIndexedTagName( $retval['parameters'], 'param' );
246 
247  $props = $obj->getFinalResultProperties();
248  $listResult = null;
249  if ( $props !== false ) {
250  $retval['props'] = array();
251 
252  foreach ( $props as $prop => $properties ) {
253  $propResult = array();
254  if ( $prop == ApiBase::PROP_LIST ) {
255  $listResult = $properties;
256  continue;
257  }
258  if ( $prop != ApiBase::PROP_ROOT ) {
259  $propResult['name'] = $prop;
260  }
261  $propResult['properties'] = array();
262 
263  foreach ( $properties as $name => $p ) {
264  $propertyResult = array();
265 
266  $propertyResult['name'] = $name;
267 
268  if ( !is_array( $p ) ) {
269  $p = array( ApiBase::PROP_TYPE => $p );
270  }
271 
272  $propertyResult['type'] = $p[ApiBase::PROP_TYPE];
273 
274  if ( is_array( $propertyResult['type'] ) ) {
275  $propertyResult['type'] = array_values( $propertyResult['type'] );
276  $result->setIndexedTagName( $propertyResult['type'], 't' );
277  }
278 
279  $nullable = null;
280  if ( isset( $p[ApiBase::PROP_NULLABLE] ) ) {
281  $nullable = $p[ApiBase::PROP_NULLABLE];
282  }
283 
284  if ( $nullable === true ) {
285  $propertyResult['nullable'] = '';
286  }
287 
288  $propResult['properties'][] = $propertyResult;
289  }
290 
291  $result->setIndexedTagName( $propResult['properties'], 'property' );
292  $retval['props'][] = $propResult;
293  }
294 
295  // default is true for query modules, false for other modules, overridden by ApiBase::PROP_LIST
296  if ( $listResult === true || ( $listResult !== false && $obj instanceof ApiQueryBase ) ) {
297  $retval['listresult'] = '';
298  }
299 
300  $result->setIndexedTagName( $retval['props'], 'prop' );
301  }
302 
303  // Errors
304  $retval['errors'] = $this->parseErrors( $obj->getFinalPossibleErrors() );
305  $result->setIndexedTagName( $retval['errors'], 'error' );
306 
307  return $retval;
308  }
309 
310  public function isReadMode() {
311  return false;
312  }
313 
314  public function getAllowedParams() {
315  $modules = $this->getMain()->getModuleManager()->getNames( 'action' );
316  sort( $modules );
317  $querymodules = $this->queryObj->getModuleManager()->getNames();
318  sort( $querymodules );
319  $formatmodules = $this->getMain()->getModuleManager()->getNames( 'format' );
320  sort( $formatmodules );
321 
322  return array(
323  'modules' => array(
324  ApiBase::PARAM_ISMULTI => true,
325  ApiBase::PARAM_TYPE => $modules,
326  ),
327  'querymodules' => array(
328  ApiBase::PARAM_ISMULTI => true,
329  ApiBase::PARAM_TYPE => $querymodules,
330  ),
331  'mainmodule' => false,
332  'pagesetmodule' => false,
333  'formatmodules' => array(
334  ApiBase::PARAM_ISMULTI => true,
335  ApiBase::PARAM_TYPE => $formatmodules,
336  )
337  );
338  }
339 
340  public function getParamDescription() {
341  return array(
342  'modules' => 'List of module names (value of the action= parameter)',
343  'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
344  'mainmodule' => 'Get information about the main (top-level) module as well',
345  'pagesetmodule' => 'Get information about the pageset module ' .
346  '(providing titles= and friends) as well',
347  'formatmodules' => 'List of format module names (value of format= parameter)',
348  );
349  }
350 
351  public function getDescription() {
352  return 'Obtain information about certain API parameters and errors.';
353  }
354 
355  public function getExamples() {
356  return array(
357  'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
358  );
359  }
360 
361  public function getHelpUrls() {
362  return 'https://www.mediawiki.org/wiki/API:Parameter_information';
363  }
364 }
ApiParamInfo
Definition: ApiParamInfo.php:30
$result
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
ApiQuery
This is the main query class.
Definition: ApiQuery.php:38
php
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
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:62
ApiResult\setContent
static setContent(&$arr, $value, $subElemName=null)
Adds a content element to an array.
Definition: ApiResult.php:201
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
$n
$n
Definition: RandomTest.php:76
$params
$params
Definition: styleTest.css.php:40
ApiParamInfo\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiParamInfo.php:313
ApiParamInfo\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiParamInfo.php:350
ApiBase\PARAM_ALLOW_DUPLICATES
const PARAM_ALLOW_DUPLICATES
Definition: ApiBase.php:58
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
ApiParamInfo\addModulesInfo
addModulesInfo( $params, $type, &$res, $resultObj)
If the type is requested in parameters, adds a section to res with module info.
Definition: ApiParamInfo.php:73
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
ApiBase\PARAM_DEPRECATED
const PARAM_DEPRECATED
Definition: ApiBase.php:60
ApiBase\PROP_LIST
const PROP_LIST
Definition: ApiBase.php:73
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:34
ApiParamInfo\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiParamInfo.php:339
ApiParamInfo\getClassInfo
getClassInfo( $obj)
Definition: ApiParamInfo.php:104
ApiParamInfo\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiParamInfo.php:41
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:52
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
ApiParamInfo\__construct
__construct( $main, $action)
Definition: ApiParamInfo.php:36
ApiBase\PROP_TYPE
const PROP_TYPE
Definition: ApiBase.php:74
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:707
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
ApiParamInfo\$queryObj
ApiQuery $queryObj
Definition: ApiParamInfo.php:34
ApiBase\LIMIT_SML2
const LIMIT_SML2
Definition: ApiBase.php:81
ApiBase\GET_VALUES_FOR_HELP
const GET_VALUES_FOR_HELP
getAllowedParams() flag: When set, the result could take longer to generate, but should be more thoro...
Definition: ApiBase.php:88
ApiParamInfo\isReadMode
isReadMode()
Indicates whether this module requires read rights.
Definition: ApiParamInfo.php:309
ApiBase\PROP_NULLABLE
const PROP_NULLABLE
Definition: ApiBase.php:76
ApiParamInfo\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiParamInfo.php:354
ApiQueryGeneratorBase
Definition: ApiQueryBase.php:626
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
as
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
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:188
ApiBase\parseErrors
parseErrors( $errors)
Parses a list of errors into a standardised format.
Definition: ApiBase.php:2204
$res
$res
Definition: database.txt:21
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:237
ApiBase\PROP_ROOT
const PROP_ROOT
Definition: ApiBase.php:70
ApiParamInfo\getHelpUrls
getHelpUrls()
Definition: ApiParamInfo.php:360
ApiBase\LIMIT_SML1
const LIMIT_SML1
Definition: ApiBase.php:80
$type
$type
Definition: testCompression.php:46