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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?php
/**
* Copyright © 2010 soxred93, Bryan Tong Minh
*
* 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
*/
namespace MediaWiki\Api;
use MediaWiki\Page\PageProps;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
/**
* A query module to show basic page information.
*
* @ingroup API
*/
class ApiQueryPageProps extends ApiQueryBase {
private PageProps $pageProps;
public function __construct(
ApiQuery $query,
string $moduleName,
PageProps $pageProps
) {
parent::__construct( $query, $moduleName, 'pp' );
$this->pageProps = $pageProps;
}
public function execute() {
# Only operate on existing pages
$pages = $this->getPageSet()->getGoodPages();
$params = $this->extractRequestParams();
if ( $params['continue'] ) {
$cont = $this->parseContinueParamOrDie( $params['continue'], [ 'int' ] );
$continueValue = $cont[0];
$filteredPages = [];
foreach ( $pages as $id => $page ) {
if ( $id >= $continueValue ) {
$filteredPages[$id] = $page;
}
}
$pages = $filteredPages;
}
if ( $pages === [] ) {
# Nothing to do
return;
}
if ( $params['prop'] ) {
$properties = $this->pageProps->getProperties( $pages, $params['prop'] );
} else {
$properties = $this->pageProps->getAllProperties( $pages );
}
ksort( $properties );
$result = $this->getResult();
foreach ( $properties as $pageid => $props ) {
if ( !$this->addPageProps( $result, $pageid, $props ) ) {
break;
}
}
}
/**
* Add page properties to an ApiResult, adding a continue
* parameter if it doesn't fit.
*
* @param ApiResult $result
* @param int $page
* @param array $props
* @return bool True if it fits in the result
*/
private function addPageProps( $result, $page, $props ) {
ApiResult::setArrayType( $props, 'assoc' );
$fit = $result->addValue( [ 'query', 'pages', $page ], 'pageprops', $props );
if ( !$fit ) {
$this->setContinueEnumParameter( 'continue', $page );
}
return $fit;
}
public function getCacheMode( $params ) {
return 'public';
}
public function getAllowedParams() {
return [
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
'prop' => [
ParamValidator::PARAM_ISMULTI => true,
],
];
}
protected function getExamplesMessages() {
$title = Title::newMainPage()->getPrefixedText();
$mp = rawurlencode( $title );
return [
"action=query&prop=pageprops&titles={$mp}|MediaWiki"
=> 'apihelp-query+pageprops-example-simple',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageprops';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiQueryPageProps::class, 'ApiQueryPageProps' );
|
