Helper class to keep track of options when mixing links and form elements. More...

Inheritance diagram for FormOptions:

Public Member Functions
	add ($name, $default, $type=self::AUTO)
	consumeValue ($name)
	consumeValues ($names)
	delete ($name)
	fetchValuesFromRequest (WebRequest $r, $values=false)
	getAllValues ()
	Format options to an array ( name => value)
	getChangedValues ()
	Return options modified as an array ( name => value )
	getUnconsumedValues ($all=false)
	Getting the data out for use.
	getValue ($name)
	Get the value for the given option name.
	reset ($name)
	Delete the option value.
	setValue ($name, $value, $force=false)
	Use to set the value of an option.
	validateIntBounds ($name, $min, $max)
	Validate and set an option integer value The value will be altered to fit in the range.
	validateName ($name, $strict=false)
	Verify the given option name exist.
ArrayAccess functions
Those function implements PHP ArrayAccess interface See also: http://php.net/manual/en/class.arrayaccess.php
	offsetExists ($name)
	Whether option exist.
	offsetGet ($name)
	Retrieve an option value.
	offsetSet ($name, $value)
	Set an option to given value.
	offsetUnset ($name)
	Delete the option.
Static Public Member Functions
static	guessType ($data)
	Used to find out which type the data is.
Public Attributes
Type constants
Used internally to map an option value to a WebRequest accessor
const	AUTO = -1
	Mark value for automatic detection (for simple data types only)
const	STRING = 0
	String type, maps guessType() to WebRequest::getText()
const	INT = 1
	Integer type, maps guessType() to WebRequest::getInt()
const	BOOL = 2
	Boolean type, maps guessType() to WebRequest::getBool()
const	INTNULL = 3
	Integer type or null, maps to WebRequest::getIntOrNull() This is useful for the namespace selector.
Protected Member Functions
	getValueReal ($option)
Protected Attributes
	$options = array()

Detailed Description

Helper class to keep track of options when mixing links and form elements.

Todo:: This badly need some examples and tests :-)

Definition at line 33 of file FormOptions.php.

Member Function Documentation

FormOptions::add	(	$	name,
		$	default,
		$	type = `self::AUTO`
	)

Definition at line 59 of file FormOptions.php.

References guessType().

Referenced by SpecialLog\execute(), and SpecialNewpages\setup().

FormOptions::consumeValue ( $ name )

Todo:: Document

Parameters:

$name String: option name

Returns:: null

Definition at line 182 of file FormOptions.php.

References getValueReal(), and validateName().

FormOptions::consumeValues ( $ names )

Todo:: Document

Parameters:

$names Array: array of option names

Returns:: null

Definition at line 194 of file FormOptions.php.

References $out, getValueReal(), and validateName().

FormOptions::delete ( $ name )

Definition at line 74 of file FormOptions.php.

References validateName().

FormOptions::fetchValuesFromRequest	(	WebRequest $	r,
		$	values = `false`
	)

Definition at line 280 of file FormOptions.php.

References $value, WebRequest\getBool(), WebRequest\getInt(), WebRequest\getIntOrNull(), and WebRequest\getText().

Referenced by SpecialNewpages\setup().

FormOptions::getAllValues ( )

Format options to an array ( name => value)

Returns:: Array

Definition at line 268 of file FormOptions.php.

References getValueReal().

FormOptions::getChangedValues ( )

Return options modified as an array ( name => value )

Returns:: Array

Definition at line 252 of file FormOptions.php.

FormOptions::getUnconsumedValues ( $ all = false )

Getting the data out for use.

Parameters:

$all	Boolean: whether to include unchanged options (default: false)

Returns:: Array

Definition at line 234 of file FormOptions.php.

References getValueReal().

FormOptions::getValue ( $ name )

Get the value for the given option name.

Internally use getValueReal()

Parameters:

$name String: option name

Returns:: Mixed

Definition at line 147 of file FormOptions.php.

References getValueReal(), and validateName().

Referenced by offsetGet(), and SpecialLog\show().

FormOptions::getValueReal ( $ option ) [protected]

Todo:: Document

Parameters:

$option Array: array structure describing the option

Returns:: Mixed. Value or the default value if it is null

Definition at line 158 of file FormOptions.php.

Referenced by consumeValue(), consumeValues(), getAllValues(), getUnconsumedValues(), getValue(), and validateIntBounds().

static FormOptions::guessType ( $ data ) [static]

Used to find out which type the data is.

All types are defined in the 'Type constants' section of this class Please note we do not support detection of INTNULL MediaWiki type which will be assumed as INT if the data is an integer.

Parameters:

$data Mixed: value to guess type for

Exceptions:

MWException Unsupported datatype

Returns:: int Type constant

Definition at line 89 of file FormOptions.php.

References BOOL, INT, and STRING.

Referenced by add().

FormOptions::offsetExists ( $ name )

Whether option exist.

Returns:: bool

Definition at line 317 of file FormOptions.php.

FormOptions::offsetGet ( $ name )

Retrieve an option value.

Returns:: Mixed

Definition at line 324 of file FormOptions.php.

References getValue().

FormOptions::offsetSet	(	$	name,
		$	value
	)

Set an option to given value.

Definition at line 328 of file FormOptions.php.

References $value, and setValue().

FormOptions::offsetUnset ( $ name )

Delete the option.

Definition at line 332 of file FormOptions.php.

FormOptions::reset ( $ name )

Delete the option value.

This will make future calls to getValue() return the default value.

Parameters:

$name String: option name

Returns:: null

Definition at line 172 of file FormOptions.php.

References validateName().

Referenced by SpecialRecentChanges\buildMainQueryConds().

FormOptions::setValue	(	$	name,
		$	value,
		$	force = `false`
	)

Use to set the value of an option.

Parameters:

$name	String: option name
$value	Mixed: value for the option
$force	Boolean: whether to set the value when it is equivalent to the default value for this option (default false).