31 parent::__construct( $query, $moduleName,
'cm' );
43 $this->
run( $resultPageSet );
52 return (
bool)preg_match(
'/^(?:[a-fA-F0-9]{2})*$/D', $hexSortkey );
59 private function run( $resultPageSet =
null ) {
63 if ( $categoryTitle->getNamespace() !=
NS_CATEGORY ) {
67 $prop = array_flip( $params[
'prop'] );
68 $fld_ids = isset( $prop[
'ids'] );
69 $fld_title = isset( $prop[
'title'] );
70 $fld_sortkey = isset( $prop[
'sortkey'] );
71 $fld_sortkeyprefix = isset( $prop[
'sortkeyprefix'] );
72 $fld_timestamp = isset( $prop[
'timestamp'] );
73 $fld_type = isset( $prop[
'type'] );
75 if ( $resultPageSet ===
null ) {
76 $this->
addFields( [
'cl_from',
'cl_sortkey',
'cl_type',
'page_namespace',
'page_title' ] );
78 $this->
addFieldsIf(
'cl_sortkey_prefix', $fld_sortkeyprefix );
80 $this->
addFields( $resultPageSet->getPageTableFields() );
81 $this->
addFields( [
'cl_from',
'cl_sortkey',
'cl_type' ] );
84 $this->
addFieldsIf(
'cl_timestamp', $fld_timestamp || $params[
'sort'] ==
'timestamp' );
86 $this->
addTables( [
'page',
'categorylinks' ] );
88 $this->
addWhereFld(
'cl_to', $categoryTitle->getDBkey() );
89 $queryTypes = $params[
'type'];
95 if ( $this->
getConfig()->
get(
'MiserMode' ) ) {
96 $miser_ns = $params[
'namespace'] ?: [];
98 $this->
addWhereFld(
'page_namespace', $params[
'namespace'] );
101 $dir = in_array( $params[
'dir'], [
'asc',
'ascending',
'newer' ] ) ?
'newer' :
'older';
103 if ( $params[
'sort'] ==
'timestamp' ) {
111 if ( $params[
'continue'] !==
null ) {
112 $cont = explode(
'|', $params[
'continue'] );
114 $op = ( $dir ===
'newer' ?
'>' :
'<' );
115 $db = $this->
getDB();
116 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
117 $continueFrom = (int)$cont[1];
119 $this->
addWhere(
"cl_timestamp $op $continueTimestamp OR " .
120 "(cl_timestamp = $continueTimestamp AND " .
121 "cl_from $op= $continueFrom)"
125 $this->
addOption(
'USE INDEX',
'cl_timestamp' );
127 if ( $params[
'continue'] ) {
128 $cont = explode(
'|', $params[
'continue'], 3 );
132 $contTypeIndex = array_search( $cont[0], $queryTypes );
133 $queryTypes = array_slice( $queryTypes, $contTypeIndex );
137 $escSortkey = $this->
getDB()->addQuotes( hex2bin( $cont[1] ) );
138 $from = (int)$cont[2];
139 $op = $dir ==
'newer' ?
'>' :
'<';
141 $contWhere =
"cl_sortkey $op $escSortkey OR " .
142 "(cl_sortkey = $escSortkey AND " .
143 "cl_from $op= $from)";
148 if ( $params[
'startsortkeyprefix'] !==
null ) {
149 $startsortkey = Collation::singleton()->getSortKey( $params[
'startsortkeyprefix'] );
150 } elseif ( $params[
'starthexsortkey'] !==
null ) {
153 $this->
dieWithError( [
'apierror-badparameter', $encParamName ],
"badvalue_$encParamName" );
155 $startsortkey = hex2bin( $params[
'starthexsortkey'] );
157 $startsortkey = $params[
'startsortkey'];
159 if ( $params[
'endsortkeyprefix'] !==
null ) {
160 $endsortkey = Collation::singleton()->getSortKey( $params[
'endsortkeyprefix'] );
161 } elseif ( $params[
'endhexsortkey'] !==
null ) {
164 $this->
dieWithError( [
'apierror-badparameter', $encParamName ],
"badvalue_$encParamName" );
166 $endsortkey = hex2bin( $params[
'endhexsortkey'] );
168 $endsortkey = $params[
'endsortkey'];
178 $this->
addOption(
'USE INDEX',
'cl_sortkey' );
181 $this->
addWhere(
'cl_from=page_id' );
183 $limit = $params[
'limit'];
186 if ( $params[
'sort'] ==
'sortkey' ) {
194 foreach ( $queryTypes as
$type ) {
195 $extraConds = [
'cl_type' =>
$type ];
196 if ( $first && $contWhere ) {
199 $extraConds[] = $contWhere;
201 $res = $this->
select( __METHOD__, [
'where' => $extraConds ] );
202 if (
$type ===
'page' && $resultPageSet ===
null ) {
205 $rows = array_merge( $rows, iterator_to_array(
$res ) );
206 if ( count( $rows ) >= $limit + 1 ) {
216 if ( $resultPageSet ===
null ) {
219 $rows = iterator_to_array(
$res );
224 foreach ( $rows as $row ) {
225 if ( ++$count > $limit ) {
230 if ( $params[
'sort'] ==
'timestamp' ) {
233 $sortkey = bin2hex( $row->cl_sortkey );
235 "{$row->cl_type}|$sortkey|{$row->cl_from}"
245 if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) ) {
249 if ( $resultPageSet ===
null ) {
251 ApiResult::META_TYPE =>
'assoc',
254 $vals[
'pageid'] = (int)$row->page_id;
257 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
260 if ( $fld_sortkey ) {
261 $vals[
'sortkey'] = bin2hex( $row->cl_sortkey );
263 if ( $fld_sortkeyprefix ) {
264 $vals[
'sortkeyprefix'] = $row->cl_sortkey_prefix;
267 $vals[
'type'] = $row->cl_type;
269 if ( $fld_timestamp ) {
270 $vals[
'timestamp'] =
wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
272 $fit = $result->addValue( [
'query', $this->
getModuleName() ],
275 if ( $params[
'sort'] ==
'timestamp' ) {
278 $sortkey = bin2hex( $row->cl_sortkey );
280 "{$row->cl_type}|$sortkey|{$row->cl_from}"
286 $resultPageSet->processDbRow( $row );
290 if ( $resultPageSet ===
null ) {
291 $result->addIndexedTagName(
365 'starthexsortkey' =>
null,
366 'endhexsortkey' =>
null,
367 'startsortkeyprefix' =>
null,
368 'endsortkeyprefix' =>
null,
377 if ( $this->
getConfig()->
get(
'MiserMode' ) ) {
379 'api-help-param-limited-in-miser-mode',
388 'action=query&list=categorymembers&cmtitle=Category:Physics'
389 =>
'apihelp-query+categorymembers-example-simple',
390 'action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info'
391 =>
'apihelp-query+categorymembers-example-generator',
396 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categorymembers';
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
const LIMIT_BIG1
Fast query, standard limit.
getResult()
Get the result object.
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
const LIMIT_BIG2
Fast query, apihighlimits limit.
getModuleName()
Get the name of the module being executed by this instance.
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
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.
addFields( $value)
Add a set of fields to select to the internal array.
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.
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
getDB()
Get the Query database connection (read-only) Stable to override.
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addWhere( $value)
Add a set of WHERE clauses to the internal array.
A query module to enumerate pages that belong to a category.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
executeGenerator( $resultPageSet)
Execute this module as a generator.
run( $resultPageSet=null)
__construct(ApiQuery $query, $moduleName)
validateHexSortkey( $hexSortkey)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getExamplesMessages()
Returns usage examples for this module.
getHelpUrls()
Return links to more detailed help pages about the module.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
This is the main query class.