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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
<?php
namespace ParamProcessor;
use Exception;
use OutOfBoundsException;
/**
* Factory for IParamDefinition implementing objects.
*
* @licence GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
class ParamDefinitionFactory {
/**
* Maps parameter type to handling IParameterDefinition implementing class.
*
* @since 1.0
*
* @var array
*/
private $typeToClass = [];
/**
* Maps parameter type to its associated components.
*
* @since 1.0
*
* @var array
*/
private $typeToComponent = [];
/**
* Singleton.
*
* @since 1.0
* @deprecated since 1.0
*
* @return ParamDefinitionFactory
*/
public static function singleton() {
static $instance = false;
if ( $instance === false ) {
$instance = new self();
$instance->registerGlobals();
}
return $instance;
}
/**
* Registers the parameter types specified in the global $wgParamDefinitions.
*
* @since 1.0
*/
public function registerGlobals() {
if ( array_key_exists( 'wgParamDefinitions', $GLOBALS ) ) {
foreach ( $GLOBALS['wgParamDefinitions'] as $type => $data ) {
if ( is_string( $data ) ) {
$data = [ 'definition' => $data ];
}
$this->registerType( $type, $data );
}
}
}
/**
* Registers a parameter type.
*
* The type is specified as a string identifier for the type, ie 'boolean',
* and an array containing further data. This data currently includes:
*
* - string-parser: the parser to use to transform string values
* This class needs to implement ValueParser. Default: NullParser
* - typed-parser: the parser to use to transform typed PHP values
* This class needs to implement ValueParser. Default: NullParser
* - validator: the validation object to use
* This class needs to implement ValueValidator. Default: NullValidator
* - validation-callback a callback to use for validation, called before the ValueValidator
* This callback needs to return a boolean indicating validity.
*
* @since 1.0
*
* @param string $type
* @param array $data
*
* @return boolean Indicates if the type was registered
*/
public function registerType( $type, array $data ) {
if ( array_key_exists( $type, $this->typeToClass ) ) {
return false;
}
$class = array_key_exists( 'definition', $data ) ? $data['definition'] : 'ParamProcessor\ParamDefinition';
$this->typeToClass[$type] = $class;
$defaults = [
'string-parser' => 'ValueParsers\NullParser',
'typed-parser' => 'ValueParsers\NullParser',
'validator' => 'ValueValidators\NullValidator',
'validation-callback' => null,
];
$this->typeToComponent[$type] = [];
foreach ( $defaults as $component => $default ) {
$this->typeToComponent[$type][$component] = array_key_exists( $component, $data ) ? $data[$component] : $default;
}
return true;
}
/**
* Creates a new instance of a IParamDefinition based on the provided type.
*
* @since 1.0
*
* @param string $type
* @param string $name
* @param mixed $default
* @param string $message
* @param boolean $isList
*
* @return IParamDefinition
* @throws OutOfBoundsException
*/
public function newDefinition( $type, $name, $default, $message, $isList = false ) {
if ( !array_key_exists( $type, $this->typeToClass ) ) {
throw new OutOfBoundsException( 'Unknown parameter type "' . $type . '".' );
}
$class = $this->typeToClass[$type];
/**
* @var IParamDefinition $definition
*/
$definition = new $class(
$type,
$name,
$default,
$message,
$isList
);
$validator = $this->typeToComponent[$type]['validator'];
if ( $validator !== '\ValueValidators\NullValidator' ) {
$definition->setValueValidator( new $validator() );
}
$validationCallback = $this->typeToComponent[$type]['validation-callback'];
if ( $validationCallback !== null ) {
$definition->setValidationCallback( $validationCallback );
}
return $definition;
}
/**
* Returns the specified component for the provided parameter type.
* This method is likely to change in the future in a compat breaking way.
*
* @since 1.0
*
* @param string $paramType
* @param string $componentType
*
* @throws Exception
* @return mixed
*/
public function getComponentForType( $paramType, $componentType ) {
if ( !array_key_exists( $paramType, $this->typeToComponent ) ) {
throw new Exception( 'Unknown parameter type "' . $paramType . '".' );
}
if ( !array_key_exists( $componentType, $this->typeToComponent[$paramType] ) ) {
throw new Exception( 'Unknown parameter component type "' . $paramType . '".' );
}
return $this->typeToComponent[$paramType][$componentType];
}
/**
* Construct a new ParamDefinition from an array.
*
* @since 1.0
*
* @param array $param
* @param bool $getMad
*
* @return IParamDefinition|false
* @throws Exception
*/
public function newDefinitionFromArray( array $param, $getMad = true ) {
foreach ( [ 'name', 'message' ] as $requiredElement ) {
if ( !array_key_exists( $requiredElement, $param ) ) {
if ( $getMad ) {
throw new Exception( 'Could not construct a ParamDefinition from an array without ' . $requiredElement . ' element' );
}
return false;
}
}
$parameter = $this->newDefinition(
array_key_exists( 'type', $param ) ? $param['type'] : 'string',
$param['name'],
array_key_exists( 'default', $param ) ? $param['default'] : null,
$param['message'],
array_key_exists( 'islist', $param ) ? $param['islist'] : false
);
$parameter->setArrayValues( $param );
return $parameter;
}
}
|
