MediaWiki  master
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;
57  const ARR = 5;
58  /* @} */
59 
70  protected $options = [];
71 
72  # Setting up
73 
81  public function add( $name, $default, $type = self::AUTO ) {
82  $option = [];
83  $option['default'] = $default;
84  $option['value'] = null;
85  $option['consumed'] = false;
86 
87  if ( $type !== self::AUTO ) {
88  $option['type'] = $type;
89  } else {
90  $option['type'] = self::guessType( $default );
91  }
92 
93  $this->options[$name] = $option;
94  }
95 
101  public function delete( $name ) {
102  $this->validateName( $name, true );
103  unset( $this->options[$name] );
104  }
105 
117  public static function guessType( $data ) {
118  if ( is_bool( $data ) ) {
119  return self::BOOL;
120  } elseif ( is_int( $data ) ) {
121  return self::INT;
122  } elseif ( is_float( $data ) ) {
123  return self::FLOAT;
124  } elseif ( is_string( $data ) ) {
125  return self::STRING;
126  } elseif ( is_array( $data ) ) {
127  return self::ARR;
128  } else {
129  throw new MWException( 'Unsupported datatype' );
130  }
131  }
132 
133  # Handling values
134 
143  public function validateName( $name, $strict = false ) {
144  if ( !isset( $this->options[$name] ) ) {
145  if ( $strict ) {
146  throw new MWException( "Invalid option $name" );
147  } else {
148  return false;
149  }
150  }
151 
152  return true;
153  }
154 
163  public function setValue( $name, $value, $force = false ) {
164  $this->validateName( $name, true );
165 
166  if ( !$force && $value === $this->options[$name]['default'] ) {
167  // null default values as unchanged
168  $this->options[$name]['value'] = null;
169  } else {
170  $this->options[$name]['value'] = $value;
171  }
172  }
173 
180  public function getValue( $name ) {
181  $this->validateName( $name, true );
182 
183  return $this->getValueReal( $this->options[$name] );
184  }
185 
192  protected function getValueReal( $option ) {
193  if ( $option['value'] !== null ) {
194  return $option['value'];
195  } else {
196  return $option['default'];
197  }
198  }
199 
205  public function reset( $name ) {
206  $this->validateName( $name, true );
207  $this->options[$name]['value'] = null;
208  }
209 
219  public function consumeValue( $name ) {
220  $this->validateName( $name, true );
221  $this->options[$name]['consumed'] = true;
222 
223  return $this->getValueReal( $this->options[$name] );
224  }
225 
235  public function consumeValues( $names ) {
236  $out = [];
237 
238  foreach ( $names as $name ) {
239  $this->validateName( $name, true );
240  $this->options[$name]['consumed'] = true;
241  $out[] = $this->getValueReal( $this->options[$name] );
242  }
243 
244  return $out;
245  }
246 
253  public function validateIntBounds( $name, $min, $max ) {
254  $this->validateBounds( $name, $min, $max );
255  }
256 
268  public function validateBounds( $name, $min, $max ) {
269  $this->validateName( $name, true );
270  $type = $this->options[$name]['type'];
271 
272  if ( $type !== self::INT && $type !== self::FLOAT ) {
273  throw new MWException( "Option $name is not of type INT or FLOAT" );
274  }
275 
276  $value = $this->getValueReal( $this->options[$name] );
277  $value = max( $min, min( $max, $value ) );
278 
279  $this->setValue( $name, $value );
280  }
281 
288  public function getUnconsumedValues( $all = false ) {
289  $values = [];
290 
291  foreach ( $this->options as $name => $data ) {
292  if ( !$data['consumed'] ) {
293  if ( $all || $data['value'] !== null ) {
294  $values[$name] = $this->getValueReal( $data );
295  }
296  }
297  }
298 
299  return $values;
300  }
301 
306  public function getChangedValues() {
307  $values = [];
308 
309  foreach ( $this->options as $name => $data ) {
310  if ( $data['value'] !== null ) {
311  $values[$name] = $data['value'];
312  }
313  }
314 
315  return $values;
316  }
317 
322  public function getAllValues() {
323  $values = [];
324 
325  foreach ( $this->options as $name => $data ) {
326  $values[$name] = $this->getValueReal( $data );
327  }
328 
329  return $values;
330  }
331 
332  # Reading values
333 
344  public function fetchValuesFromRequest( WebRequest $r, $optionKeys = null ) {
345  if ( !$optionKeys ) {
346  $optionKeys = array_keys( $this->options );
347  }
348 
349  foreach ( $optionKeys as $name ) {
350  $default = $this->options[$name]['default'];
351  $type = $this->options[$name]['type'];
352 
353  switch ( $type ) {
354  case self::BOOL:
355  $value = $r->getBool( $name, $default );
356  break;
357  case self::INT:
358  $value = $r->getInt( $name, $default );
359  break;
360  case self::FLOAT:
361  $value = $r->getFloat( $name, $default );
362  break;
363  case self::STRING:
364  $value = $r->getText( $name, $default );
365  break;
366  case self::INTNULL:
367  $value = $r->getIntOrNull( $name );
368  break;
369  case self::ARR:
370  $value = $r->getArray( $name );
371  break;
372  default:
373  throw new MWException( 'Unsupported datatype' );
374  }
375 
376  if ( $value !== null ) {
377  $this->options[$name]['value'] = $value === $default ? null : $value;
378  }
379  }
380  }
381 
386  /* @{ */
387 
393  public function offsetExists( $name ) {
394  return isset( $this->options[$name] );
395  }
396 
402  public function offsetGet( $name ) {
403  return $this->getValue( $name );
404  }
405 
411  public function offsetSet( $name, $value ) {
412  $this->setValue( $name, $value );
413  }
414 
419  public function offsetUnset( $name ) {
420  $this->delete( $name );
421  }
422  /* @} */
423 }
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
getInt( $name, $default=0)
Fetch an integer value from the input or return $default if not set.
Definition: WebRequest.php:534
const INTNULL
Integer type or null, maps to WebRequest::getIntOrNull() This is useful for the namespace selector...
Definition: FormOptions.php:54
consumeValues( $names)
Get the values of given options and mark them as &#39;consumed&#39;.
$value
reset( $name)
Delete the option value.
offsetUnset( $name)
Delete the option.
consumeValue( $name)
Get the value of given option and mark it as &#39;consumed&#39;.
getUnconsumedValues( $all=false)
Get all remaining values which have not been consumed by consumeValue() or consumeValues().
getFloat( $name, $default=0.0)
Fetch a floating point value from the input or return $default if not set.
Definition: WebRequest.php:563
add( $name, $default, $type=self::AUTO)
Add an option to be handled by this FormOptions instance.
Definition: FormOptions.php:81
validateIntBounds( $name, $min, $max)
getBool( $name, $default=false)
Fetch a boolean value from the input or return $default if not set.
Definition: WebRequest.php:576
fetchValuesFromRequest(WebRequest $r, $optionKeys=null)
Fetch values for all options (or selected options) from the given WebRequest, making them available f...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
const ARR
Array type, maps guessType() to WebRequest::getArray()
Definition: FormOptions.php:57
validateBounds( $name, $min, $max)
Constrain a numeric value for a given option to a given range.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
offsetSet( $name, $value)
Set an option to given value.
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
getValueReal( $option)
Return current option value, based on a structure taken from $options.
const INT
Integer type, maps guessType() to WebRequest::getInt()
Definition: FormOptions.php:45
$options
Map of known option names to information about them.
Definition: FormOptions.php:70
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
static guessType( $data)
Used to find out which type the data is.
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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
getText( $name, $default='')
Fetch a text string from the given array or return $default if it&#39;s not set.
Definition: WebRequest.php:618
setValue( $name, $value, $force=false)
Use to set the value of an option.
const STRING
String type, maps guessType() to WebRequest::getText()
Definition: FormOptions.php:43
offsetExists( $name)
Whether the option exists.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getArray( $name, $default=null)
Fetch an array from the input or return $default if it&#39;s not set.
Definition: WebRequest.php:498
getIntOrNull( $name)
Fetch an integer value from the input or return null if empty.
Definition: WebRequest.php:546
getChangedValues()
Return options modified as an array ( name => value )
getAllValues()
Format options to an array ( name => value )
validateName( $name, $strict=false)
Verify that the given option name exists.
getValue( $name)
Get the value for the given option name.
const AUTO
Mark value for automatic detection (for simple data types only)
Definition: FormOptions.php:41
offsetGet( $name)
Retrieve an option value.