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
|
<?php
namespace SMW\Query\Processor;
use SMW\Query\ResultPrinter;
use SMW\Message;
use ParamProcessor\ParamDefinition;
use SMW\Query\QueryContext;
/**
* @private
*
* @license GNU GPL v2+
* @since 3.0
*
* @author mwjames
*/
class DefaultParamDefinition {
/**
* Produces a list of allowed parameters of a query using any specific format.
*
* @since 3.0
*
* @param integer|null $context
* @param ResultPrinter|null $resultPrinter
*
* @return IParamDefinition[]
*/
public static function getParamDefinitions( $context = null, ResultPrinter $resultPrinter = null ) {
return self::buildParamDefinitions( $GLOBALS, $context, $resultPrinter );
}
/**
* @private
*
* Give grep a chance to find the msg usages:
*
* smw-paramdesc-format, smw-paramdesc-source, smw-paramdesc-limit,
* smw-paramdesc-offset, smw-paramdesc-link, smw-paramdesc-sort,
* smw-paramdesc-order, smw-paramdesc-headers, smw-paramdesc-mainlabel,
* smw-paramdesc-intro, smw-paramdesc-outro, smw-paramdesc-searchlabel,
* smw-paramdesc-default
*
* @since 3.0
*
* @param integer|null $context
* @param ResultPrinter|null $resultPrinter
*
* @return IParamDefinition[]
*/
public static function buildParamDefinitions( $vars, $context = null, ResultPrinter $resultPrinter = null ) {
$params = [];
$allowedFormats = $vars['smwgResultFormats'];
foreach ( $vars['smwgResultAliases'] as $aliases ) {
$allowedFormats += $aliases;
}
$allowedFormats[] = 'auto';
$params['format'] = [
'type' => 'smwformat',
'default' => 'auto',
];
// TODO $params['format']->setToLower( true );
// TODO $allowedFormats
$params['source'] = self::getSourceParam( $vars );
$params['limit'] = [
'type' => 'integer',
'default' => $vars['smwgQDefaultLimit'],
'negatives' => false,
];
$params['offset'] = [
'type' => 'integer',
'default' => 0,
'negatives' => false,
'upperbound' => $vars['smwgQUpperbound'],
];
$params['link'] = [
'default' => 'all',
'values' => [ 'all', 'subject', 'none' ],
];
// The empty string represents the page itself, which should be sorted by default.
$params['sort'] = [
'islist' => true,
'default' => [ '' ]
];
$params['order'] = [
'islist' => true,
'default' => [],
'values' => [ 'descending', 'desc', 'asc', 'ascending', 'rand', 'random' ],
];
$params['headers'] = [
'default' => 'show',
'values' => [ 'show', 'hide', 'plain' ],
];
$params['mainlabel'] = [
'default' => false,
];
$params['intro'] = [
'default' => '',
];
$params['outro'] = [
'default' => '',
];
$params['searchlabel'] = [
'default' => Message::get( 'smw_iq_moreresults', Message::TEXT, Message::USER_LANGUAGE )
];
$params['default'] = [
'default' => '',
];
if ( $context === QueryContext::DEFERRED_QUERY ) {
$params['@control'] = [
'default' => '',
'values' => [ 'slider' ],
];
}
if ( !( $resultPrinter instanceof ResultPrinter ) || $resultPrinter->supportsRecursiveAnnotation() ) {
$params['import-annotation'] = [
'message' => 'smw-paramdesc-import-annotation',
'type' => 'boolean',
'default' => false
];
}
foreach ( $params as $name => &$param ) {
if ( is_array( $param ) ) {
$param['message'] = 'smw-paramdesc-' . $name;
}
}
return ParamDefinition::getCleanDefinitions( $params );
}
private static function getSourceParam( $vars ) {
$sourceValues = is_array( $vars['smwgQuerySources'] ) ? array_keys( $vars['smwgQuerySources'] ) : [];
return [
'default' => array_key_exists( 'default', $sourceValues ) ? 'default' : '',
'values' => $sourceValues,
];
}
}
|
