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 ( !is_null( $params['continue'] ) ) {
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 
131  $res = $this->select( __METHOD__ );
132 
133  $count = 0;
134  if ( is_null( $resultPageSet ) ) {
135  foreach ( $res as $row ) {
136  if ( ++$count > $params['limit'] ) {
137  // We've reached the one extra which shows that
138  // there are additional pages to be had. Stop here...
139  $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
140  break;
141  }
142 
143  $title = Title::makeTitle( NS_CATEGORY, $row->cl_to );
144  $vals = [];
146  if ( isset( $prop['sortkey'] ) ) {
147  $vals['sortkey'] = bin2hex( $row->cl_sortkey );
148  $vals['sortkeyprefix'] = $row->cl_sortkey_prefix;
149  }
150  if ( isset( $prop['timestamp'] ) ) {
151  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
152  }
153  if ( isset( $prop['hidden'] ) ) {
154  $vals['hidden'] = !is_null( $row->pp_propname );
155  }
156 
157  $fit = $this->addPageSubItem( $row->cl_from, $vals );
158  if ( !$fit ) {
159  $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
160  break;
161  }
162  }
163  } else {
164  $titles = [];
165  foreach ( $res as $row ) {
166  if ( ++$count > $params['limit'] ) {
167  // We've reached the one extra which shows that
168  // there are additional pages to be had. Stop here...
169  $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
170  break;
171  }
172 
173  $titles[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
174  }
175  $resultPageSet->populateFromTitles( $titles );
176  }
177  }
178 
179  public function getAllowedParams() {
180  return [
181  'prop' => [
182  ApiBase::PARAM_ISMULTI => true,
184  'sortkey',
185  'timestamp',
186  'hidden',
187  ],
189  ],
190  'show' => [
191  ApiBase::PARAM_ISMULTI => true,
193  'hidden',
194  '!hidden',
195  ]
196  ],
197  'limit' => [
198  ApiBase::PARAM_DFLT => 10,
199  ApiBase::PARAM_TYPE => 'limit',
200  ApiBase::PARAM_MIN => 1,
203  ],
204  'continue' => [
205  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
206  ],
207  'categories' => [
208  ApiBase::PARAM_ISMULTI => true,
209  ],
210  'dir' => [
211  ApiBase::PARAM_DFLT => 'ascending',
213  'ascending',
214  'descending'
215  ]
216  ],
217  ];
218  }
219 
220  protected function getExamplesMessages() {
221  return [
222  'action=query&prop=categories&titles=Albert%20Einstein'
223  => 'apihelp-query+categories-example-simple',
224  'action=query&generator=categories&titles=Albert%20Einstein&prop=info'
225  => 'apihelp-query+categories-example-generator',
226  ];
227  }
228 
229  public function getHelpUrls() {
230  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categories';
231  }
232 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1529
A query module to enumerate categories the set of pages belong to.
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
$sort
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
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:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
run( $resultPageSet=null)
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
$res
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
$params
const NS_CATEGORY
Definition: Defines.php:74
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
addFields( $value)
Add a set of fields to select to the internal array.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
This is the main query class.
Definition: ApiQuery.php:36
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
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
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
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
addWhere( $value)
Add a set of WHERE clauses to the internal array.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1928
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
executeGenerator( $resultPageSet)
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
getPageSet()
Get the PageSet object to work on.
__construct(ApiQuery $query, $moduleName)
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:322