MediaWiki  master
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' => [
143  ApiBase::PARAM_DFLT => 10,
144  ApiBase::PARAM_TYPE => 'limit',
145  ApiBase::PARAM_MIN => 1,
148  ],
149  'continue' => [
150  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
151  ],
152  'images' => [
153  ApiBase::PARAM_ISMULTI => true,
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 }
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:329
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:208
ApiQuery
This is the main query class.
Definition: ApiQuery.php:37
ApiBase\addWarning
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1334
ApiQueryImages
This query adds an "<images>" subelement to all pages with the list of images embedded into those pag...
Definition: ApiQueryImages.php:29
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:104
ApiQueryImages\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryImages.php:39
ApiBase\PARAM_TYPE
const PARAM_TYPE
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:68
NS_FILE
const NS_FILE
Definition: Defines.php:75
ApiQueryImages\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryImages.php:35
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:374
$res
$res
Definition: testCompression.php:57
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:81
ApiBase\PARAM_MIN
const PARAM_MIN
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:71
ApiQueryGeneratorBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryGeneratorBase.php:55
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:162
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:113
ApiBase\PARAM_MAX
const PARAM_MAX
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:69
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:178
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:395
ApiQueryImages\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryImages.php:165
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:695
ApiQueryImages\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryImages.php:31
$title
$title
Definition: testCompression.php:38
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1595
ApiQueryImages\run
run( $resultPageSet=null)
Definition: ApiQueryImages.php:46
ApiQueryImages\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryImages.php:136
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1490
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
Definition: ApiQueryBase.php:278
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:164
ApiBase\PARAM_DFLT
const PARAM_DFLT
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:66
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:67
ApiBase\PARAM_MAX2
const PARAM_MAX2
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:70
ApiQueryImages\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryImages.php:140
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:241
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:491
ApiQueryImages\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryImages.php:174
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:463