MediaWiki  1.28.0
ApiQueryAllDeletedRevisions.php
Go to the documentation of this file.
1 <?php
34 
35  public function __construct( ApiQuery $query, $moduleName ) {
36  parent::__construct( $query, $moduleName, 'adr' );
37  }
38 
43  protected function run( ApiPageSet $resultPageSet = null ) {
44  $user = $this->getUser();
45  // Before doing anything at all, let's check permissions
46  if ( !$user->isAllowed( 'deletedhistory' ) ) {
47  $this->dieUsage(
48  'You don\'t have permission to view deleted revision information',
49  'permissiondenied'
50  );
51  }
52 
53  $db = $this->getDB();
54  $params = $this->extractRequestParams( false );
55 
56  $result = $this->getResult();
57 
58  // If the user wants no namespaces, they get no pages.
59  if ( $params['namespace'] === [] ) {
60  if ( $resultPageSet === null ) {
61  $result->addValue( 'query', $this->getModuleName(), [] );
62  }
63  return;
64  }
65 
66  // This module operates in two modes:
67  // 'user': List deleted revs by a certain user
68  // 'all': List all deleted revs in NS
69  $mode = 'all';
70  if ( !is_null( $params['user'] ) ) {
71  $mode = 'user';
72  }
73 
74  if ( $mode == 'user' ) {
75  foreach ( [ 'from', 'to', 'prefix', 'excludeuser' ] as $param ) {
76  if ( !is_null( $params[$param] ) ) {
77  $p = $this->getModulePrefix();
78  $this->dieUsage( "The '{$p}{$param}' parameter cannot be used with '{$p}user'",
79  'badparams' );
80  }
81  }
82  } else {
83  foreach ( [ 'start', 'end' ] as $param ) {
84  if ( !is_null( $params[$param] ) ) {
85  $p = $this->getModulePrefix();
86  $this->dieUsage( "The '{$p}{$param}' parameter may only be used with '{$p}user'",
87  'badparams' );
88  }
89  }
90  }
91 
92  // If we're generating titles only, we can use DISTINCT for a better
93  // query. But we can't do that in 'user' mode (wrong index), and we can
94  // only do it when sorting ASC (because MySQL apparently can't use an
95  // index backwards for grouping even though it can for ORDER BY, WTF?)
96  $dir = $params['dir'];
97  $optimizeGenerateTitles = false;
98  if ( $mode === 'all' && $params['generatetitles'] && $resultPageSet !== null ) {
99  if ( $dir === 'newer' ) {
100  $optimizeGenerateTitles = true;
101  } else {
102  $p = $this->getModulePrefix();
103  $this->setWarning( "For better performance when generating titles, set {$p}dir=newer" );
104  }
105  }
106 
107  $this->addTables( 'archive' );
108  if ( $resultPageSet === null ) {
109  $this->parseParameters( $params );
111  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
112  } else {
113  $this->limit = $this->getParameter( 'limit' ) ?: 10;
114  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
115  if ( $optimizeGenerateTitles ) {
116  $this->addOption( 'DISTINCT' );
117  } else {
118  $this->addFields( [ 'ar_timestamp', 'ar_rev_id', 'ar_id' ] );
119  }
120  }
121 
122  if ( $this->fld_tags ) {
123  $this->addTables( 'tag_summary' );
124  $this->addJoinConds(
125  [ 'tag_summary' => [ 'LEFT JOIN', [ 'ar_rev_id=ts_rev_id' ] ] ]
126  );
127  $this->addFields( 'ts_tags' );
128  }
129 
130  if ( !is_null( $params['tag'] ) ) {
131  $this->addTables( 'change_tag' );
132  $this->addJoinConds(
133  [ 'change_tag' => [ 'INNER JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
134  );
135  $this->addWhereFld( 'ct_tag', $params['tag'] );
136  }
137 
138  if ( $this->fetchContent ) {
139  // Modern MediaWiki has the content for deleted revs in the 'text'
140  // table using fields old_text and old_flags. But revisions deleted
141  // pre-1.5 store the content in the 'archive' table directly using
142  // fields ar_text and ar_flags, and no corresponding 'text' row. So
143  // we have to LEFT JOIN and fetch all four fields.
144  $this->addTables( 'text' );
145  $this->addJoinConds(
146  [ 'text' => [ 'LEFT JOIN', [ 'ar_text_id=old_id' ] ] ]
147  );
148  $this->addFields( [ 'ar_text', 'ar_flags', 'old_text', 'old_flags' ] );
149 
150  // This also means stricter restrictions
151  if ( !$user->isAllowedAny( 'undelete', 'deletedtext' ) ) {
152  $this->dieUsage(
153  'You don\'t have permission to view deleted revision content',
154  'permissiondenied'
155  );
156  }
157  }
158 
159  $miser_ns = null;
160 
161  if ( $mode == 'all' ) {
162  if ( $params['namespace'] !== null ) {
163  $namespaces = $params['namespace'];
164  } else {
166  }
167  $this->addWhereFld( 'ar_namespace', $namespaces );
168 
169  // For from/to/prefix, we have to consider the potential
170  // transformations of the title in all specified namespaces.
171  // Generally there will be only one transformation, but wikis with
172  // some namespaces case-sensitive could have two.
173  if ( $params['from'] !== null || $params['to'] !== null ) {
174  $isDirNewer = ( $dir === 'newer' );
175  $after = ( $isDirNewer ? '>=' : '<=' );
176  $before = ( $isDirNewer ? '<=' : '>=' );
177  $where = [];
178  foreach ( $namespaces as $ns ) {
179  $w = [];
180  if ( $params['from'] !== null ) {
181  $w[] = 'ar_title' . $after .
182  $db->addQuotes( $this->titlePartToKey( $params['from'], $ns ) );
183  }
184  if ( $params['to'] !== null ) {
185  $w[] = 'ar_title' . $before .
186  $db->addQuotes( $this->titlePartToKey( $params['to'], $ns ) );
187  }
188  $w = $db->makeList( $w, LIST_AND );
189  $where[$w][] = $ns;
190  }
191  if ( count( $where ) == 1 ) {
192  $where = key( $where );
193  $this->addWhere( $where );
194  } else {
195  $where2 = [];
196  foreach ( $where as $w => $ns ) {
197  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
198  }
199  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
200  }
201  }
202 
203  if ( isset( $params['prefix'] ) ) {
204  $where = [];
205  foreach ( $namespaces as $ns ) {
206  $w = 'ar_title' . $db->buildLike(
207  $this->titlePartToKey( $params['prefix'], $ns ),
208  $db->anyString() );
209  $where[$w][] = $ns;
210  }
211  if ( count( $where ) == 1 ) {
212  $where = key( $where );
213  $this->addWhere( $where );
214  } else {
215  $where2 = [];
216  foreach ( $where as $w => $ns ) {
217  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
218  }
219  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
220  }
221  }
222  } else {
223  if ( $this->getConfig()->get( 'MiserMode' ) ) {
224  $miser_ns = $params['namespace'];
225  } else {
226  $this->addWhereFld( 'ar_namespace', $params['namespace'] );
227  }
228  $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
229  }
230 
231  if ( !is_null( $params['user'] ) ) {
232  $this->addWhereFld( 'ar_user_text', $params['user'] );
233  } elseif ( !is_null( $params['excludeuser'] ) ) {
234  $this->addWhere( 'ar_user_text != ' .
235  $db->addQuotes( $params['excludeuser'] ) );
236  }
237 
238  if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
239  // Paranoia: avoid brute force searches (bug 17342)
240  // (shouldn't be able to get here without 'deletedhistory', but
241  // check it again just in case)
242  if ( !$user->isAllowed( 'deletedhistory' ) ) {
243  $bitmask = Revision::DELETED_USER;
244  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
246  } else {
247  $bitmask = 0;
248  }
249  if ( $bitmask ) {
250  $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
251  }
252  }
253 
254  if ( !is_null( $params['continue'] ) ) {
255  $cont = explode( '|', $params['continue'] );
256  $op = ( $dir == 'newer' ? '>' : '<' );
257  if ( $optimizeGenerateTitles ) {
258  $this->dieContinueUsageIf( count( $cont ) != 2 );
259  $ns = intval( $cont[0] );
260  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
261  $title = $db->addQuotes( $cont[1] );
262  $this->addWhere( "ar_namespace $op $ns OR " .
263  "(ar_namespace = $ns AND ar_title $op= $title)" );
264  } elseif ( $mode == 'all' ) {
265  $this->dieContinueUsageIf( count( $cont ) != 4 );
266  $ns = intval( $cont[0] );
267  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
268  $title = $db->addQuotes( $cont[1] );
269  $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
270  $ar_id = (int)$cont[3];
271  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
272  $this->addWhere( "ar_namespace $op $ns OR " .
273  "(ar_namespace = $ns AND " .
274  "(ar_title $op $title OR " .
275  "(ar_title = $title AND " .
276  "(ar_timestamp $op $ts OR " .
277  "(ar_timestamp = $ts AND " .
278  "ar_id $op= $ar_id)))))" );
279  } else {
280  $this->dieContinueUsageIf( count( $cont ) != 2 );
281  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
282  $ar_id = (int)$cont[1];
283  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
284  $this->addWhere( "ar_timestamp $op $ts OR " .
285  "(ar_timestamp = $ts AND " .
286  "ar_id $op= $ar_id)" );
287  }
288  }
289 
290  $this->addOption( 'LIMIT', $this->limit + 1 );
291 
292  $sort = ( $dir == 'newer' ? '' : ' DESC' );
293  $orderby = [];
294  if ( $optimizeGenerateTitles ) {
295  // Targeting index name_title_timestamp
296  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
297  $orderby[] = "ar_namespace $sort";
298  }
299  $orderby[] = "ar_title $sort";
300  } elseif ( $mode == 'all' ) {
301  // Targeting index name_title_timestamp
302  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
303  $orderby[] = "ar_namespace $sort";
304  }
305  $orderby[] = "ar_title $sort";
306  $orderby[] = "ar_timestamp $sort";
307  $orderby[] = "ar_id $sort";
308  } else {
309  // Targeting index usertext_timestamp
310  // 'user' is always constant.
311  $orderby[] = "ar_timestamp $sort";
312  $orderby[] = "ar_id $sort";
313  }
314  $this->addOption( 'ORDER BY', $orderby );
315 
316  $res = $this->select( __METHOD__ );
317  $pageMap = []; // Maps ns&title to array index
318  $count = 0;
319  $nextIndex = 0;
320  $generated = [];
321  foreach ( $res as $row ) {
322  if ( ++$count > $this->limit ) {
323  // We've had enough
324  if ( $optimizeGenerateTitles ) {
325  $this->setContinueEnumParameter( 'continue', "$row->ar_namespace|$row->ar_title" );
326  } elseif ( $mode == 'all' ) {
327  $this->setContinueEnumParameter( 'continue',
328  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
329  );
330  } else {
331  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
332  }
333  break;
334  }
335 
336  // Miser mode namespace check
337  if ( $miser_ns !== null && !in_array( $row->ar_namespace, $miser_ns ) ) {
338  continue;
339  }
340 
341  if ( $resultPageSet !== null ) {
342  if ( $params['generatetitles'] ) {
343  $key = "{$row->ar_namespace}:{$row->ar_title}";
344  if ( !isset( $generated[$key] ) ) {
345  $generated[$key] = Title::makeTitle( $row->ar_namespace, $row->ar_title );
346  }
347  } else {
348  $generated[] = $row->ar_rev_id;
349  }
350  } else {
351  $revision = Revision::newFromArchiveRow( $row );
352  $rev = $this->extractRevisionInfo( $revision, $row );
353 
354  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
355  $index = $nextIndex++;
356  $pageMap[$row->ar_namespace][$row->ar_title] = $index;
357  $title = $revision->getTitle();
358  $a = [
359  'pageid' => $title->getArticleID(),
360  'revisions' => [ $rev ],
361  ];
362  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
364  $fit = $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
365  } else {
366  $index = $pageMap[$row->ar_namespace][$row->ar_title];
367  $fit = $result->addValue(
368  [ 'query', $this->getModuleName(), $index, 'revisions' ],
369  null, $rev );
370  }
371  if ( !$fit ) {
372  if ( $mode == 'all' ) {
373  $this->setContinueEnumParameter( 'continue',
374  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
375  );
376  } else {
377  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
378  }
379  break;
380  }
381  }
382  }
383 
384  if ( $resultPageSet !== null ) {
385  if ( $params['generatetitles'] ) {
386  $resultPageSet->populateFromTitles( $generated );
387  } else {
388  $resultPageSet->populateFromRevisionIDs( $generated );
389  }
390  } else {
391  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
392  }
393  }
394 
395  public function getAllowedParams() {
396  $ret = parent::getAllowedParams() + [
397  'user' => [
398  ApiBase::PARAM_TYPE => 'user'
399  ],
400  'namespace' => [
401  ApiBase::PARAM_ISMULTI => true,
402  ApiBase::PARAM_TYPE => 'namespace',
403  ],
404  'start' => [
405  ApiBase::PARAM_TYPE => 'timestamp',
406  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
407  ],
408  'end' => [
409  ApiBase::PARAM_TYPE => 'timestamp',
410  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
411  ],
412  'dir' => [
414  'newer',
415  'older'
416  ],
417  ApiBase::PARAM_DFLT => 'older',
418  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
419  ],
420  'from' => [
421  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
422  ],
423  'to' => [
424  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
425  ],
426  'prefix' => [
427  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
428  ],
429  'excludeuser' => [
430  ApiBase::PARAM_TYPE => 'user',
431  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
432  ],
433  'tag' => null,
434  'continue' => [
435  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
436  ],
437  'generatetitles' => [
439  ],
440  ];
441 
442  if ( $this->getConfig()->get( 'MiserMode' ) ) {
444  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
445  ];
446  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
447  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
448  ];
449  }
450 
451  return $ret;
452  }
453 
454  protected function getExamplesMessages() {
455  return [
456  'action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50'
457  => 'apihelp-query+alldeletedrevisions-example-user',
458  'action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50'
459  => 'apihelp-query+alldeletedrevisions-example-ns-main',
460  ];
461  }
462 
463  public function getHelpUrls() {
464  return 'https://www.mediawiki.org/wiki/API:Alldeletedrevisions';
465  }
466 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getDB()
Get the Query database connection (read-only)
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1555
getResult()
Get the result object.
Definition: ApiBase.php:577
if(count($args)==0) $dir
getParameter($paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:702
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
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
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
$sort
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
A base class for functions common to producing a list of revisions.
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
static selectArchiveFields()
Return the list of revision fields that should be selected to create a new revision from an archive r...
Definition: Revision.php:473
addTimestampWhereRange($field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
setContinueEnumParameter($paramName, $paramValue)
Overridden to set the generator param if in generator mode.
addWhere($value)
Add a set of WHERE clauses to the internal array.
extractRevisionInfo(Revision $revision, $row)
Extract information from the Revision.
addJoinConds($join_conds)
Add a set of JOIN conditions to the internal array.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
__construct(ApiQuery $query, $moduleName)
parseParameters($params)
Parse the parameters into the various instance fields.
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
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:132
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
Definition: design.txt:25
const LIST_AND
Definition: Defines.php:35
$res
Definition: database.txt:21
getConfig()
Get the Config object.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
const DELETED_RESTRICTED
Definition: Revision.php:88
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
This is the main query class.
Definition: ApiQuery.php:38
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1721
setWarning($warning)
Set warning section for this module.
Definition: ApiBase.php:1543
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
dieContinueUsageIf($condition)
Die with the $prefix.
Definition: ApiBase.php:2229
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
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 local account $user
Definition: hooks.txt:242
const LIST_OR
Definition: Defines.php:38
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
titlePartToKey($titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
const DELETED_USER
Definition: Revision.php:87
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:465
addFields($value)
Add a set of fields to select to the internal array.
Query module to enumerate all deleted revisions.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
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:1574
$count
static newFromArchiveRow($row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:183
static getValidNamespaces()
Returns an array of the namespaces (by integer id) that exist on the wiki.
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
run(ApiPageSet $resultPageSet=null)
getUser()
Get the User object.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511