35 parent::__construct( $query, $moduleName,
'cl' );
47 $this->
run( $resultPageSet );
53 private function run( $resultPageSet =
null ) {
55 if ( $pages === [] ) {
60 $prop = array_fill_keys( (array)$params[
'prop'],
true );
61 $show = array_fill_keys( (array)$params[
'show'],
true );
68 $this->
addFieldsIf( [
'cl_sortkey',
'cl_sortkey_prefix' ], isset( $prop[
'sortkey'] ) );
69 $this->
addFieldsIf(
'cl_timestamp', isset( $prop[
'timestamp'] ) );
72 $this->
addWhereFld(
'cl_from', array_keys( $pages ) );
73 if ( $params[
'categories'] ) {
75 foreach ( $params[
'categories'] as $cat ) {
80 $cats[] =
$title->getDBkey();
90 if ( $params[
'continue'] !==
null ) {
91 $cont = explode(
'|', $params[
'continue'] );
93 $op = $params[
'dir'] ==
'descending' ?
'<' :
'>';
94 $clfrom = (int)$cont[0];
95 $clto = $this->
getDB()->addQuotes( $cont[1] );
97 "cl_from $op $clfrom OR " .
98 "(cl_from = $clfrom AND " .
103 if ( isset( $show[
'hidden'] ) && isset( $show[
'!hidden'] ) ) {
106 if ( isset( $show[
'hidden'] ) || isset( $show[
'!hidden'] ) || isset( $prop[
'hidden'] ) ) {
108 $this->
addTables( [
'page',
'page_props' ] );
109 $this->
addFieldsIf(
'pp_propname', isset( $prop[
'hidden'] ) );
111 'page' => [
'LEFT JOIN', [
113 'page_title = cl_to' ] ],
114 'page_props' => [
'LEFT JOIN', [
116 'pp_propname' =>
'hiddencat' ] ]
118 if ( isset( $show[
'hidden'] ) ) {
119 $this->
addWhere( [
'pp_propname IS NOT NULL' ] );
120 } elseif ( isset( $show[
'!hidden'] ) ) {
121 $this->
addWhere( [
'pp_propname IS NULL' ] );
125 $sort = ( $params[
'dir'] ==
'descending' ?
' DESC' :
'' );
127 if ( count( $pages ) === 1 ) {
128 $this->
addOption(
'ORDER BY',
'cl_to' . $sort );
135 $this->
addOption(
'LIMIT', $params[
'limit'] + 1 );
140 if ( $resultPageSet ===
null ) {
141 foreach (
$res as $row ) {
142 if ( ++$count > $params[
'limit'] ) {
152 if ( isset( $prop[
'sortkey'] ) ) {
153 $vals[
'sortkey'] = bin2hex( $row->cl_sortkey );
154 $vals[
'sortkeyprefix'] = $row->cl_sortkey_prefix;
156 if ( isset( $prop[
'timestamp'] ) ) {
157 $vals[
'timestamp'] =
wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
159 if ( isset( $prop[
'hidden'] ) ) {
160 $vals[
'hidden'] = $row->pp_propname !==
null;
171 foreach (
$res as $row ) {
172 if ( ++$count > $params[
'limit'] ) {
181 $resultPageSet->populateFromTitles( $titles );
228 'action=query&prop=categories&titles=Albert%20Einstein'
229 =>
'apihelp-query+categories-example-simple',
230 'action=query&generator=categories&titles=Albert%20Einstein&prop=info'
231 =>
'apihelp-query+categories-example-generator',
236 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categories';
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
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.
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.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
const LIMIT_BIG2
Fast query, apihighlimits limit.
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)
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.
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
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 categories the set of pages belong to.
executeGenerator( $resultPageSet)
Execute this module as a generator.
__construct(ApiQuery $query, $moduleName)
getHelpUrls()
Return links to more detailed help pages about the module.
getExamplesMessages()
Returns usage examples for this module.
run( $resultPageSet=null)
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.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
getPageSet()
Get the PageSet object to work on.
This is the main query class.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.