MediaWiki  1.28.0
ApiQueryAllImages.php
Go to the documentation of this file.
1 <?php
2 
35  protected $mRepo;
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  parent::__construct( $query, $moduleName, 'ai' );
39  $this->mRepo = RepoGroup::singleton()->getLocalRepo();
40  }
41 
49  protected function getDB() {
50  return $this->mRepo->getSlaveDB();
51  }
52 
53  public function execute() {
54  $this->run();
55  }
56 
57  public function getCacheMode( $params ) {
58  return 'public';
59  }
60 
65  public function executeGenerator( $resultPageSet ) {
66  if ( $resultPageSet->isResolvingRedirects() ) {
67  $this->dieUsage(
68  'Use "gaifilterredir=nonredirects" option instead of "redirects" ' .
69  'when using allimages as a generator',
70  'params'
71  );
72  }
73 
74  $this->run( $resultPageSet );
75  }
76 
81  private function run( $resultPageSet = null ) {
82  $repo = $this->mRepo;
83  if ( !$repo instanceof LocalRepo ) {
84  $this->dieUsage(
85  'Local file repository does not support querying all images',
86  'unsupportedrepo'
87  );
88  }
89 
90  $prefix = $this->getModulePrefix();
91 
92  $db = $this->getDB();
93 
94  $params = $this->extractRequestParams();
95 
96  // Table and return fields
97  $this->addTables( 'image' );
98 
99  $prop = array_flip( $params['prop'] );
101 
102  $ascendingOrder = true;
103  if ( $params['dir'] == 'descending' || $params['dir'] == 'older' ) {
104  $ascendingOrder = false;
105  }
106 
107  if ( $params['sort'] == 'name' ) {
108  // Check mutually exclusive params
109  $disallowed = [ 'start', 'end', 'user' ];
110  foreach ( $disallowed as $pname ) {
111  if ( isset( $params[$pname] ) ) {
112  $this->dieUsage(
113  "Parameter '{$prefix}{$pname}' can only be used with {$prefix}sort=timestamp",
114  'badparams'
115  );
116  }
117  }
118  if ( $params['filterbots'] != 'all' ) {
119  $this->dieUsage(
120  "Parameter '{$prefix}filterbots' can only be used with {$prefix}sort=timestamp",
121  'badparams'
122  );
123  }
124 
125  // Pagination
126  if ( !is_null( $params['continue'] ) ) {
127  $cont = explode( '|', $params['continue'] );
128  $this->dieContinueUsageIf( count( $cont ) != 1 );
129  $op = ( $ascendingOrder ? '>' : '<' );
130  $continueFrom = $db->addQuotes( $cont[0] );
131  $this->addWhere( "img_name $op= $continueFrom" );
132  }
133 
134  // Image filters
135  $from = ( $params['from'] === null ? null : $this->titlePartToKey( $params['from'], NS_FILE ) );
136  $to = ( $params['to'] === null ? null : $this->titlePartToKey( $params['to'], NS_FILE ) );
137  $this->addWhereRange( 'img_name', ( $ascendingOrder ? 'newer' : 'older' ), $from, $to );
138 
139  if ( isset( $params['prefix'] ) ) {
140  $this->addWhere( 'img_name' . $db->buildLike(
141  $this->titlePartToKey( $params['prefix'], NS_FILE ),
142  $db->anyString() ) );
143  }
144  } else {
145  // Check mutually exclusive params
146  $disallowed = [ 'from', 'to', 'prefix' ];
147  foreach ( $disallowed as $pname ) {
148  if ( isset( $params[$pname] ) ) {
149  $this->dieUsage(
150  "Parameter '{$prefix}{$pname}' can only be used with {$prefix}sort=name",
151  'badparams'
152  );
153  }
154  }
155  if ( !is_null( $params['user'] ) && $params['filterbots'] != 'all' ) {
156  // Since filterbots checks if each user has the bot right, it
157  // doesn't make sense to use it with user
158  $this->dieUsage(
159  "Parameters '{$prefix}user' and '{$prefix}filterbots' cannot be used together",
160  'badparams'
161  );
162  }
163 
164  // Pagination
165  $this->addTimestampWhereRange(
166  'img_timestamp',
167  $ascendingOrder ? 'newer' : 'older',
168  $params['start'],
169  $params['end']
170  );
171  // Include in ORDER BY for uniqueness
172  $this->addWhereRange( 'img_name', $ascendingOrder ? 'newer' : 'older', null, null );
173 
174  if ( !is_null( $params['continue'] ) ) {
175  $cont = explode( '|', $params['continue'] );
176  $this->dieContinueUsageIf( count( $cont ) != 2 );
177  $op = ( $ascendingOrder ? '>' : '<' );
178  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
179  $continueName = $db->addQuotes( $cont[1] );
180  $this->addWhere( "img_timestamp $op $continueTimestamp OR " .
181  "(img_timestamp = $continueTimestamp AND " .
182  "img_name $op= $continueName)"
183  );
184  }
185 
186  // Image filters
187  if ( !is_null( $params['user'] ) ) {
188  $this->addWhereFld( 'img_user_text', $params['user'] );
189  }
190  if ( $params['filterbots'] != 'all' ) {
191  $this->addTables( 'user_groups' );
192  $this->addJoinConds( [ 'user_groups' => [
193  'LEFT JOIN',
194  [
195  'ug_group' => User::getGroupsWithPermission( 'bot' ),
196  'ug_user = img_user'
197  ]
198  ] ] );
199  $groupCond = ( $params['filterbots'] == 'nobots' ? 'NULL' : 'NOT NULL' );
200  $this->addWhere( "ug_group IS $groupCond" );
201  }
202  }
203 
204  // Filters not depending on sort
205  if ( isset( $params['minsize'] ) ) {
206  $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
207  }
208 
209  if ( isset( $params['maxsize'] ) ) {
210  $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
211  }
212 
213  $sha1 = false;
214  if ( isset( $params['sha1'] ) ) {
215  $sha1 = strtolower( $params['sha1'] );
216  if ( !$this->validateSha1Hash( $sha1 ) ) {
217  $this->dieUsage( 'The SHA1 hash provided is not valid', 'invalidsha1hash' );
218  }
219  $sha1 = Wikimedia\base_convert( $sha1, 16, 36, 31 );
220  } elseif ( isset( $params['sha1base36'] ) ) {
221  $sha1 = strtolower( $params['sha1base36'] );
222  if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
223  $this->dieUsage( 'The SHA1Base36 hash provided is not valid', 'invalidsha1base36hash' );
224  }
225  }
226  if ( $sha1 ) {
227  $this->addWhereFld( 'img_sha1', $sha1 );
228  }
229 
230  if ( !is_null( $params['mime'] ) ) {
231  if ( $this->getConfig()->get( 'MiserMode' ) ) {
232  $this->dieUsage( 'MIME search disabled in Miser Mode', 'mimesearchdisabled' );
233  }
234 
235  $mimeConds = [];
236  foreach ( $params['mime'] as $mime ) {
237  list( $major, $minor ) = File::splitMime( $mime );
238  $mimeConds[] = $db->makeList(
239  [
240  'img_major_mime' => $major,
241  'img_minor_mime' => $minor,
242  ],
243  LIST_AND
244  );
245  }
246  // safeguard against internal_api_error_DBQueryError
247  if ( count( $mimeConds ) > 0 ) {
248  $this->addWhere( $db->makeList( $mimeConds, LIST_OR ) );
249  } else {
250  // no MIME types, no files
251  $this->getResult()->addValue( 'query', $this->getModuleName(), [] );
252  return;
253  }
254  }
255 
256  $limit = $params['limit'];
257  $this->addOption( 'LIMIT', $limit + 1 );
258  $sortFlag = '';
259  if ( !$ascendingOrder ) {
260  $sortFlag = ' DESC';
261  }
262  if ( $params['sort'] == 'timestamp' ) {
263  $this->addOption( 'ORDER BY', 'img_timestamp' . $sortFlag );
264  if ( !is_null( $params['user'] ) ) {
265  $this->addOption( 'USE INDEX', [ 'image' => 'img_usertext_timestamp' ] );
266  } else {
267  $this->addOption( 'USE INDEX', [ 'image' => 'img_timestamp' ] );
268  }
269  } else {
270  $this->addOption( 'ORDER BY', 'img_name' . $sortFlag );
271  }
272 
273  $res = $this->select( __METHOD__ );
274 
275  $titles = [];
276  $count = 0;
277  $result = $this->getResult();
278  foreach ( $res as $row ) {
279  if ( ++$count > $limit ) {
280  // We've reached the one extra which shows that there are
281  // additional pages to be had. Stop here...
282  if ( $params['sort'] == 'name' ) {
283  $this->setContinueEnumParameter( 'continue', $row->img_name );
284  } else {
285  $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
286  }
287  break;
288  }
289 
290  if ( is_null( $resultPageSet ) ) {
291  $file = $repo->newFileFromRow( $row );
292  $info = array_merge( [ 'name' => $row->img_name ],
293  ApiQueryImageInfo::getInfo( $file, $prop, $result ) );
294  self::addTitleInfo( $info, $file->getTitle() );
295 
296  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $info );
297  if ( !$fit ) {
298  if ( $params['sort'] == 'name' ) {
299  $this->setContinueEnumParameter( 'continue', $row->img_name );
300  } else {
301  $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
302  }
303  break;
304  }
305  } else {
306  $titles[] = Title::makeTitle( NS_FILE, $row->img_name );
307  }
308  }
309 
310  if ( is_null( $resultPageSet ) ) {
311  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'img' );
312  } else {
313  $resultPageSet->populateFromTitles( $titles );
314  }
315  }
316 
317  public function getAllowedParams() {
318  $ret = [
319  'sort' => [
320  ApiBase::PARAM_DFLT => 'name',
322  'name',
323  'timestamp'
324  ]
325  ],
326  'dir' => [
327  ApiBase::PARAM_DFLT => 'ascending',
329  // sort=name
330  'ascending',
331  'descending',
332  // sort=timestamp
333  'newer',
334  'older'
335  ]
336  ],
337  'from' => null,
338  'to' => null,
339  'continue' => [
340  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
341  ],
342  'start' => [
343  ApiBase::PARAM_TYPE => 'timestamp'
344  ],
345  'end' => [
346  ApiBase::PARAM_TYPE => 'timestamp'
347  ],
348  'prop' => [
349  ApiBase::PARAM_TYPE => ApiQueryImageInfo::getPropertyNames( $this->propertyFilter ),
350  ApiBase::PARAM_DFLT => 'timestamp|url',
351  ApiBase::PARAM_ISMULTI => true,
352  ApiBase::PARAM_HELP_MSG => 'apihelp-query+imageinfo-param-prop',
354  ApiQueryImageInfo::getPropertyMessages( $this->propertyFilter ),
355  ],
356  'prefix' => null,
357  'minsize' => [
358  ApiBase::PARAM_TYPE => 'integer',
359  ],
360  'maxsize' => [
361  ApiBase::PARAM_TYPE => 'integer',
362  ],
363  'sha1' => null,
364  'sha1base36' => null,
365  'user' => [
366  ApiBase::PARAM_TYPE => 'user'
367  ],
368  'filterbots' => [
369  ApiBase::PARAM_DFLT => 'all',
371  'all',
372  'bots',
373  'nobots'
374  ]
375  ],
376  'mime' => [
377  ApiBase::PARAM_ISMULTI => true,
378  ],
379  'limit' => [
380  ApiBase::PARAM_DFLT => 10,
381  ApiBase::PARAM_TYPE => 'limit',
382  ApiBase::PARAM_MIN => 1,
385  ],
386  ];
387 
388  if ( $this->getConfig()->get( 'MiserMode' ) ) {
389  $ret['mime'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
390  }
391 
392  return $ret;
393  }
394 
395  private $propertyFilter = [ 'archivename', 'thumbmime', 'uploadwarning' ];
396 
397  protected function getExamplesMessages() {
398  return [
399  'action=query&list=allimages&aifrom=B'
400  => 'apihelp-query+allimages-example-B',
401  'action=query&list=allimages&aiprop=user|timestamp|url&' .
402  'aisort=timestamp&aidir=older'
403  => 'apihelp-query+allimages-example-recent',
404  'action=query&list=allimages&aimime=image/png|image/gif'
405  => 'apihelp-query+allimages-example-mimetypes',
406  'action=query&generator=allimages&gailimit=4&' .
407  'gaifrom=T&prop=imageinfo'
408  => 'apihelp-query+allimages-example-generator',
409  ];
410  }
411 
412  public function getHelpUrls() {
413  return 'https://www.mediawiki.org/wiki/API:Allimages';
414  }
415 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
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 splitMime($mime)
Split an internet media type into its two components; if not a two-part name, set the minor type to '...
Definition: File.php:272
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
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
__construct(ApiQuery $query, $moduleName)
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
A repository that stores files in the local filesystem and registers them in the wiki's own database...
Definition: LocalRepo.php:31
if($ext== 'php'||$ext== 'php5') $mime
Definition: router.php:65
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...
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.
addJoinConds($join_conds)
Add a set of JOIN conditions to the internal array.
validateSha1Hash($hash)
executeGenerator($resultPageSet)
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
getDB()
Override parent method to make sure the repo's DB is used which may not necessarily be the same as th...
const LIST_AND
Definition: Defines.php:35
$res
Definition: database.txt:21
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
static getPropertyMessages($filter=[])
Returns messages for all possible parameters to iiprop.
run($resultPageSet=null)
static selectFields()
Fields in the image table.
Definition: LocalFile.php:196
getConfig()
Get the Config object.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
static getPropertyNames($filter=[])
Returns all possible parameters to iiprop.
$params
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
const NS_FILE
Definition: Defines.php:62
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 PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
const LIST_OR
Definition: Defines.php:38
validateSha1Base36Hash($hash)
$from
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.
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
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.
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
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
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
Query module to enumerate all available pages.
static getInfo($file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
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
static getGroupsWithPermission($role)
Get all the groups who have a given permission.
Definition: User.php:4602