MediaWiki  1.30.0
ApiQueryAllImages.php
Go to the documentation of this file.
1 <?php
2 
30 
37  protected $mRepo;
38 
39  public function __construct( ApiQuery $query, $moduleName ) {
40  parent::__construct( $query, $moduleName, 'ai' );
41  $this->mRepo = RepoGroup::singleton()->getLocalRepo();
42  }
43 
51  protected function getDB() {
52  return $this->mRepo->getReplicaDB();
53  }
54 
55  public function execute() {
56  $this->run();
57  }
58 
59  public function getCacheMode( $params ) {
60  return 'public';
61  }
62 
67  public function executeGenerator( $resultPageSet ) {
68  if ( $resultPageSet->isResolvingRedirects() ) {
69  $this->dieWithError( 'apierror-allimages-redirect', 'invalidparammix' );
70  }
71 
72  $this->run( $resultPageSet );
73  }
74 
79  private function run( $resultPageSet = null ) {
80  $repo = $this->mRepo;
81  if ( !$repo instanceof LocalRepo ) {
82  $this->dieWithError( 'apierror-unsupportedrepo' );
83  }
84 
85  $prefix = $this->getModulePrefix();
86 
87  $db = $this->getDB();
88 
89  $params = $this->extractRequestParams();
90  $userId = !is_null( $params['user'] ) ? User::idFromName( $params['user'] ) : null;
91 
92  // Table and return fields
93  $this->addTables( 'image' );
94 
95  $prop = array_flip( $params['prop'] );
97 
98  $ascendingOrder = true;
99  if ( $params['dir'] == 'descending' || $params['dir'] == 'older' ) {
100  $ascendingOrder = false;
101  }
102 
103  if ( $params['sort'] == 'name' ) {
104  // Check mutually exclusive params
105  $disallowed = [ 'start', 'end', 'user' ];
106  foreach ( $disallowed as $pname ) {
107  if ( isset( $params[$pname] ) ) {
108  $this->dieWithError(
109  [
110  'apierror-invalidparammix-mustusewith',
111  "{$prefix}{$pname}",
112  "{$prefix}sort=timestamp"
113  ],
114  'invalidparammix'
115  );
116  }
117  }
118  if ( $params['filterbots'] != 'all' ) {
119  $this->dieWithError(
120  [
121  'apierror-invalidparammix-mustusewith',
122  "{$prefix}filterbots",
123  "{$prefix}sort=timestamp"
124  ],
125  'invalidparammix'
126  );
127  }
128 
129  // Pagination
130  if ( !is_null( $params['continue'] ) ) {
131  $cont = explode( '|', $params['continue'] );
132  $this->dieContinueUsageIf( count( $cont ) != 1 );
133  $op = ( $ascendingOrder ? '>' : '<' );
134  $continueFrom = $db->addQuotes( $cont[0] );
135  $this->addWhere( "img_name $op= $continueFrom" );
136  }
137 
138  // Image filters
139  $from = ( $params['from'] === null ? null : $this->titlePartToKey( $params['from'], NS_FILE ) );
140  $to = ( $params['to'] === null ? null : $this->titlePartToKey( $params['to'], NS_FILE ) );
141  $this->addWhereRange( 'img_name', ( $ascendingOrder ? 'newer' : 'older' ), $from, $to );
142 
143  if ( isset( $params['prefix'] ) ) {
144  $this->addWhere( 'img_name' . $db->buildLike(
145  $this->titlePartToKey( $params['prefix'], NS_FILE ),
146  $db->anyString() ) );
147  }
148  } else {
149  // Check mutually exclusive params
150  $disallowed = [ 'from', 'to', 'prefix' ];
151  foreach ( $disallowed as $pname ) {
152  if ( isset( $params[$pname] ) ) {
153  $this->dieWithError(
154  [
155  'apierror-invalidparammix-mustusewith',
156  "{$prefix}{$pname}",
157  "{$prefix}sort=name"
158  ],
159  'invalidparammix'
160  );
161  }
162  }
163  if ( !is_null( $params['user'] ) && $params['filterbots'] != 'all' ) {
164  // Since filterbots checks if each user has the bot right, it
165  // doesn't make sense to use it with user
166  $this->dieWithError(
167  [ 'apierror-invalidparammix-cannotusewith', "{$prefix}user", "{$prefix}filterbots" ]
168  );
169  }
170 
171  // Pagination
172  $this->addTimestampWhereRange(
173  'img_timestamp',
174  $ascendingOrder ? 'newer' : 'older',
175  $params['start'],
176  $params['end']
177  );
178  // Include in ORDER BY for uniqueness
179  $this->addWhereRange( 'img_name', $ascendingOrder ? 'newer' : 'older', null, null );
180 
181  if ( !is_null( $params['continue'] ) ) {
182  $cont = explode( '|', $params['continue'] );
183  $this->dieContinueUsageIf( count( $cont ) != 2 );
184  $op = ( $ascendingOrder ? '>' : '<' );
185  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
186  $continueName = $db->addQuotes( $cont[1] );
187  $this->addWhere( "img_timestamp $op $continueTimestamp OR " .
188  "(img_timestamp = $continueTimestamp AND " .
189  "img_name $op= $continueName)"
190  );
191  }
192 
193  // Image filters
194  if ( !is_null( $params['user'] ) ) {
195  if ( $userId ) {
196  $this->addWhereFld( 'img_user', $userId );
197  } else {
198  $this->addWhereFld( 'img_user_text', $params['user'] );
199  }
200  }
201  if ( $params['filterbots'] != 'all' ) {
202  $this->addTables( 'user_groups' );
203  $this->addJoinConds( [ 'user_groups' => [
204  'LEFT JOIN',
205  [
206  'ug_group' => User::getGroupsWithPermission( 'bot' ),
207  'ug_user = img_user',
208  'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
209  ]
210  ] ] );
211  $groupCond = ( $params['filterbots'] == 'nobots' ? 'NULL' : 'NOT NULL' );
212  $this->addWhere( "ug_group IS $groupCond" );
213  }
214  }
215 
216  // Filters not depending on sort
217  if ( isset( $params['minsize'] ) ) {
218  $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
219  }
220 
221  if ( isset( $params['maxsize'] ) ) {
222  $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
223  }
224 
225  $sha1 = false;
226  if ( isset( $params['sha1'] ) ) {
227  $sha1 = strtolower( $params['sha1'] );
228  if ( !$this->validateSha1Hash( $sha1 ) ) {
229  $this->dieWithError( 'apierror-invalidsha1hash' );
230  }
231  $sha1 = Wikimedia\base_convert( $sha1, 16, 36, 31 );
232  } elseif ( isset( $params['sha1base36'] ) ) {
233  $sha1 = strtolower( $params['sha1base36'] );
234  if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
235  $this->dieWithError( 'apierror-invalidsha1base36hash' );
236  }
237  }
238  if ( $sha1 ) {
239  $this->addWhereFld( 'img_sha1', $sha1 );
240  }
241 
242  if ( !is_null( $params['mime'] ) ) {
243  if ( $this->getConfig()->get( 'MiserMode' ) ) {
244  $this->dieWithError( 'apierror-mimesearchdisabled' );
245  }
246 
247  $mimeConds = [];
248  foreach ( $params['mime'] as $mime ) {
249  list( $major, $minor ) = File::splitMime( $mime );
250  $mimeConds[] = $db->makeList(
251  [
252  'img_major_mime' => $major,
253  'img_minor_mime' => $minor,
254  ],
255  LIST_AND
256  );
257  }
258  // safeguard against internal_api_error_DBQueryError
259  if ( count( $mimeConds ) > 0 ) {
260  $this->addWhere( $db->makeList( $mimeConds, LIST_OR ) );
261  } else {
262  // no MIME types, no files
263  $this->getResult()->addValue( 'query', $this->getModuleName(), [] );
264  return;
265  }
266  }
267 
268  $limit = $params['limit'];
269  $this->addOption( 'LIMIT', $limit + 1 );
270  $sortFlag = '';
271  if ( !$ascendingOrder ) {
272  $sortFlag = ' DESC';
273  }
274  if ( $params['sort'] == 'timestamp' ) {
275  $this->addOption( 'ORDER BY', 'img_timestamp' . $sortFlag );
276  if ( !is_null( $params['user'] ) ) {
277  if ( $userId ) {
278  $this->addOption( 'USE INDEX', [ 'image' => 'img_user_timestamp' ] );
279  } else {
280  $this->addOption( 'USE INDEX', [ 'image' => 'img_usertext_timestamp' ] );
281  }
282  } else {
283  $this->addOption( 'USE INDEX', [ 'image' => 'img_timestamp' ] );
284  }
285  } else {
286  $this->addOption( 'ORDER BY', 'img_name' . $sortFlag );
287  }
288 
289  $res = $this->select( __METHOD__ );
290 
291  $titles = [];
292  $count = 0;
293  $result = $this->getResult();
294  foreach ( $res as $row ) {
295  if ( ++$count > $limit ) {
296  // We've reached the one extra which shows that there are
297  // additional pages to be had. Stop here...
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 
306  if ( is_null( $resultPageSet ) ) {
307  $file = $repo->newFileFromRow( $row );
308  $info = array_merge( [ 'name' => $row->img_name ],
309  ApiQueryImageInfo::getInfo( $file, $prop, $result ) );
310  self::addTitleInfo( $info, $file->getTitle() );
311 
312  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $info );
313  if ( !$fit ) {
314  if ( $params['sort'] == 'name' ) {
315  $this->setContinueEnumParameter( 'continue', $row->img_name );
316  } else {
317  $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
318  }
319  break;
320  }
321  } else {
322  $titles[] = Title::makeTitle( NS_FILE, $row->img_name );
323  }
324  }
325 
326  if ( is_null( $resultPageSet ) ) {
327  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'img' );
328  } else {
329  $resultPageSet->populateFromTitles( $titles );
330  }
331  }
332 
333  public function getAllowedParams() {
334  $ret = [
335  'sort' => [
336  ApiBase::PARAM_DFLT => 'name',
338  'name',
339  'timestamp'
340  ]
341  ],
342  'dir' => [
343  ApiBase::PARAM_DFLT => 'ascending',
345  // sort=name
346  'ascending',
347  'descending',
348  // sort=timestamp
349  'newer',
350  'older'
351  ]
352  ],
353  'from' => null,
354  'to' => null,
355  'continue' => [
356  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
357  ],
358  'start' => [
359  ApiBase::PARAM_TYPE => 'timestamp'
360  ],
361  'end' => [
362  ApiBase::PARAM_TYPE => 'timestamp'
363  ],
364  'prop' => [
365  ApiBase::PARAM_TYPE => ApiQueryImageInfo::getPropertyNames( $this->propertyFilter ),
366  ApiBase::PARAM_DFLT => 'timestamp|url',
367  ApiBase::PARAM_ISMULTI => true,
368  ApiBase::PARAM_HELP_MSG => 'apihelp-query+imageinfo-param-prop',
370  ApiQueryImageInfo::getPropertyMessages( $this->propertyFilter ),
371  ],
372  'prefix' => null,
373  'minsize' => [
374  ApiBase::PARAM_TYPE => 'integer',
375  ],
376  'maxsize' => [
377  ApiBase::PARAM_TYPE => 'integer',
378  ],
379  'sha1' => null,
380  'sha1base36' => null,
381  'user' => [
382  ApiBase::PARAM_TYPE => 'user'
383  ],
384  'filterbots' => [
385  ApiBase::PARAM_DFLT => 'all',
387  'all',
388  'bots',
389  'nobots'
390  ]
391  ],
392  'mime' => [
393  ApiBase::PARAM_ISMULTI => true,
394  ],
395  'limit' => [
396  ApiBase::PARAM_DFLT => 10,
397  ApiBase::PARAM_TYPE => 'limit',
398  ApiBase::PARAM_MIN => 1,
401  ],
402  ];
403 
404  if ( $this->getConfig()->get( 'MiserMode' ) ) {
405  $ret['mime'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
406  }
407 
408  return $ret;
409  }
410 
411  private $propertyFilter = [ 'archivename', 'thumbmime', 'uploadwarning' ];
412 
413  protected function getExamplesMessages() {
414  return [
415  'action=query&list=allimages&aifrom=B'
416  => 'apihelp-query+allimages-example-B',
417  'action=query&list=allimages&aiprop=user|timestamp|url&' .
418  'aisort=timestamp&aidir=older'
419  => 'apihelp-query+allimages-example-recent',
420  'action=query&list=allimages&aimime=image/png|image/gif'
421  => 'apihelp-query+allimages-example-mimetypes',
422  'action=query&generator=allimages&gailimit=4&' .
423  'gaifrom=T&prop=imageinfo'
424  => 'apihelp-query+allimages-example-generator',
425  ];
426  }
427 
428  public function getHelpUrls() {
429  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allimages';
430  }
431 }
ApiQueryBase\validateSha1Base36Hash
validateSha1Base36Hash( $hash)
Definition: ApiQueryBase.php:597
ContextSource\getConfig
getConfig()
Get the Config object.
Definition: ContextSource.php:68
ApiQueryImageInfo\getPropertyNames
static getPropertyNames( $filter=[])
Returns all possible parameters to iiprop.
Definition: ApiQueryImageInfo.php:723
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:196
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
ApiQueryAllImages\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryAllImages.php:39
captcha-old.count
count
Definition: captcha-old.py:249
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1855
ApiQueryBase\addTimestampWhereRange
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
Definition: ApiQueryBase.php:319
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. 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:Array with elements of the form "language:title" in the order that they will be output. & $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:1963
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:632
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ApiQueryAllImages\getDB
getDB()
Override parent method to make sure the repo's DB is used which may not necessarily be the same as th...
Definition: ApiQueryAllImages.php:51
NS_FILE
const NS_FILE
Definition: Defines.php:71
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
File\splitMime
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:273
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:331
ApiQueryImageInfo\getInfo
static getInfo( $file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
Definition: ApiQueryImageInfo.php:375
php
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
LIST_AND
const LIST_AND
Definition: Defines.php:44
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:88
$query
null for the 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:1581
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:103
LIST_OR
const LIST_OR
Definition: Defines.php:47
ApiQueryAllImages\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryAllImages.php:428
$titles
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
ApiQueryAllImages\executeGenerator
executeGenerator( $resultPageSet)
Definition: ApiQueryAllImages.php:67
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:225
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:94
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:162
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:356
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:529
list
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
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:520
ApiQueryBase\addWhereRange
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.
Definition: ApiQueryBase.php:284
$mime
if( $ext=='php'|| $ext=='php5') $mime
Definition: router.php:65
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:740
ApiQueryAllImages\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryAllImages.php:333
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2026
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:185
$ret
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:1965
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:264
ApiQueryAllImages\$mRepo
$mRepo
Definition: ApiQueryAllImages.php:37
ApiQueryAllImages\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryAllImages.php:55
ApiQueryAllImages\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryAllImages.php:59
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:30
LocalFile\selectFields
static selectFields()
Fields in the image table.
Definition: LocalFile.php:200
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:227
ApiQueryAllImages
Query module to enumerate all available pages.
Definition: ApiQueryAllImages.php:36
User\idFromName
static idFromName( $name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:765
ApiQueryAllImages\run
run( $resultPageSet=null)
Definition: ApiQueryAllImages.php:79
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:100
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:231
ApiQueryAllImages\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryAllImages.php:413
ApiQueryImageInfo\getPropertyMessages
static getPropertyMessages( $filter=[])
Returns messages for all possible parameters to iiprop.
Definition: ApiQueryImageInfo.php:733
ApiBase\PARAM_HELP_MSG_PER_VALUE
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:160
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
Definition: ApiQueryBase.php:549
ApiQueryAllImages\$propertyFilter
$propertyFilter
Definition: ApiQueryAllImages.php:411
LocalRepo
A repository that stores files in the local filesystem and registers them in the wiki's own database.
Definition: LocalRepo.php:35
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:486
User\getGroupsWithPermission
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
Definition: User.php:4768
ApiQueryBase\validateSha1Hash
validateSha1Hash( $hash)
Definition: ApiQueryBase.php:589