MediaWiki  1.28.1
FormOptions.php
Go to the documentation of this file.
1 <?php
35 class FormOptions implements ArrayAccess {
39  /* @{ */
41  const AUTO = -1;
43  const STRING = 0;
45  const INT = 1;
48  const FLOAT = 4;
50  const BOOL = 2;
54  const INTNULL = 3;
55  /* @} */
56 
67  protected $options = [];
68 
69  # Setting up
70 
78  public function add( $name, $default, $type = self::AUTO ) {
79  $option = [];
80  $option['default'] = $default;
81  $option['value'] = null;
82  $option['consumed'] = false;
83 
84  if ( $type !== self::AUTO ) {
85  $option['type'] = $type;
86  } else {
87  $option['type'] = self::guessType( $default );
88  }
89 
90  $this->options[$name] = $option;
91  }
92 
98  public function delete( $name ) {
99  $this->validateName( $name, true );
100  unset( $this->options[$name] );
101  }
102 
114  public static function guessType( $data ) {
115  if ( is_bool( $data ) ) {
116  return self::BOOL;
117  } elseif ( is_int( $data ) ) {
118  return self::INT;
119  } elseif ( is_float( $data ) ) {
120  return self::FLOAT;
121  } elseif ( is_string( $data ) ) {
122  return self::STRING;
123  } else {
124  throw new MWException( 'Unsupported datatype' );
125  }
126  }
127 
128  # Handling values
129 
138  public function validateName( $name, $strict = false ) {
139  if ( !isset( $this->options[$name] ) ) {
140  if ( $strict ) {
141  throw new MWException( "Invalid option $name" );
142  } else {
143  return false;
144  }
145  }
146 
147  return true;
148  }
149 
158  public function setValue( $name, $value, $force = false ) {
159  $this->validateName( $name, true );
160 
161  if ( !$force && $value === $this->options[$name]['default'] ) {
162  // null default values as unchanged
163  $this->options[$name]['value'] = null;
164  } else {
165  $this->options[$name]['value'] = $value;
166  }
167  }
168 
175  public function getValue( $name ) {
176  $this->validateName( $name, true );
177 
178  return $this->getValueReal( $this->options[$name] );
179  }
180 
187  protected function getValueReal( $option ) {
188  if ( $option['value'] !== null ) {
189  return $option['value'];
190  } else {
191  return $option['default'];
192  }
193  }
194 
200  public function reset( $name ) {
201  $this->validateName( $name, true );
202  $this->options[$name]['value'] = null;
203  }
204 
214  public function consumeValue( $name ) {
215  $this->validateName( $name, true );
216  $this->options[$name]['consumed'] = true;
217 
218  return $this->getValueReal( $this->options[$name] );
219  }
220 
230  public function consumeValues( $names ) {
231  $out = [];
232 
233  foreach ( $names as $name ) {
234  $this->validateName( $name, true );
235  $this->options[$name]['consumed'] = true;
236  $out[] = $this->getValueReal( $this->options[$name] );
237  }
238 
239  return $out;
240  }
241 
245  public function validateIntBounds( $name, $min, $max ) {
246  $this->validateBounds( $name, $min, $max );
247  }
248 
260  public function validateBounds( $name, $min, $max ) {
261  $this->validateName( $name, true );
262  $type = $this->options[$name]['type'];
263 
264  if ( $type !== self::INT && $type !== self::FLOAT ) {
265  throw new MWException( "Option $name is not of type INT or FLOAT" );
266  }
267 
268  $value = $this->getValueReal( $this->options[$name] );
269  $value = max( $min, min( $max, $value ) );
270 
271  $this->setValue( $name, $value );
272  }
273 
280  public function getUnconsumedValues( $all = false ) {
281  $values = [];
282 
283  foreach ( $this->options as $name => $data ) {
284  if ( !$data['consumed'] ) {
285  if ( $all || $data['value'] !== null ) {
286  $values[$name] = $this->getValueReal( $data );
287  }
288  }
289  }
290 
291  return $values;
292  }
293 
298  public function getChangedValues() {
299  $values = [];
300 
301  foreach ( $this->options as $name => $data ) {
302  if ( $data['value'] !== null ) {
303  $values[$name] = $data['value'];
304  }
305  }
306 
307  return $values;
308  }
309 
314  public function getAllValues() {
315  $values = [];
316 
317  foreach ( $this->options as $name => $data ) {
318  $values[$name] = $this->getValueReal( $data );
319  }
320 
321  return $values;
322  }
323 
324  # Reading values
325 
336  public function fetchValuesFromRequest( WebRequest $r, $optionKeys = null ) {
337  if ( !$optionKeys ) {
338  $optionKeys = array_keys( $this->options );
339  }
340 
341  foreach ( $optionKeys as $name ) {
342  $default = $this->options[$name]['default'];
343  $type = $this->options[$name]['type'];
344 
345  switch ( $type ) {
346  case self::BOOL:
347  $value = $r->getBool( $name, $default );
348  break;
349  case self::INT:
350  $value = $r->getInt( $name, $default );
351  break;
352  case self::FLOAT:
353  $value = $r->getFloat( $name, $default );
354  break;
355  case self::STRING:
356  $value = $r->getText( $name, $default );
357  break;
358  case self::INTNULL:
359  $value = $r->getIntOrNull( $name );
360  break;
361  default:
362  throw new MWException( 'Unsupported datatype' );
363  }
364 
365  if ( $value !== null ) {
366  $this->options[$name]['value'] = $value === $default ? null : $value;
367  }
368  }
369  }
370 
375  /* @{ */
381  public function offsetExists( $name ) {
382  return isset( $this->options[$name] );
383  }
384 
390  public function offsetGet( $name ) {
391  return $this->getValue( $name );
392  }
393 
399  public function offsetSet( $name, $value ) {
400  $this->setValue( $name, $value );
401  }
402 
407  public function offsetUnset( $name ) {
408  $this->delete( $name );
409  }
410  /* @} */
411 }
validateName($name, $strict=false)
Verify that the given option name exists.
Helper class to keep track of options when mixing links and form elements.
Definition: FormOptions.php:35
const BOOL
Boolean type, maps guessType() to WebRequest::getBool()
Definition: FormOptions.php:50
const FLOAT
Float type, maps guessType() to WebRequest::getFloat()
Definition: FormOptions.php:48
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:802
getUnconsumedValues($all=false)
Get all remaining values which have not been consumed by consumeValue() or consumeValues().
setValue($name, $value, $force=false)
Use to set the value of an option.
offsetExists($name)
Whether the option exists.
const INTNULL
Integer type or null, maps to WebRequest::getIntOrNull() This is useful for the namespace selector...
Definition: FormOptions.php:54
getValueReal($option)
Return current option value, based on a structure taken from $options.
getIntOrNull($name)
Fetch an integer value from the input or return null if empty.
Definition: WebRequest.php:535
$value
getBool($name, $default=false)
Fetch a boolean value from the input or return $default if not set.
Definition: WebRequest.php:565
consumeValue($name)
Get the value of given option and mark it as 'consumed'.
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place.Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
reset($name)
Delete the option value.
fetchValuesFromRequest(WebRequest $r, $optionKeys=null)
Fetch values for all options (or selected options) from the given WebRequest, making them available f...
offsetSet($name, $value)
Set an option to given value.
getFloat($name, $default=0.0)
Fetch a floating point value from the input or return $default if not set.
Definition: WebRequest.php:552
consumeValues($names)
Get the values of given options and mark them as 'consumed'.
getValue($name)
Get the value for the given option name.
static guessType($data)
Used to find out which type the data is.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
add($name, $default, $type=self::AUTO)
Add an option to be handled by this FormOptions instance.
Definition: FormOptions.php:78
validateIntBounds($name, $min, $max)
const INT
Integer type, maps guessType() to WebRequest::getInt()
Definition: FormOptions.php:45
validateBounds($name, $min, $max)
Constrain a numeric value for a given option to a given range.
$options
Map of known option names to information about them.
Definition: FormOptions.php:67
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const STRING
String type, maps guessType() to WebRequest::getText()
Definition: FormOptions.php:43
getChangedValues()
Return options modified as an array ( name => value )
getAllValues()
Format options to an array ( name => value )
getInt($name, $default=0)
Fetch an integer value from the input or return $default if not set.
Definition: WebRequest.php:523
offsetGet($name)
Retrieve an option value.
offsetUnset($name)
Delete the option.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
getText($name, $default= '')
Fetch a text string from the given array or return $default if it's not set.
Definition: WebRequest.php:607
const AUTO
Mark value for automatic detection (for simple data types only)
Definition: FormOptions.php:41
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300