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
|
<?php
namespace ParamProcessor;
use Exception;
use OutOfBoundsException;
use ParamProcessor\PackagePrivate\ParamType;
use ValueValidators\NullValidator;
/**
* Factory for ParamDefinition implementing objects.
*
* @licence GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
class ParamDefinitionFactory {
private $types;
/**
* @since 1.8
*/
public function __construct( ParameterTypes $types = null ) {
$this->types = $types ?? new ParameterTypes();
}
/**
* Returns a ParamDefinitionFactory that already has the core parameter types (@see ParameterTypes) registered.
*
* @since 1.6
*/
public static function newDefault(): self {
return new self( ParameterTypes::newCoreTypes() );
}
/**
* @deprecated since 1.0
*/
public static function singleton(): self {
static $instance = false;
if ( $instance === false ) {
$instance = new self();
$instance->registerGlobals();
}
return $instance;
}
/**
* Registers the parameter types specified in the global $wgParamDefinitions.
* @deprecated since 1.6
*/
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: DEPRECATED since 1.6 - 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 DEPRECATED since 1.6 - Indicates if the type was registered
*/
public function registerType( $type, array $data ) {
if ( $this->types->hasType( $type ) ) {
return false;
}
$this->types->addType( $type, $data );
return true;
}
/**
* Creates a new instance of a ParamDefinition based on the provided type.
*
* @param string $typeName
* @param string $name
* @param mixed $default
* @param string $message
* @param boolean $isList
*
* @return ParamDefinition
* @throws OutOfBoundsException
*/
public function newDefinition( string $typeName, string $name, $default, string $message, bool $isList = false ): ParamDefinition {
if ( !$this->types->hasType( $typeName ) ) {
throw new OutOfBoundsException( 'Unknown parameter type "' . $typeName . '".' );
}
$type = $this->types->getType( $typeName );
$class = $type->getClassName();
/**
* @var ParamDefinition $definition
*/
$definition = new $class(
$typeName,
$name,
$default,
$message,
$isList
);
$validator = $type->getValidatorClass();
if ( $validator !== NullValidator::class ) {
$definition->setValueValidator( new $validator() );
}
$validationCallback = $type->getValidationCallback();
if ( $validationCallback !== null ) {
$definition->setValidationCallback( $validationCallback );
}
return $definition;
}
/**
* Package private
*/
public function getType( string $typeName ): ParamType {
return $this->types->getType( $typeName );
}
/**
* @param array $definitionArray
* @param bool $getMad DEPRECATED since 1.6
*
* @return ParamDefinition|false
* @throws Exception
*/
public function newDefinitionFromArray( array $definitionArray, $getMad = true ) {
foreach ( [ 'name', 'message' ] as $requiredElement ) {
if ( !array_key_exists( $requiredElement, $definitionArray ) ) {
if ( $getMad ) {
throw new Exception( 'Could not construct a ParamDefinition from an array without ' . $requiredElement . ' element' );
}
return false;
}
}
$definition = $this->newDefinition(
array_key_exists( 'type', $definitionArray ) ? $definitionArray['type'] : 'string',
$definitionArray['name'],
array_key_exists( 'default', $definitionArray ) ? $definitionArray['default'] : null,
$definitionArray['message'],
array_key_exists( 'islist', $definitionArray ) ? $definitionArray['islist'] : false
);
$definition->setArrayValues( $definitionArray );
return $definition;
}
/**
* @since 1.9
*
* @param array $definitionArrays Each element must either be
* - A definition array with "name" key
* - A name key pointing to a definition array
* - A ParamDefinition instance (discouraged)
*
* @return ParamDefinition[]
* @throws Exception
*/
public function newDefinitionsFromArrays( array $definitionArrays ): array {
$cleanList = [];
foreach ( $definitionArrays as $key => $definitionArray ) {
if ( is_array( $definitionArray ) ) {
if ( !array_key_exists( 'name', $definitionArray ) && is_string( $key ) ) {
$definitionArray['name'] = $key;
}
$definitionArray = $this->newDefinitionFromArray( $definitionArray );
}
if ( !( $definitionArray instanceof IParamDefinition ) ) {
throw new Exception( 'Parameter definition not an instance of IParamDefinition' );
}
$cleanList[$definitionArray->getName()] = $definitionArray;
}
return $cleanList;
}
}
|
