MediaWiki  1.28.0
ApiQueryLogEvents.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'le' );
36  }
37 
38  private $fld_ids = false, $fld_title = false, $fld_type = false,
39  $fld_user = false, $fld_userid = false,
40  $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false,
41  $fld_details = false, $fld_tags = false;
42 
43  public function execute() {
44  $params = $this->extractRequestParams();
45  $db = $this->getDB();
46  $this->requireMaxOneParameter( $params, 'title', 'prefix', 'namespace' );
47 
48  $prop = array_flip( $params['prop'] );
49 
50  $this->fld_ids = isset( $prop['ids'] );
51  $this->fld_title = isset( $prop['title'] );
52  $this->fld_type = isset( $prop['type'] );
53  $this->fld_user = isset( $prop['user'] );
54  $this->fld_userid = isset( $prop['userid'] );
55  $this->fld_timestamp = isset( $prop['timestamp'] );
56  $this->fld_comment = isset( $prop['comment'] );
57  $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
58  $this->fld_details = isset( $prop['details'] );
59  $this->fld_tags = isset( $prop['tags'] );
60 
61  $hideLogs = LogEventsList::getExcludeClause( $db, 'user', $this->getUser() );
62  if ( $hideLogs !== false ) {
63  $this->addWhere( $hideLogs );
64  }
65 
66  // Order is significant here
67  $this->addTables( [ 'logging', 'user', 'page' ] );
68  $this->addJoinConds( [
69  'user' => [ 'LEFT JOIN',
70  'user_id=log_user' ],
71  'page' => [ 'LEFT JOIN',
72  [ 'log_namespace=page_namespace',
73  'log_title=page_title' ] ] ] );
74 
75  $this->addFields( [
76  'log_id',
77  'log_type',
78  'log_action',
79  'log_timestamp',
80  'log_deleted',
81  ] );
82 
83  $this->addFieldsIf( 'page_id', $this->fld_ids );
84  // log_page is the page_id saved at log time, whereas page_id is from a
85  // join at query time. This leads to different results in various
86  // scenarios, e.g. deletion, recreation.
87  $this->addFieldsIf( 'log_page', $this->fld_ids );
88  $this->addFieldsIf( [ 'log_user', 'log_user_text', 'user_name' ], $this->fld_user );
89  $this->addFieldsIf( 'log_user', $this->fld_userid );
90  $this->addFieldsIf(
91  [ 'log_namespace', 'log_title' ],
92  $this->fld_title || $this->fld_parsedcomment
93  );
94  $this->addFieldsIf( 'log_comment', $this->fld_comment || $this->fld_parsedcomment );
95  $this->addFieldsIf( 'log_params', $this->fld_details );
96 
97  if ( $this->fld_tags ) {
98  $this->addTables( 'tag_summary' );
99  $this->addJoinConds( [ 'tag_summary' => [ 'LEFT JOIN', 'log_id=ts_log_id' ] ] );
100  $this->addFields( 'ts_tags' );
101  }
102 
103  if ( !is_null( $params['tag'] ) ) {
104  $this->addTables( 'change_tag' );
105  $this->addJoinConds( [ 'change_tag' => [ 'INNER JOIN',
106  [ 'log_id=ct_log_id' ] ] ] );
107  $this->addWhereFld( 'ct_tag', $params['tag'] );
108  }
109 
110  if ( !is_null( $params['action'] ) ) {
111  // Do validation of action param, list of allowed actions can contains wildcards
112  // Allow the param, when the actions is in the list or a wildcard version is listed.
113  $logAction = $params['action'];
114  if ( strpos( $logAction, '/' ) === false ) {
115  // all items in the list have a slash
116  $valid = false;
117  } else {
118  $logActions = array_flip( $this->getAllowedLogActions() );
119  list( $type, $action ) = explode( '/', $logAction, 2 );
120  $valid = isset( $logActions[$logAction] ) || isset( $logActions[$type . '/*'] );
121  }
122 
123  if ( !$valid ) {
124  $valueName = $this->encodeParamName( 'action' );
125  $this->dieUsage(
126  "Unrecognized value for parameter '$valueName': {$logAction}",
127  "unknown_$valueName"
128  );
129  }
130 
131  $this->addWhereFld( 'log_type', $type );
132  $this->addWhereFld( 'log_action', $action );
133  } elseif ( !is_null( $params['type'] ) ) {
134  $this->addWhereFld( 'log_type', $params['type'] );
135  }
136 
137  $this->addTimestampWhereRange(
138  'log_timestamp',
139  $params['dir'],
140  $params['start'],
141  $params['end']
142  );
143  // Include in ORDER BY for uniqueness
144  $this->addWhereRange( 'log_id', $params['dir'], null, null );
145 
146  if ( !is_null( $params['continue'] ) ) {
147  $cont = explode( '|', $params['continue'] );
148  $this->dieContinueUsageIf( count( $cont ) != 2 );
149  $op = ( $params['dir'] === 'newer' ? '>' : '<' );
150  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
151  $continueId = (int)$cont[1];
152  $this->dieContinueUsageIf( $continueId != $cont[1] );
153  $this->addWhere( "log_timestamp $op $continueTimestamp OR " .
154  "(log_timestamp = $continueTimestamp AND " .
155  "log_id $op= $continueId)"
156  );
157  }
158 
159  $limit = $params['limit'];
160  $this->addOption( 'LIMIT', $limit + 1 );
161 
162  $user = $params['user'];
163  if ( !is_null( $user ) ) {
164  $userid = User::idFromName( $user );
165  if ( $userid ) {
166  $this->addWhereFld( 'log_user', $userid );
167  } else {
168  $this->addWhereFld( 'log_user_text', $user );
169  }
170  }
171 
172  $title = $params['title'];
173  if ( !is_null( $title ) ) {
174  $titleObj = Title::newFromText( $title );
175  if ( is_null( $titleObj ) ) {
176  $this->dieUsage( "Bad title value '$title'", 'param_title' );
177  }
178  $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
179  $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
180  }
181 
182  if ( $params['namespace'] !== null ) {
183  $this->addWhereFld( 'log_namespace', $params['namespace'] );
184  }
185 
186  $prefix = $params['prefix'];
187 
188  if ( !is_null( $prefix ) ) {
189  if ( $this->getConfig()->get( 'MiserMode' ) ) {
190  $this->dieUsage( 'Prefix search disabled in Miser Mode', 'prefixsearchdisabled' );
191  }
192 
193  $title = Title::newFromText( $prefix );
194  if ( is_null( $title ) ) {
195  $this->dieUsage( "Bad title value '$prefix'", 'param_prefix' );
196  }
197  $this->addWhereFld( 'log_namespace', $title->getNamespace() );
198  $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) );
199  }
200 
201  // Paranoia: avoid brute force searches (bug 17342)
202  if ( $params['namespace'] !== null || !is_null( $title ) || !is_null( $user ) ) {
203  if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
204  $titleBits = LogPage::DELETED_ACTION;
205  $userBits = LogPage::DELETED_USER;
206  } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
209  } else {
210  $titleBits = 0;
211  $userBits = 0;
212  }
213  if ( ( $params['namespace'] !== null || !is_null( $title ) ) && $titleBits ) {
214  $this->addWhere( $db->bitAnd( 'log_deleted', $titleBits ) . " != $titleBits" );
215  }
216  if ( !is_null( $user ) && $userBits ) {
217  $this->addWhere( $db->bitAnd( 'log_deleted', $userBits ) . " != $userBits" );
218  }
219  }
220 
221  $count = 0;
222  $res = $this->select( __METHOD__ );
223  $result = $this->getResult();
224  foreach ( $res as $row ) {
225  if ( ++$count > $limit ) {
226  // We've reached the one extra which shows that there are
227  // additional pages to be had. Stop here...
228  $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
229  break;
230  }
231 
232  $vals = $this->extractRowInfo( $row );
233  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
234  if ( !$fit ) {
235  $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
236  break;
237  }
238  }
239  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'item' );
240  }
241 
253  public static function addLogParams( $result, &$vals, $params, $type,
254  $action, $ts, $legacy = false
255  ) {
256  wfDeprecated( __METHOD__, '1.25' );
257 
258  $entry = new ManualLogEntry( $type, $action );
259  $entry->setParameters( $params );
260  $entry->setTimestamp( $ts );
261  $entry->setLegacy( $legacy );
262  $formatter = LogFormatter::newFromEntry( $entry );
263  $vals['params'] = $formatter->formatParametersForApi();
264 
265  return $vals;
266  }
267 
268  private function extractRowInfo( $row ) {
269  $logEntry = DatabaseLogEntry::newFromRow( $row );
270  $vals = [
271  ApiResult::META_TYPE => 'assoc',
272  ];
273  $anyHidden = false;
274  $user = $this->getUser();
275 
276  if ( $this->fld_ids ) {
277  $vals['logid'] = intval( $row->log_id );
278  }
279 
280  if ( $this->fld_title || $this->fld_parsedcomment ) {
281  $title = Title::makeTitle( $row->log_namespace, $row->log_title );
282  }
283 
284  if ( $this->fld_title || $this->fld_ids || $this->fld_details && $row->log_params !== '' ) {
286  $vals['actionhidden'] = true;
287  $anyHidden = true;
288  }
290  if ( $this->fld_title ) {
292  }
293  if ( $this->fld_ids ) {
294  $vals['pageid'] = intval( $row->page_id );
295  $vals['logpage'] = intval( $row->log_page );
296  }
297  if ( $this->fld_details ) {
298  $vals['params'] = LogFormatter::newFromEntry( $logEntry )->formatParametersForApi();
299  }
300  }
301  }
302 
303  if ( $this->fld_type ) {
304  $vals['type'] = $row->log_type;
305  $vals['action'] = $row->log_action;
306  }
307 
308  if ( $this->fld_user || $this->fld_userid ) {
310  $vals['userhidden'] = true;
311  $anyHidden = true;
312  }
314  if ( $this->fld_user ) {
315  $vals['user'] = $row->user_name === null ? $row->log_user_text : $row->user_name;
316  }
317  if ( $this->fld_userid ) {
318  $vals['userid'] = intval( $row->log_user );
319  }
320 
321  if ( !$row->log_user ) {
322  $vals['anon'] = true;
323  }
324  }
325  }
326  if ( $this->fld_timestamp ) {
327  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->log_timestamp );
328  }
329 
330  if ( ( $this->fld_comment || $this->fld_parsedcomment ) && isset( $row->log_comment ) ) {
332  $vals['commenthidden'] = true;
333  $anyHidden = true;
334  }
336  if ( $this->fld_comment ) {
337  $vals['comment'] = $row->log_comment;
338  }
339 
340  if ( $this->fld_parsedcomment ) {
341  $vals['parsedcomment'] = Linker::formatComment( $row->log_comment, $title );
342  }
343  }
344  }
345 
346  if ( $this->fld_tags ) {
347  if ( $row->ts_tags ) {
348  $tags = explode( ',', $row->ts_tags );
349  ApiResult::setIndexedTagName( $tags, 'tag' );
350  $vals['tags'] = $tags;
351  } else {
352  $vals['tags'] = [];
353  }
354  }
355 
356  if ( $anyHidden && LogEventsList::isDeleted( $row, LogPage::DELETED_RESTRICTED ) ) {
357  $vals['suppressed'] = true;
358  }
359 
360  return $vals;
361  }
362 
366  private function getAllowedLogActions() {
367  $config = $this->getConfig();
368  return array_keys( array_merge(
369  $config->get( 'LogActions' ),
370  $config->get( 'LogActionsHandlers' )
371  ) );
372  }
373 
374  public function getCacheMode( $params ) {
375  if ( $this->userCanSeeRevDel() ) {
376  return 'private';
377  }
378  if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
379  // formatComment() calls wfMessage() among other things
380  return 'anon-public-user-private';
381  } elseif ( LogEventsList::getExcludeClause( $this->getDB(), 'user', $this->getUser() )
382  === LogEventsList::getExcludeClause( $this->getDB(), 'public' )
383  ) { // Output can only contain public data.
384  return 'public';
385  } else {
386  return 'anon-public-user-private';
387  }
388  }
389 
390  public function getAllowedParams( $flags = 0 ) {
391  $config = $this->getConfig();
392  $ret = [
393  'prop' => [
394  ApiBase::PARAM_ISMULTI => true,
395  ApiBase::PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details',
397  'ids',
398  'title',
399  'type',
400  'user',
401  'userid',
402  'timestamp',
403  'comment',
404  'parsedcomment',
405  'details',
406  'tags'
407  ],
409  ],
410  'type' => [
411  ApiBase::PARAM_TYPE => $config->get( 'LogTypes' )
412  ],
413  'action' => [
414  // validation on request is done in execute()
416  ? $this->getAllowedLogActions()
417  : null
418  ],
419  'start' => [
420  ApiBase::PARAM_TYPE => 'timestamp'
421  ],
422  'end' => [
423  ApiBase::PARAM_TYPE => 'timestamp'
424  ],
425  'dir' => [
426  ApiBase::PARAM_DFLT => 'older',
428  'newer',
429  'older'
430  ],
431  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
432  ],
433  'user' => [
434  ApiBase::PARAM_TYPE => 'user',
435  ],
436  'title' => null,
437  'namespace' => [
438  ApiBase::PARAM_TYPE => 'namespace'
439  ],
440  'prefix' => [],
441  'tag' => null,
442  'limit' => [
443  ApiBase::PARAM_DFLT => 10,
444  ApiBase::PARAM_TYPE => 'limit',
445  ApiBase::PARAM_MIN => 1,
448  ],
449  'continue' => [
450  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
451  ],
452  ];
453 
454  if ( $config->get( 'MiserMode' ) ) {
455  $ret['prefix'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
456  }
457 
458  return $ret;
459  }
460 
461  protected function getExamplesMessages() {
462  return [
463  'action=query&list=logevents'
464  => 'apihelp-query+logevents-example-simple',
465  ];
466  }
467 
468  public function getHelpUrls() {
469  return 'https://www.mediawiki.org/wiki/API:Logevents';
470  }
471 }
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
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
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
static userCan($row, $field, User $user=null)
Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.
static isDeleted($row, $field)
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
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
requireMaxOneParameter($params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:740
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const GET_VALUES_FOR_HELP
getAllowedParams() flag: When set, the result could take longer to generate, but should be more thoro...
Definition: ApiBase.php:190
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:177
static newFromEntry(LogEntry $entry)
Constructs a new formatter suitable for given entry.
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 META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
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.
__construct(ApiQuery $query, $moduleName)
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
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
static addLogParams($result, &$vals, $params, $type, $action, $ts, $legacy=false)
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
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const DELETED_COMMENT
Definition: LogPage.php:34
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
$res
Definition: database.txt:21
getConfig()
Get the Config object.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
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
const DELETED_RESTRICTED
Definition: LogPage.php:36
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_USER
Definition: LogPage.php:35
addFieldsIf($value, $condition)
Same as addFields(), but add the fields only if a condition is met.
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
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:394
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
setContinueEnumParameter($paramName, $paramValue)
Set a query-continue value.
static idFromName($name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:728
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
Query action to List the log events, with optional filtering by various parameters.
static newFromRow($row)
Constructs new LogEntry from database result row.
Definition: LogEntry.php:201
$count
const DELETED_ACTION
Definition: LogPage.php:33
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.
encodeParamName($paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:665
getUser()
Get the User object.
static getExcludeClause($db, $audience= 'public', User $user=null)
SQL clause to skip forbidden log types for this user.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511