MediaWiki  master
ApiQueryPagesWithProp.php
Go to the documentation of this file.
1 <?php
31 
32  public function __construct( ApiQuery $query, $moduleName ) {
33  parent::__construct( $query, $moduleName, 'pwp' );
34  }
35 
36  public function execute() {
37  $this->run();
38  }
39 
40  public function getCacheMode( $params ) {
41  return 'public';
42  }
43 
44  public function executeGenerator( $resultPageSet ) {
45  $this->run( $resultPageSet );
46  }
47 
52  private function run( $resultPageSet = null ) {
53  $params = $this->extractRequestParams();
54 
55  $prop = array_flip( $params['prop'] );
56  $fld_ids = isset( $prop['ids'] );
57  $fld_title = isset( $prop['title'] );
58  $fld_value = isset( $prop['value'] );
59 
60  if ( $resultPageSet === null ) {
61  $this->addFields( [ 'page_id' ] );
62  $this->addFieldsIf( [ 'page_title', 'page_namespace' ], $fld_title );
63  $this->addFieldsIf( 'pp_value', $fld_value );
64  } else {
65  $this->addFields( $resultPageSet->getPageTableFields() );
66  }
67  $this->addTables( [ 'page_props', 'page' ] );
68  $this->addWhere( 'pp_page=page_id' );
69  $this->addWhereFld( 'pp_propname', $params['propname'] );
70 
71  $dir = ( $params['dir'] == 'ascending' ) ? 'newer' : 'older';
72 
73  if ( $params['continue'] ) {
74  $cont = explode( '|', $params['continue'] );
75  $this->dieContinueUsageIf( count( $cont ) != 1 );
76 
77  // Add a WHERE clause
78  $from = (int)$cont[0];
79  $this->addWhereRange( 'pp_page', $dir, $from, null );
80  }
81 
82  $sort = ( $params['dir'] === 'descending' ? ' DESC' : '' );
83  $this->addOption( 'ORDER BY', 'pp_page' . $sort );
84 
85  $limit = $params['limit'];
86  $this->addOption( 'LIMIT', $limit + 1 );
87 
88  $result = $this->getResult();
89  $count = 0;
90  foreach ( $this->select( __METHOD__ ) as $row ) {
91  if ( ++$count > $limit ) {
92  // We've reached the one extra which shows that there are
93  // additional pages to be had. Stop here...
94  $this->setContinueEnumParameter( 'continue', $row->page_id );
95  break;
96  }
97 
98  if ( $resultPageSet === null ) {
99  $vals = [
100  ApiResult::META_TYPE => 'assoc',
101  ];
102  if ( $fld_ids ) {
103  $vals['pageid'] = (int)$row->page_id;
104  }
105  if ( $fld_title ) {
106  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
108  }
109  if ( $fld_value ) {
110  $vals['value'] = $row->pp_value;
111  }
112  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
113  if ( !$fit ) {
114  $this->setContinueEnumParameter( 'continue', $row->page_id );
115  break;
116  }
117  } else {
118  $resultPageSet->processDbRow( $row );
119  }
120  }
121 
122  if ( $resultPageSet === null ) {
123  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
124  }
125  }
126 
127  public function getAllowedParams() {
128  return [
129  'propname' => [
130  ApiBase::PARAM_TYPE => 'string',
131  ApiBase::PARAM_REQUIRED => true,
132  ],
133  'prop' => [
134  ApiBase::PARAM_DFLT => 'ids|title',
135  ApiBase::PARAM_ISMULTI => true,
137  'ids',
138  'title',
139  'value',
140  ],
142  ],
143  'continue' => [
144  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
145  ],
146  'limit' => [
147  ApiBase::PARAM_TYPE => 'limit',
148  ApiBase::PARAM_DFLT => 10,
149  ApiBase::PARAM_MIN => 1,
152  ],
153  'dir' => [
154  ApiBase::PARAM_DFLT => 'ascending',
156  'ascending',
157  'descending',
158  ]
159  ],
160  ];
161  }
162 
163  protected function getExamplesMessages() {
164  return [
165  'action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value'
166  => 'apihelp-query+pageswithprop-example-simple',
167  'action=query&generator=pageswithprop&gpwppropname=notoc&prop=info'
168  => 'apihelp-query+pageswithprop-example-generator',
169  ];
170  }
171 
172  public function getHelpUrls() {
173  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageswithprop';
174  }
175 }
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
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
getResult()
Get the result object.
Definition: ApiBase.php:640
A query module to enumerate pages that use a particular prop.
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
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:118
$sort
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
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.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
executeGenerator( $resultPageSet)
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2199
run( $resultPageSet=null)
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
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:37
__construct(ApiQuery $query, $moduleName)
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:586
addWhere( $value)
Add a set of WHERE clauses to the internal array.
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.
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
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...