1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?php
/**
* Created on January 21, 2013
*
* Copyright © 2013 Brad Jorsch <bjorsch@wikimedia.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @since 1.21
* @author Brad Jorsch
*/
/**
* A query module to list used page props
*
* @ingroup API
* @since 1.21
*/
class ApiQueryPagePropNames extends ApiQueryBase {
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ppn' );
}
public function getCacheMode( $params ) {
return 'public';
}
public function execute() {
$params = $this->extractRequestParams();
$this->addTables( 'page_props' );
$this->addFields( 'pp_propname' );
$this->addOption( 'DISTINCT' );
$this->addOption( 'ORDER BY', 'pp_propname' );
if ( $params['continue'] ) {
$cont = explode( '|', $params['continue'] );
$this->dieContinueUsageIf( count( $cont ) != 1 );
// Add a WHERE clause
$this->addWhereRange( 'pp_propname', 'newer', $cont[0], null );
}
$limit = $params['limit'];
$this->addOption( 'LIMIT', $limit + 1 );
$result = $this->getResult();
$count = 0;
foreach ( $this->select( __METHOD__ ) as $row ) {
if ( ++$count > $limit ) {
// We've reached the one extra which shows that there are
// additional pages to be had. Stop here...
$this->setContinueEnumParameter( 'continue', $row->pp_propname );
break;
}
$vals = array();
$vals['propname'] = $row->pp_propname;
$fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
if ( !$fit ) {
$this->setContinueEnumParameter( 'continue', $row->pp_propname );
break;
}
}
$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'p' );
}
public function getAllowedParams() {
return array(
'continue' => null,
'limit' => array(
ApiBase::PARAM_TYPE => 'limit',
ApiBase::PARAM_DFLT => 10,
ApiBase::PARAM_MIN => 1,
ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
),
);
}
public function getParamDescription() {
return array(
'continue' => 'When more results are available, use this to continue',
'limit' => 'The maximum number of pages to return',
);
}
public function getDescription() {
return 'List all page prop names in use on the wiki.';
}
public function getExamples() {
return array(
'api.php?action=query&list=pagepropnames' => 'Get first 10 prop names',
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Pagepropnames';
}
}
|
