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
|
<?php
/**
* Helper class to keep track of options when mixing links and form elements.
*
* @author Niklas Laxström
* @copyright Copyright © 2008, Niklas Laxström
*/
class FormOptions implements ArrayAccess {
const AUTO = -1; //! Automatically detects simple data types
const STRING = 0;
const INT = 1;
const BOOL = 2;
const INTNULL = 3; //! Useful for namespace selector
protected $options = array();
# Setting up
public function add( $name, $default, $type = self::AUTO ) {
$option = array();
$option['default'] = $default;
$option['value'] = null;
$option['consumed'] = false;
if ( $type !== self::AUTO ) {
$option['type'] = $type;
} else {
$option['type'] = self::guessType( $default );
}
$this->options[$name] = $option;
}
public function delete( $name ) {
$this->validateName( $name, true );
unset($this->options[$name]);
}
public static function guessType( $data ) {
if ( is_bool($data) ) {
return self::BOOL;
} elseif( is_int($data) ) {
return self::INT;
} elseif( is_string($data) ) {
return self::STRING;
} else {
throw new MWException( 'Unsupported datatype' );
}
}
# Handling values
public function validateName( $name, $strict = false ) {
if ( !isset($this->options[$name]) ) {
if ( $strict ) {
throw new MWException( "Invalid option $name" );
} else {
return false;
}
}
return true;
}
public function setValue( $name, $value, $force = false ) {
$this->validateName( $name, true );
if ( !$force && $value === $this->options[$name]['default'] ) {
// null default values as unchanged
$this->options[$name]['value'] = null;
} else {
$this->options[$name]['value'] = $value;
}
}
public function getValue( $name ) {
$this->validateName( $name, true );
return $this->getValueReal( $this->options[$name] );
}
protected function getValueReal( $option ) {
if ( $option['value'] !== null ) {
return $option['value'];
} else {
return $option['default'];
}
}
public function reset( $name ) {
$this->validateName( $name, true );
$this->options[$name]['value'] = null;
}
public function consumeValue( $name ) {
$this->validateName( $name, true );
$this->options[$name]['consumed'] = true;
return $this->getValueReal( $this->options[$name] );
}
public function consumeValues( /*Array*/ $names ) {
$out = array();
foreach ( $names as $name ) {
$this->validateName( $name, true );
$this->options[$name]['consumed'] = true;
$out[] = $this->getValueReal( $this->options[$name] );
}
return $out;
}
# Validating values
public function validateIntBounds( $name, $min, $max ) {
$this->validateName( $name, true );
if ( $this->options[$name]['type'] !== self::INT )
throw new MWException( "Option $name is not of type int" );
$value = $this->getValueReal( $this->options[$name] );
$value = max( $min, min( $max, $value ) );
$this->setValue( $name, $value );
}
# Getting the data out for use
public function getUnconsumedValues( $all = false ) {
$values = array();
foreach ( $this->options as $name => $data ) {
if ( !$data['consumed'] ) {
if ( $all || $data['value'] !== null ) {
$values[$name] = $this->getValueReal( $data );
}
}
}
return $values;
}
public function getChangedValues() {
$values = array();
foreach ( $this->options as $name => $data ) {
if ( $data['value'] !== null ) {
$values[$name] = $data['value'];
}
}
return $values;
}
public function getAllValues() {
$values = array();
foreach ( $this->options as $name => $data ) {
$values[$name] = $this->getValueReal( $data );
}
return $values;
}
# Reading values
public function fetchValuesFromRequest( WebRequest $r, $values = false ) {
if ( !$values ) {
$values = array_keys($this->options);
}
foreach ( $values as $name ) {
$default = $this->options[$name]['default'];
$type = $this->options[$name]['type'];
switch( $type ) {
case self::BOOL:
$value = $r->getBool( $name, $default ); break;
case self::INT:
$value = $r->getInt( $name, $default ); break;
case self::STRING:
$value = $r->getText( $name, $default ); break;
case self::INTNULL:
$value = $r->getIntOrNull( $name ); break;
default:
throw new MWException( 'Unsupported datatype' );
}
if ( $value !== null ) {
$this->options[$name]['value'] = $value === $default ? null : $value;
}
}
}
/* ArrayAccess methods */
public function offsetExists( $name ) {
return isset($this->options[$name]);
}
public function offsetGet( $name ) {
return $this->getValue( $name );
}
public function offsetSet( $name, $value ) {
return $this->setValue( $name, $value );
}
public function offsetUnset( $name ) {
return $this->delete( $name );
}
}
|
