MediaWiki  master
ApiQueryCategories.php
Go to the documentation of this file.
1 <?php
29 
30  public function __construct( ApiQuery $query, $moduleName ) {
31  parent::__construct( $query, $moduleName, 'cl' );
32  }
33 
34  public function execute() {
35  $this->run();
36  }
37 
38  public function getCacheMode( $params ) {
39  return 'public';
40  }
41 
42  public function executeGenerator( $resultPageSet ) {
43  $this->run( $resultPageSet );
44  }
45 
49  private function run( $resultPageSet = null ) {
50  if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
51  return; // nothing to do
52  }
53 
54  $params = $this->extractRequestParams();
55  $prop = array_flip( (array)$params['prop'] );
56  $show = array_flip( (array)$params['show'] );
57 
58  $this->addFields( [
59  'cl_from',
60  'cl_to'
61  ] );
62 
63  $this->addFieldsIf( [ 'cl_sortkey', 'cl_sortkey_prefix' ], isset( $prop['sortkey'] ) );
64  $this->addFieldsIf( 'cl_timestamp', isset( $prop['timestamp'] ) );
65 
66  $this->addTables( 'categorylinks' );
67  $this->addWhereFld( 'cl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
68  if ( $params['categories'] ) {
69  $cats = [];
70  foreach ( $params['categories'] as $cat ) {
71  $title = Title::newFromText( $cat );
72  if ( !$title || $title->getNamespace() != NS_CATEGORY ) {
73  $this->addWarning( [ 'apiwarn-invalidcategory', wfEscapeWikiText( $cat ) ] );
74  } else {
75  $cats[] = $title->getDBkey();
76  }
77  }
78  if ( !$cats ) {
79  // No titles so no results
80  return;
81  }
82  $this->addWhereFld( 'cl_to', $cats );
83  }
84 
85  if ( $params['continue'] !== null ) {
86  $cont = explode( '|', $params['continue'] );
87  $this->dieContinueUsageIf( count( $cont ) != 2 );
88  $op = $params['dir'] == 'descending' ? '<' : '>';
89  $clfrom = (int)$cont[0];
90  $clto = $this->getDB()->addQuotes( $cont[1] );
91  $this->addWhere(
92  "cl_from $op $clfrom OR " .
93  "(cl_from = $clfrom AND " .
94  "cl_to $op= $clto)"
95  );
96  }
97 
98  if ( isset( $show['hidden'] ) && isset( $show['!hidden'] ) ) {
99  $this->dieWithError( 'apierror-show' );
100  }
101  if ( isset( $show['hidden'] ) || isset( $show['!hidden'] ) || isset( $prop['hidden'] ) ) {
102  $this->addOption( 'STRAIGHT_JOIN' );
103  $this->addTables( [ 'page', 'page_props' ] );
104  $this->addFieldsIf( 'pp_propname', isset( $prop['hidden'] ) );
105  $this->addJoinConds( [
106  'page' => [ 'LEFT JOIN', [
107  'page_namespace' => NS_CATEGORY,
108  'page_title = cl_to' ] ],
109  'page_props' => [ 'LEFT JOIN', [
110  'pp_page=page_id',
111  'pp_propname' => 'hiddencat' ] ]
112  ] );
113  if ( isset( $show['hidden'] ) ) {
114  $this->addWhere( [ 'pp_propname IS NOT NULL' ] );
115  } elseif ( isset( $show['!hidden'] ) ) {
116  $this->addWhere( [ 'pp_propname IS NULL' ] );
117  }
118  }
119 
120  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
121  // Don't order by cl_from if it's constant in the WHERE clause
122  if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
123  $this->addOption( 'ORDER BY', 'cl_to' . $sort );
124  } else {
125  $this->addOption( 'ORDER BY', [
126  'cl_from' . $sort,
127  'cl_to' . $sort
128  ] );
129  }
130  $this->addOption( 'LIMIT', $params['limit'] + 1 );
131 
132  $res = $this->select( __METHOD__ );
133 
134  $count = 0;
135  if ( $resultPageSet === null ) {
136  foreach ( $res as $row ) {
137  if ( ++$count > $params['limit'] ) {
138  // We've reached the one extra which shows that
139  // there are additional pages to be had. Stop here...
140  $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
141  break;
142  }
143 
144  $title = Title::makeTitle( NS_CATEGORY, $row->cl_to );
145  $vals = [];
147  if ( isset( $prop['sortkey'] ) ) {
148  $vals['sortkey'] = bin2hex( $row->cl_sortkey );
149  $vals['sortkeyprefix'] = $row->cl_sortkey_prefix;
150  }
151  if ( isset( $prop['timestamp'] ) ) {
152  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
153  }
154  if ( isset( $prop['hidden'] ) ) {
155  $vals['hidden'] = $row->pp_propname !== null;
156  }
157 
158  $fit = $this->addPageSubItem( $row->cl_from, $vals );
159  if ( !$fit ) {
160  $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
161  break;
162  }
163  }
164  } else {
165  $titles = [];
166  foreach ( $res as $row ) {
167  if ( ++$count > $params['limit'] ) {
168  // We've reached the one extra which shows that
169  // there are additional pages to be had. Stop here...
170  $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
171  break;
172  }
173 
174  $titles[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
175  }
176  $resultPageSet->populateFromTitles( $titles );
177  }
178  }
179 
180  public function getAllowedParams() {
181  return [
182  'prop' => [
183  ApiBase::PARAM_ISMULTI => true,
185  'sortkey',
186  'timestamp',
187  'hidden',
188  ],
190  ],
191  'show' => [
192  ApiBase::PARAM_ISMULTI => true,
194  'hidden',
195  '!hidden',
196  ]
197  ],
198  'limit' => [
199  ApiBase::PARAM_DFLT => 10,
200  ApiBase::PARAM_TYPE => 'limit',
201  ApiBase::PARAM_MIN => 1,
204  ],
205  'continue' => [
206  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
207  ],
208  'categories' => [
209  ApiBase::PARAM_ISMULTI => true,
210  ],
211  'dir' => [
212  ApiBase::PARAM_DFLT => 'ascending',
214  'ascending',
215  'descending'
216  ]
217  ],
218  ];
219  }
220 
221  protected function getExamplesMessages() {
222  return [
223  'action=query&prop=categories&titles=Albert%20Einstein'
224  => 'apihelp-query+categories-example-simple',
225  'action=query&generator=categories&titles=Albert%20Einstein&prop=info'
226  => 'apihelp-query+categories-example-generator',
227  ];
228  }
229 
230  public function getHelpUrls() {
231  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categories';
232  }
233 }
ApiQueryCategories
A query module to enumerate categories the set of pages belong to.
Definition: ApiQueryCategories.php:28
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:332
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:193
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:1298
ApiQueryCategories\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryCategories.php:180
ApiQueryCategories\run
run( $resultPageSet=null)
Definition: ApiQueryCategories.php:49
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1379
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:96
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1809
ApiBase\PARAM_TYPE
const PARAM_TYPE
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:60
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:369
$res
$res
Definition: testCompression.php:57
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:207
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
ApiQueryCategories\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryCategories.php:221
ApiBase\PARAM_MIN
const PARAM_MIN
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:63
ApiQueryGeneratorBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryGeneratorBase.php:58
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:154
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:107
ApiBase\PARAM_MAX
const PARAM_MAX
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:61
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:161
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:394
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:659
$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:595
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:83
ApiQueryCategories\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryCategories.php:42
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1559
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:182
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1488
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
Definition: ApiQueryBase.php:267
ApiQueryCategories\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryCategories.php:30
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:156
ApiBase\PARAM_DFLT
const PARAM_DFLT
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:58
ApiQueryCategories\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryCategories.php:230
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:59
ApiBase\PARAM_MAX2
const PARAM_MAX2
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:62
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:230
ApiQueryCategories\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryCategories.php:38
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:129
ApiQueryCategories\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryCategories.php:34
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:490
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:462