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
137
138
139
|
<?php
/**
* Created on 16 April 2011
* API for Gadgets extension
*
* 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
*/
class ApiQueryGadgetCategories extends ApiQueryBase {
private $props,
$neededNames;
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'gc' );
}
public function execute() {
$params = $this->extractRequestParams();
$this->props = array_flip( $params['prop'] );
$this->neededNames = isset( $params['names'] )
? array_flip( $params['names'] )
: false;
$this->getMain()->setCacheMode( 'public' );
$this->getList();
}
private function getList() {
$data = array();
$result = $this->getResult();
$gadgets = Gadget::loadStructuredList();
if ( $gadgets ) {
foreach ( $gadgets as $category => $list ) {
if ( !$this->neededNames || isset( $this->neededNames[$category] ) ) {
$row = array();
if ( isset( $this->props['name'] ) ) {
$row['name'] = $category;
}
if ( $category !== "" ) {
if ( isset( $this->props['title'] ) ) {
$row['desc'] = $this->msg( "gadget-section-$category" )->parse();
}
}
if ( isset( $this->props['members'] ) ) {
$row['members'] = count( $list );
}
$data[] = $row;
}
}
}
$result->setIndexedTagName( $data, 'category' );
$result->addValue( 'query', $this->getModuleName(), $data );
}
public function getAllowedParams() {
return array(
'prop' => array(
ApiBase::PARAM_DFLT => 'name',
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => array(
'name',
'title',
'members',
),
),
'names' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => true,
),
);
}
/**
* @deprecated since MediaWiki core 1.25
*/
public function getDescription() {
return 'Returns a list of gadget categories';
}
/**
* @deprecated since MediaWiki core 1.25
*/
public function getParamDescription() {
return array(
'prop' => array(
'What gadget category information to get:',
' name - Internal category name',
' title - Category title',
' members - Number of gadgets in category',
),
'names' => 'Name(s) of categories to retrieve',
);
}
/**
* @deprecated since MediaWiki core 1.25
*/
public function getExamples() {
$params = $this->getAllowedParams();
$allProps = implode( '|', $params['prop'][ApiBase::PARAM_TYPE] );
return array(
'Get a list of existing gadget categories:',
' api.php?action=query&list=gadgetcategories',
'Get all information about categories named "foo" and "bar":',
" api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=$allProps",
);
}
/**
* @see ApiBase::getExamplesMessages()
*/
protected function getExamplesMessages() {
return array(
'action=query&list=gadgetcategories'
=> 'apihelp-query+gadgetcategories-example-1',
'action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members'
=> 'apihelp-query+gadgetcategories-example-2',
);
}
}
|
