MediaWiki  master
ApiQueryPagesWithProp.php
Go to the documentation of this file.
1 <?php
31 
36  public function __construct( ApiQuery $query, $moduleName ) {
37  parent::__construct( $query, $moduleName, 'pwp' );
38  }
39 
40  public function execute() {
41  $this->run();
42  }
43 
44  public function getCacheMode( $params ) {
45  return 'public';
46  }
47 
48  public function executeGenerator( $resultPageSet ) {
49  $this->run( $resultPageSet );
50  }
51 
56  private function run( $resultPageSet = null ) {
57  $params = $this->extractRequestParams();
58 
59  $prop = array_fill_keys( $params['prop'], true );
60  $fld_ids = isset( $prop['ids'] );
61  $fld_title = isset( $prop['title'] );
62  $fld_value = isset( $prop['value'] );
63 
64  if ( $resultPageSet === null ) {
65  $this->addFields( [ 'page_id' ] );
66  $this->addFieldsIf( [ 'page_title', 'page_namespace' ], $fld_title );
67  $this->addFieldsIf( 'pp_value', $fld_value );
68  } else {
69  $this->addFields( $resultPageSet->getPageTableFields() );
70  }
71  $this->addTables( [ 'page_props', 'page' ] );
72  $this->addWhere( 'pp_page=page_id' );
73  $this->addWhereFld( 'pp_propname', $params['propname'] );
74 
75  $dir = ( $params['dir'] == 'ascending' ) ? 'newer' : 'older';
76 
77  if ( $params['continue'] ) {
78  $cont = explode( '|', $params['continue'] );
79  $this->dieContinueUsageIf( count( $cont ) != 1 );
80 
81  // Add a WHERE clause
82  $from = (int)$cont[0];
83  $this->addWhereRange( 'pp_page', $dir, $from, null );
84  }
85 
86  $sort = ( $params['dir'] === 'descending' ? ' DESC' : '' );
87  $this->addOption( 'ORDER BY', 'pp_page' . $sort );
88 
89  $limit = $params['limit'];
90  $this->addOption( 'LIMIT', $limit + 1 );
91 
92  $result = $this->getResult();
93  $count = 0;
94  $res = $this->select( __METHOD__ );
95 
96  if ( $fld_title && $resultPageSet === null ) {
97  $this->executeGenderCacheFromResultWrapper( $res, __METHOD__ );
98  }
99 
100  foreach ( $res as $row ) {
101  if ( ++$count > $limit ) {
102  // We've reached the one extra which shows that there are
103  // additional pages to be had. Stop here...
104  $this->setContinueEnumParameter( 'continue', $row->page_id );
105  break;
106  }
107 
108  if ( $resultPageSet === null ) {
109  $vals = [
110  ApiResult::META_TYPE => 'assoc',
111  ];
112  if ( $fld_ids ) {
113  $vals['pageid'] = (int)$row->page_id;
114  }
115  if ( $fld_title ) {
116  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
118  }
119  if ( $fld_value ) {
120  $vals['value'] = $row->pp_value;
121  }
122  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
123  if ( !$fit ) {
124  $this->setContinueEnumParameter( 'continue', $row->page_id );
125  break;
126  }
127  } else {
128  $resultPageSet->processDbRow( $row );
129  }
130  }
131 
132  if ( $resultPageSet === null ) {
133  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
134  }
135  }
136 
137  public function getAllowedParams() {
138  return [
139  'propname' => [
140  ApiBase::PARAM_TYPE => 'string',
141  ApiBase::PARAM_REQUIRED => true,
142  ],
143  'prop' => [
144  ApiBase::PARAM_DFLT => 'ids|title',
145  ApiBase::PARAM_ISMULTI => true,
147  'ids',
148  'title',
149  'value',
150  ],
152  ],
153  'continue' => [
154  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
155  ],
156  'limit' => [
157  ApiBase::PARAM_TYPE => 'limit',
158  ApiBase::PARAM_DFLT => 10,
159  ApiBase::PARAM_MIN => 1,
162  ],
163  'dir' => [
164  ApiBase::PARAM_DFLT => 'ascending',
166  'ascending',
167  'descending',
168  ]
169  ],
170  ];
171  }
172 
173  protected function getExamplesMessages() {
174  return [
175  'action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value'
176  => 'apihelp-query+pageswithprop-example-simple',
177  'action=query&generator=pageswithprop&gpwppropname=notoc&prop=info'
178  => 'apihelp-query+pageswithprop-example-generator',
179  ];
180  }
181 
182  public function getHelpUrls() {
183  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageswithprop';
184  }
185 }
ApiQueryPagesWithProp\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryPagesWithProp.php:182
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:212
ApiQuery
This is the main query class.
Definition: ApiQuery.php:39
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:105
ApiQueryPagesWithProp\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryPagesWithProp.php:36
ApiResult\META_TYPE
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:110
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:162
ApiQueryPagesWithProp\run
run( $resultPageSet=null)
Definition: ApiQueryPagesWithProp.php:56
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:81
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:628
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:378
$res
$res
Definition: testCompression.php:57
ApiQueryPagesWithProp
A query module to enumerate pages that use a particular prop.
Definition: ApiQueryPagesWithProp.php:30
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:222
ApiQueryPagesWithProp\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryPagesWithProp.php:44
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:83
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:93
ApiQueryPagesWithProp\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryPagesWithProp.php:40
ApiQueryBase\executeGenderCacheFromResultWrapper
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
Definition: ApiQueryBase.php:626
ApiQueryPagesWithProp\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryPagesWithProp.php:173
ApiQueryPagesWithProp\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryPagesWithProp.php:137
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:220
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:85
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:182
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:399
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:764
$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:666
ApiQueryBase\addWhereRange
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.
Definition: ApiQueryBase.php:337
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1626
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
Definition: ApiQueryBase.php:282
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:28
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:222
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:73
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:497
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:77
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:89
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:245
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:195
ApiQueryPagesWithProp\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryPagesWithProp.php:48
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:466