MediaWiki  1.28.0
ApiQueryUserContributions.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'uc' );
36  }
37 
40  private $fld_ids = false, $fld_title = false, $fld_timestamp = false,
41  $fld_comment = false, $fld_parsedcomment = false, $fld_flags = false,
42  $fld_patrolled = false, $fld_tags = false, $fld_size = false, $fld_sizediff = false;
43 
44  public function execute() {
45  // Parse some parameters
46  $this->params = $this->extractRequestParams();
47 
48  $prop = array_flip( $this->params['prop'] );
49  $this->fld_ids = isset( $prop['ids'] );
50  $this->fld_title = isset( $prop['title'] );
51  $this->fld_comment = isset( $prop['comment'] );
52  $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
53  $this->fld_size = isset( $prop['size'] );
54  $this->fld_sizediff = isset( $prop['sizediff'] );
55  $this->fld_flags = isset( $prop['flags'] );
56  $this->fld_timestamp = isset( $prop['timestamp'] );
57  $this->fld_patrolled = isset( $prop['patrolled'] );
58  $this->fld_tags = isset( $prop['tags'] );
59 
60  // Most of this code will use the 'contributions' group DB, which can map to replica DBs
61  // with extra user based indexes or partioning by user. The additional metadata
62  // queries should use a regular replica DB since the lookup pattern is not all by user.
63  $dbSecondary = $this->getDB(); // any random replica DB
64 
65  // TODO: if the query is going only against the revision table, should this be done?
66  $this->selectNamedDB( 'contributions', DB_REPLICA, 'contributions' );
67 
68  $this->idMode = false;
69  if ( isset( $this->params['userprefix'] ) ) {
70  $this->prefixMode = true;
71  $this->multiUserMode = true;
72  $this->userprefix = $this->params['userprefix'];
73  } else {
74  $anyIPs = false;
75  $this->userids = [];
76  $this->usernames = [];
77  if ( !is_array( $this->params['user'] ) ) {
78  $this->params['user'] = [ $this->params['user'] ];
79  }
80  if ( !count( $this->params['user'] ) ) {
81  $this->dieUsage( 'User parameter may not be empty.', 'param_user' );
82  }
83  foreach ( $this->params['user'] as $u ) {
84  if ( is_null( $u ) || $u === '' ) {
85  $this->dieUsage( 'User parameter may not be empty', 'param_user' );
86  }
87 
88  if ( User::isIP( $u ) ) {
89  $anyIPs = true;
90  $this->usernames[] = $u;
91  } else {
92  $name = User::getCanonicalName( $u, 'valid' );
93  if ( $name === false ) {
94  $this->dieUsage( "User name {$u} is not valid", 'param_user' );
95  }
96  $this->usernames[] = $name;
97  }
98  }
99  $this->prefixMode = false;
100  $this->multiUserMode = ( count( $this->params['user'] ) > 1 );
101 
102  if ( !$anyIPs ) {
103  $dbr = $this->getDB();
104  $res = $dbr->select( 'user', 'user_id', [ 'user_name' => $this->usernames ], __METHOD__ );
105  foreach ( $res as $row ) {
106  $this->userids[] = $row->user_id;
107  }
108  $this->idMode = count( $this->userids ) === count( $this->usernames );
109  }
110  }
111 
112  $this->prepareQuery();
113 
114  $hookData = [];
115  // Do the actual query.
116  $res = $this->select( __METHOD__, [], $hookData );
117 
118  if ( $this->fld_sizediff ) {
119  $revIds = [];
120  foreach ( $res as $row ) {
121  if ( $row->rev_parent_id ) {
122  $revIds[] = $row->rev_parent_id;
123  }
124  }
125  $this->parentLens = Revision::getParentLengths( $dbSecondary, $revIds );
126  $res->rewind(); // reset
127  }
128 
129  // Initialise some variables
130  $count = 0;
131  $limit = $this->params['limit'];
132 
133  // Fetch each row
134  foreach ( $res as $row ) {
135  if ( ++$count > $limit ) {
136  // We've reached the one extra which shows that there are
137  // additional pages to be had. Stop here...
138  $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) );
139  break;
140  }
141 
142  $vals = $this->extractRowInfo( $row );
143  $fit = $this->processRow( $row, $vals, $hookData ) &&
144  $this->getResult()->addValue( [ 'query', $this->getModuleName() ], null, $vals );
145  if ( !$fit ) {
146  $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) );
147  break;
148  }
149  }
150 
151  $this->getResult()->addIndexedTagName(
152  [ 'query', $this->getModuleName() ],
153  'item'
154  );
155  }
156 
160  private function prepareQuery() {
161  // We're after the revision table, and the corresponding page
162  // row for anything we retrieve. We may also need the
163  // recentchanges row and/or tag summary row.
164  $user = $this->getUser();
165  $tables = [ 'page', 'revision' ]; // Order may change
166  $this->addWhere( 'page_id=rev_page' );
167 
168  // Handle continue parameter
169  if ( !is_null( $this->params['continue'] ) ) {
170  $continue = explode( '|', $this->params['continue'] );
171  $db = $this->getDB();
172  if ( $this->multiUserMode ) {
173  $this->dieContinueUsageIf( count( $continue ) != 4 );
174  $modeFlag = array_shift( $continue );
175  $this->dieContinueUsageIf( !in_array( $modeFlag, [ 'id', 'name' ] ) );
176  if ( $this->idMode && $modeFlag === 'name' ) {
177  // The users were created since this query started, but we
178  // can't go back and change modes now. So just keep on with
179  // name mode.
180  $this->idMode = false;
181  }
182  $this->dieContinueUsageIf( ( $modeFlag === 'id' ) !== $this->idMode );
183  $userField = $this->idMode ? 'rev_user' : 'rev_user_text';
184  $encUser = $db->addQuotes( array_shift( $continue ) );
185  } else {
186  $this->dieContinueUsageIf( count( $continue ) != 2 );
187  }
188  $encTS = $db->addQuotes( $db->timestamp( $continue[0] ) );
189  $encId = (int)$continue[1];
190  $this->dieContinueUsageIf( $encId != $continue[1] );
191  $op = ( $this->params['dir'] == 'older' ? '<' : '>' );
192  if ( $this->multiUserMode ) {
193  $this->addWhere(
194  "$userField $op $encUser OR " .
195  "($userField = $encUser AND " .
196  "(rev_timestamp $op $encTS OR " .
197  "(rev_timestamp = $encTS AND " .
198  "rev_id $op= $encId)))"
199  );
200  } else {
201  $this->addWhere(
202  "rev_timestamp $op $encTS OR " .
203  "(rev_timestamp = $encTS AND " .
204  "rev_id $op= $encId)"
205  );
206  }
207  }
208 
209  // Don't include any revisions where we're not supposed to be able to
210  // see the username.
211  if ( !$user->isAllowed( 'deletedhistory' ) ) {
212  $bitmask = Revision::DELETED_USER;
213  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
215  } else {
216  $bitmask = 0;
217  }
218  if ( $bitmask ) {
219  $this->addWhere( $this->getDB()->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
220  }
221 
222  // We only want pages by the specified users.
223  if ( $this->prefixMode ) {
224  $this->addWhere( 'rev_user_text' .
225  $this->getDB()->buildLike( $this->userprefix, $this->getDB()->anyString() ) );
226  } elseif ( $this->idMode ) {
227  $this->addWhereFld( 'rev_user', $this->userids );
228  } else {
229  $this->addWhereFld( 'rev_user_text', $this->usernames );
230  }
231  // ... and in the specified timeframe.
232  // Ensure the same sort order for rev_user/rev_user_text and rev_timestamp
233  // so our query is indexed
234  if ( $this->multiUserMode ) {
235  $this->addWhereRange( $this->idMode ? 'rev_user' : 'rev_user_text',
236  $this->params['dir'], null, null );
237  }
238  $this->addTimestampWhereRange( 'rev_timestamp',
239  $this->params['dir'], $this->params['start'], $this->params['end'] );
240  // Include in ORDER BY for uniqueness
241  $this->addWhereRange( 'rev_id', $this->params['dir'], null, null );
242 
243  $this->addWhereFld( 'page_namespace', $this->params['namespace'] );
244 
245  $show = $this->params['show'];
246  if ( $this->params['toponly'] ) { // deprecated/old param
247  $show[] = 'top';
248  }
249  if ( !is_null( $show ) ) {
250  $show = array_flip( $show );
251 
252  if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
253  || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
254  || ( isset( $show['top'] ) && isset( $show['!top'] ) )
255  || ( isset( $show['new'] ) && isset( $show['!new'] ) )
256  ) {
257  $this->dieUsageMsg( 'show' );
258  }
259 
260  $this->addWhereIf( 'rev_minor_edit = 0', isset( $show['!minor'] ) );
261  $this->addWhereIf( 'rev_minor_edit != 0', isset( $show['minor'] ) );
262  $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
263  $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
264  $this->addWhereIf( 'rev_id != page_latest', isset( $show['!top'] ) );
265  $this->addWhereIf( 'rev_id = page_latest', isset( $show['top'] ) );
266  $this->addWhereIf( 'rev_parent_id != 0', isset( $show['!new'] ) );
267  $this->addWhereIf( 'rev_parent_id = 0', isset( $show['new'] ) );
268  }
269  $this->addOption( 'LIMIT', $this->params['limit'] + 1 );
270 
271  // Mandatory fields: timestamp allows request continuation
272  // ns+title checks if the user has access rights for this page
273  // user_text is necessary if multiple users were specified
274  $this->addFields( [
275  'rev_id',
276  'rev_timestamp',
277  'page_namespace',
278  'page_title',
279  'rev_user',
280  'rev_user_text',
281  'rev_deleted'
282  ] );
283 
284  if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ||
285  $this->fld_patrolled
286  ) {
287  if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
288  $this->dieUsage(
289  'You need the patrol right to request the patrolled flag',
290  'permissiondenied'
291  );
292  }
293 
294  // Use a redundant join condition on both
295  // timestamp and ID so we can use the timestamp
296  // index
297  $index['recentchanges'] = 'rc_user_text';
298  if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) {
299  // Put the tables in the right order for
300  // STRAIGHT_JOIN
301  $tables = [ 'revision', 'recentchanges', 'page' ];
302  $this->addOption( 'STRAIGHT_JOIN' );
303  $this->addWhere( 'rc_user_text=rev_user_text' );
304  $this->addWhere( 'rc_timestamp=rev_timestamp' );
305  $this->addWhere( 'rc_this_oldid=rev_id' );
306  } else {
307  $tables[] = 'recentchanges';
308  $this->addJoinConds( [ 'recentchanges' => [
309  'LEFT JOIN', [
310  'rc_user_text=rev_user_text',
311  'rc_timestamp=rev_timestamp',
312  'rc_this_oldid=rev_id' ] ] ] );
313  }
314  }
315 
316  $this->addTables( $tables );
317  $this->addFieldsIf( 'rev_page', $this->fld_ids );
318  $this->addFieldsIf( 'page_latest', $this->fld_flags );
319  // $this->addFieldsIf( 'rev_text_id', $this->fld_ids ); // Should this field be exposed?
320  $this->addFieldsIf( 'rev_comment', $this->fld_comment || $this->fld_parsedcomment );
321  $this->addFieldsIf( 'rev_len', $this->fld_size || $this->fld_sizediff );
322  $this->addFieldsIf( 'rev_minor_edit', $this->fld_flags );
323  $this->addFieldsIf( 'rev_parent_id', $this->fld_flags || $this->fld_sizediff || $this->fld_ids );
324  $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled );
325 
326  if ( $this->fld_tags ) {
327  $this->addTables( 'tag_summary' );
328  $this->addJoinConds(
329  [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
330  );
331  $this->addFields( 'ts_tags' );
332  }
333 
334  if ( isset( $this->params['tag'] ) ) {
335  $this->addTables( 'change_tag' );
336  $this->addJoinConds(
337  [ 'change_tag' => [ 'INNER JOIN', [ 'rev_id=ct_rev_id' ] ] ]
338  );
339  $this->addWhereFld( 'ct_tag', $this->params['tag'] );
340  }
341 
342  if ( isset( $index ) ) {
343  $this->addOption( 'USE INDEX', $index );
344  }
345  }
346 
353  private function extractRowInfo( $row ) {
354  $vals = [];
355  $anyHidden = false;
356 
357  if ( $row->rev_deleted & Revision::DELETED_TEXT ) {
358  $vals['texthidden'] = true;
359  $anyHidden = true;
360  }
361 
362  // Any rows where we can't view the user were filtered out in the query.
363  $vals['userid'] = (int)$row->rev_user;
364  $vals['user'] = $row->rev_user_text;
365  if ( $row->rev_deleted & Revision::DELETED_USER ) {
366  $vals['userhidden'] = true;
367  $anyHidden = true;
368  }
369  if ( $this->fld_ids ) {
370  $vals['pageid'] = intval( $row->rev_page );
371  $vals['revid'] = intval( $row->rev_id );
372  // $vals['textid'] = intval( $row->rev_text_id ); // todo: Should this field be exposed?
373 
374  if ( !is_null( $row->rev_parent_id ) ) {
375  $vals['parentid'] = intval( $row->rev_parent_id );
376  }
377  }
378 
379  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
380 
381  if ( $this->fld_title ) {
383  }
384 
385  if ( $this->fld_timestamp ) {
386  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rev_timestamp );
387  }
388 
389  if ( $this->fld_flags ) {
390  $vals['new'] = $row->rev_parent_id == 0 && !is_null( $row->rev_parent_id );
391  $vals['minor'] = (bool)$row->rev_minor_edit;
392  $vals['top'] = $row->page_latest == $row->rev_id;
393  }
394 
395  if ( ( $this->fld_comment || $this->fld_parsedcomment ) && isset( $row->rev_comment ) ) {
396  if ( $row->rev_deleted & Revision::DELETED_COMMENT ) {
397  $vals['commenthidden'] = true;
398  $anyHidden = true;
399  }
400 
401  $userCanView = Revision::userCanBitfield(
402  $row->rev_deleted,
403  Revision::DELETED_COMMENT, $this->getUser()
404  );
405 
406  if ( $userCanView ) {
407  if ( $this->fld_comment ) {
408  $vals['comment'] = $row->rev_comment;
409  }
410 
411  if ( $this->fld_parsedcomment ) {
412  $vals['parsedcomment'] = Linker::formatComment( $row->rev_comment, $title );
413  }
414  }
415  }
416 
417  if ( $this->fld_patrolled ) {
418  $vals['patrolled'] = (bool)$row->rc_patrolled;
419  }
420 
421  if ( $this->fld_size && !is_null( $row->rev_len ) ) {
422  $vals['size'] = intval( $row->rev_len );
423  }
424 
425  if ( $this->fld_sizediff
426  && !is_null( $row->rev_len )
427  && !is_null( $row->rev_parent_id )
428  ) {
429  $parentLen = isset( $this->parentLens[$row->rev_parent_id] )
430  ? $this->parentLens[$row->rev_parent_id]
431  : 0;
432  $vals['sizediff'] = intval( $row->rev_len - $parentLen );
433  }
434 
435  if ( $this->fld_tags ) {
436  if ( $row->ts_tags ) {
437  $tags = explode( ',', $row->ts_tags );
438  ApiResult::setIndexedTagName( $tags, 'tag' );
439  $vals['tags'] = $tags;
440  } else {
441  $vals['tags'] = [];
442  }
443  }
444 
445  if ( $anyHidden && $row->rev_deleted & Revision::DELETED_RESTRICTED ) {
446  $vals['suppressed'] = true;
447  }
448 
449  return $vals;
450  }
451 
452  private function continueStr( $row ) {
453  if ( $this->multiUserMode ) {
454  if ( $this->idMode ) {
455  return "id|$row->rev_user|$row->rev_timestamp|$row->rev_id";
456  } else {
457  return "name|$row->rev_user_text|$row->rev_timestamp|$row->rev_id";
458  }
459  } else {
460  return "$row->rev_timestamp|$row->rev_id";
461  }
462  }
463 
464  public function getCacheMode( $params ) {
465  // This module provides access to deleted revisions and patrol flags if
466  // the requester is logged in
467  return 'anon-public-user-private';
468  }
469 
470  public function getAllowedParams() {
471  return [
472  'limit' => [
473  ApiBase::PARAM_DFLT => 10,
474  ApiBase::PARAM_TYPE => 'limit',
475  ApiBase::PARAM_MIN => 1,
478  ],
479  'start' => [
480  ApiBase::PARAM_TYPE => 'timestamp'
481  ],
482  'end' => [
483  ApiBase::PARAM_TYPE => 'timestamp'
484  ],
485  'continue' => [
486  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
487  ],
488  'user' => [
489  ApiBase::PARAM_TYPE => 'user',
491  ],
492  'userprefix' => null,
493  'dir' => [
494  ApiBase::PARAM_DFLT => 'older',
496  'newer',
497  'older'
498  ],
499  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
500  ],
501  'namespace' => [
502  ApiBase::PARAM_ISMULTI => true,
503  ApiBase::PARAM_TYPE => 'namespace'
504  ],
505  'prop' => [
506  ApiBase::PARAM_ISMULTI => true,
507  ApiBase::PARAM_DFLT => 'ids|title|timestamp|comment|size|flags',
509  'ids',
510  'title',
511  'timestamp',
512  'comment',
513  'parsedcomment',
514  'size',
515  'sizediff',
516  'flags',
517  'patrolled',
518  'tags'
519  ],
521  ],
522  'show' => [
523  ApiBase::PARAM_ISMULTI => true,
525  'minor',
526  '!minor',
527  'patrolled',
528  '!patrolled',
529  'top',
530  '!top',
531  'new',
532  '!new',
533  ],
535  'apihelp-query+usercontribs-param-show',
536  $this->getConfig()->get( 'RCMaxAge' )
537  ],
538  ],
539  'tag' => null,
540  'toponly' => [
541  ApiBase::PARAM_DFLT => false,
543  ],
544  ];
545  }
546 
547  protected function getExamplesMessages() {
548  return [
549  'action=query&list=usercontribs&ucuser=Example'
550  => 'apihelp-query+usercontribs-example-user',
551  'action=query&list=usercontribs&ucuserprefix=192.0.2.'
552  => 'apihelp-query+usercontribs-example-ipprefix',
553  ];
554  }
555 
556  public function getHelpUrls() {
557  return 'https://www.mediawiki.org/wiki/API:Usercontribs';
558  }
559 }
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)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:179
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
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
static getCanonicalName($name, $validate= 'valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid...
Definition: User.php:1046
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:177
addWhereRange($field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction...
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:91
This is a base class for all Query modules.
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:157
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addTimestampWhereRange($field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
addWhere($value)
Add a set of WHERE clauses to the internal array.
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
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
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
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 true
Definition: hooks.txt:1936
prepareQuery()
Prepares the query and returns the limit of rows requested.
addWhereIf($value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
$res
Definition: database.txt:21
getConfig()
Get the Config object.
processRow($row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
static isIP($name)
Does the string match an anonymous IP address?
Definition: User.php:788
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
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:38
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
static formatComment($comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1180
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 DELETED_TEXT
Definition: Revision.php:85
addFieldsIf($value, $condition)
Same as addFields(), but add the fields only if a condition is met.
if($IP===false)
Definition: WebStart.php:59
__construct(ApiQuery $query, $moduleName)
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
const DELETED_USER
Definition: Revision.php:87
addFields($value)
Add a set of fields to select to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
extractRowInfo($row)
Extract fields from the database row and append them to a result array.
setContinueEnumParameter($paramName, $paramValue)
Set a query-continue value.
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
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 the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1046
$count
static getParentLengths($db, array $revIds)
Do a batched query to get the parent revision lengths.
Definition: Revision.php:540
This query action adds a list of a specified user's contributions to the output.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:106
const DB_REPLICA
Definition: defines.php:22
static userCanBitfield($bitfield, $field, User $user=null, Title $title=null)
Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.
Definition: Revision.php:1764
const DELETED_COMMENT
Definition: Revision.php:86
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
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
dieUsageMsg($error)
Output the error message related to a certain array.
Definition: ApiBase.php:2192
selectNamedDB($name, $db, $groups)
Selects the query database connection with the given name.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300