MediaWiki REL1_35
ApiQueryImages.php
Go to the documentation of this file.
1<?php
30
31 public function __construct( ApiQuery $query, $moduleName ) {
32 parent::__construct( $query, $moduleName, 'im' );
33 }
34
35 public function execute() {
36 $this->run();
37 }
38
39 public function executeGenerator( $resultPageSet ) {
40 $this->run( $resultPageSet );
41 }
42
46 private function run( $resultPageSet = null ) {
47 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
48 return; // nothing to do
49 }
50
51 $params = $this->extractRequestParams();
52 $this->addFields( [
53 'il_from',
54 'il_to'
55 ] );
56
57 $this->addTables( 'imagelinks' );
58 $this->addWhereFld( 'il_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
59 if ( $params['continue'] !== null ) {
60 $cont = explode( '|', $params['continue'] );
61 $this->dieContinueUsageIf( count( $cont ) != 2 );
62 $op = $params['dir'] == 'descending' ? '<' : '>';
63 $ilfrom = (int)$cont[0];
64 $ilto = $this->getDB()->addQuotes( $cont[1] );
65 $this->addWhere(
66 "il_from $op $ilfrom OR " .
67 "(il_from = $ilfrom AND " .
68 "il_to $op= $ilto)"
69 );
70 }
71
72 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
73 // Don't order by il_from if it's constant in the WHERE clause
74 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
75 $this->addOption( 'ORDER BY', 'il_to' . $sort );
76 } else {
77 $this->addOption( 'ORDER BY', [
78 'il_from' . $sort,
79 'il_to' . $sort
80 ] );
81 }
82 $this->addOption( 'LIMIT', $params['limit'] + 1 );
83
84 if ( $params['images'] ) {
85 $images = [];
86 foreach ( $params['images'] as $img ) {
87 $title = Title::newFromText( $img );
88 if ( !$title || $title->getNamespace() != NS_FILE ) {
89 $this->addWarning( [ 'apiwarn-notfile', wfEscapeWikiText( $img ) ] );
90 } else {
91 $images[] = $title->getDBkey();
92 }
93 }
94 if ( !$images ) {
95 // No titles so no results
96 return;
97 }
98 $this->addWhereFld( 'il_to', $images );
99 }
100
101 $res = $this->select( __METHOD__ );
102
103 if ( $resultPageSet === null ) {
104 $count = 0;
105 foreach ( $res as $row ) {
106 if ( ++$count > $params['limit'] ) {
107 // We've reached the one extra which shows that
108 // there are additional pages to be had. Stop here...
109 $this->setContinueEnumParameter( 'continue', $row->il_from . '|' . $row->il_to );
110 break;
111 }
112 $vals = [];
113 ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( NS_FILE, $row->il_to ) );
114 $fit = $this->addPageSubItem( $row->il_from, $vals );
115 if ( !$fit ) {
116 $this->setContinueEnumParameter( 'continue', $row->il_from . '|' . $row->il_to );
117 break;
118 }
119 }
120 } else {
121 $titles = [];
122 $count = 0;
123 foreach ( $res as $row ) {
124 if ( ++$count > $params['limit'] ) {
125 // We've reached the one extra which shows that
126 // there are additional pages to be had. Stop here...
127 $this->setContinueEnumParameter( 'continue', $row->il_from . '|' . $row->il_to );
128 break;
129 }
130 $titles[] = Title::makeTitle( NS_FILE, $row->il_to );
131 }
132 $resultPageSet->populateFromTitles( $titles );
133 }
134 }
135
136 public function getCacheMode( $params ) {
137 return 'public';
138 }
139
140 public function getAllowedParams() {
141 return [
142 'limit' => [
144 ApiBase::PARAM_TYPE => 'limit',
148 ],
149 'continue' => [
150 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
151 ],
152 'images' => [
154 ],
155 'dir' => [
156 ApiBase::PARAM_DFLT => 'ascending',
158 'ascending',
159 'descending'
160 ]
161 ],
162 ];
163 }
164
165 protected function getExamplesMessages() {
166 return [
167 'action=query&prop=images&titles=Main%20Page'
168 => 'apihelp-query+images-example-simple',
169 'action=query&generator=images&titles=Main%20Page&prop=info'
170 => 'apihelp-query+images-example-generator',
171 ];
172 }
173
174 public function getHelpUrls() {
175 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Images';
176 }
177}
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
const PARAM_MAX2
Definition ApiBase.php:86
const PARAM_MAX
Definition ApiBase.php:82
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:1617
const PARAM_TYPE
Definition ApiBase.php:78
const PARAM_DFLT
Definition ApiBase.php:70
const PARAM_MIN
Definition ApiBase.php:90
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:220
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:772
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:162
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1356
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:222
const PARAM_ISMULTI
Definition ApiBase.php:74
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only) Stable to override.
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addWhere( $value)
Add a set of WHERE clauses to the internal array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
getPageSet()
Get the PageSet object to work on.
This query adds an "<images>" subelement to all pages with the list of images embedded into those pag...
executeGenerator( $resultPageSet)
Execute this module as a generator.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
__construct(ApiQuery $query, $moduleName)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getExamplesMessages()
Returns usage examples for this module.
getHelpUrls()
Return links to more detailed help pages about the module.
run( $resultPageSet=null)
This is the main query class.
Definition ApiQuery.php:37
const NS_FILE
Definition Defines.php:76