40 parent::__construct( $query, $moduleName,
'pwp' );
52 $this->run( $resultPageSet );
59 private function run( $resultPageSet =
null ) {
62 $prop = array_fill_keys( $params[
'prop'],
true );
63 $fld_ids = isset( $prop[
'ids'] );
64 $fld_title = isset( $prop[
'title'] );
65 $fld_value = isset( $prop[
'value'] );
67 if ( $resultPageSet ===
null ) {
69 $this->
addFieldsIf( [
'page_title',
'page_namespace' ], $fld_title );
72 $this->
addFields( $resultPageSet->getPageTableFields() );
74 $this->
addTables( [
'page_props',
'page' ] );
75 $this->
addWhere(
'pp_page=page_id' );
76 $this->
addWhereFld(
'pp_propname', $params[
'propname'] );
78 $dir = ( $params[
'dir'] ==
'ascending' ) ?
'newer' :
'older';
80 if ( $params[
'continue'] ) {
81 $cont = explode(
'|', $params[
'continue'] );
85 $from = (int)$cont[0];
89 $sort = ( $params[
'dir'] ===
'descending' ?
' DESC' :
'' );
90 $this->
addOption(
'ORDER BY',
'pp_page' . $sort );
92 $limit = $params[
'limit'];
99 if ( $fld_title && $resultPageSet ===
null ) {
103 foreach (
$res as $row ) {
104 if ( ++$count > $limit ) {
111 if ( $resultPageSet ===
null ) {
116 $vals[
'pageid'] = (int)$row->page_id;
123 $vals[
'value'] = $row->pp_value;
125 $fit = $result->addValue( [
'query', $this->
getModuleName() ],
null, $vals );
131 $resultPageSet->processDbRow( $row );
135 if ( $resultPageSet ===
null ) {
136 $result->addIndexedTagName( [
'query', $this->
getModuleName() ],
'page' );
143 ParamValidator::PARAM_TYPE =>
'string',
144 ParamValidator::PARAM_REQUIRED =>
true,
147 ParamValidator::PARAM_DEFAULT =>
'ids|title',
148 ParamValidator::PARAM_ISMULTI =>
true,
149 ParamValidator::PARAM_TYPE => [
160 ParamValidator::PARAM_TYPE =>
'limit',
161 ParamValidator::PARAM_DEFAULT => 10,
162 IntegerDef::PARAM_MIN => 1,
167 ParamValidator::PARAM_DEFAULT =>
'ascending',
168 ParamValidator::PARAM_TYPE => [
178 'action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value'
179 =>
'apihelp-query+pageswithprop-example-simple',
180 'action=query&generator=pageswithprop&gpwppropname=notoc&prop=info'
181 =>
'apihelp-query+pageswithprop-example-generator',
186 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageswithprop';
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.
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.
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.
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.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
A query module to enumerate pages that use a particular prop.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getExamplesMessages()
Returns usage examples for this module.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getHelpUrls()
Return links to more detailed help pages about the module.
__construct(ApiQuery $query, $moduleName)
executeGenerator( $resultPageSet)
Execute this module as a generator.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
This is the main query class.
const META_TYPE
Key for the 'type' metadata item.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.