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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
<?php
namespace SMW\MediaWiki\Api;
use ApiBase;
use SMW\ApplicationFactory;
use SMW\Localizer;
use SMW\NamespaceUriFinder;
/**
* @license GNU GPL v2+
* @since 2.4
*
* @author mwjames
*/
class BrowseByProperty extends ApiBase {
/**
* #2696
* @deprecated since 3.0, use the smwbrowse API module
*/
public function isDeprecated() {
return true;
}
/**
* @see ApiBase::execute
*/
public function execute() {
$params = $this->extractRequestParams();
$applicationFactory = ApplicationFactory::getInstance();
$propertyListByApiRequest = new PropertyListByApiRequest(
$applicationFactory->getStore(),
$applicationFactory->getPropertySpecificationLookup()
);
$propertyListByApiRequest->setLimit(
$params['limit']
);
$propertyListByApiRequest->setListOnly(
$params['listonly']
);
if ( ( $lang = $params['lang'] ) === null ) {
$lang = Localizer::getInstance()->getUserLanguage()->getCode();
}
$propertyListByApiRequest->setLanguageCode(
$lang
);
$propertyListByApiRequest->findPropertyListBy(
$params['property']
);
foreach ( $propertyListByApiRequest->getNamespaces() as $ns ) {
$uri = NamespaceUriFinder::getUri( $ns );
if ( !$uri ) {
continue;
}
$this->getResult()->addValue(
null,
'xmlns:' . $ns,
$uri
);
}
$data = $propertyListByApiRequest->getPropertyList();
// I'm without words for this utter nonsense introduced here
// because property keys can have a underscore _MDAT or for that matter
// any other data field can
// https://www.mediawiki.org/wiki/API:JSON_version_2
// " ... can indicate that a property beginning with an underscore is not metadata using"
if ( method_exists( $this->getResult(), 'setPreserveKeysList') ) {
$this->getResult()->setPreserveKeysList(
$data,
array_keys( $data )
);
}
$this->getResult()->addValue(
null,
'query',
$data
);
$this->getResult()->addValue(
null,
'version',
2
);
$this->getResult()->addValue(
null,
'query-continue-offset',
$propertyListByApiRequest->getContinueOffset()
);
$this->getResult()->addValue(
null,
'meta',
$propertyListByApiRequest->getMeta()
);
}
/**
* @codeCoverageIgnore
* @see ApiBase::getAllowedParams
*
* @return array
*/
public function getAllowedParams() {
return [
'property' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_REQUIRED => false,
],
'limit' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_DFLT => 50,
ApiBase::PARAM_REQUIRED => false,
],
'lang' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_REQUIRED => false,
],
'listonly' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => false,
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_REQUIRED => false,
]
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getParamDescription
*
* @return array
*/
public function getParamDescription() {
return [
'property' => 'To match a specific property',
'limit' => 'To specify the size of the list request',
'lang' => 'To specify a specific language used for some attributes (description etc.)',
'listonly' => 'To specify that only a property list is returned without further details'
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getDescription
*
* @return array
*/
public function getDescription() {
return [
'API module to query a property list or an individual property.'
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getExamples
*
* @return array
*/
public function getExamples() {
return [
'api.php?action=browsebyproperty&property=Modification_date',
'api.php?action=browsebyproperty&limit=50',
'api.php?action=browsebyproperty&limit=5&listonly=true',
];
}
/**
* @codeCoverageIgnore
* @see ApiBase::getVersion
*
* @return string
*/
public function getVersion() {
return __CLASS__ . '-' . SMW_VERSION;
}
}
|
