Class for updating an MWRestrictions value (which is, currently, basically just an IP address list). More...

Collaboration diagram for HTMLRestrictionsField:

[legend]

Public Member Functions
	__construct (array $params)

	getDefault ()

	getHelpText ()
	Determine the help text to display.

	getInputHTML ( $value)

	getInputOOUI ( $value)

	loadDataFromRequest ( $request)

	validate ( $value, $alldata)

Public Member Functions inherited from HTMLTextAreaField
	__construct ( $params)

	getCols ()

	getRows ()

	getSpellCheck ()

Public Member Functions inherited from HTMLFormField
	cancelSubmit ( $value, $alldata)
	Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.

	canDisplayErrors ()
	True if this field type is able to display errors; false if validation errors need to be displayed in the main HTMLForm error area.

	filter ( $value, $alldata)

	getAttributes (array $list)
	Returns the given attributes from the parameters.

	getDiv ( $value)
	Get the complete div for the input, including help text, labels, and whatever.

	getErrorsAndErrorClass ( $value)
	Determine form errors to display and their classes.

	getErrorsRaw ( $value)
	Determine form errors to display, returning them in an array.

	getHelpTextHtmlDiv ( $helptext)
	Generate help text HTML in div format.

	getHelpTextHtmlRaw ( $helptext)
	Generate help text HTML formatted for raw output.

	getHelpTextHtmlTable ( $helptext)
	Generate help text HTML in table format.

	getInline ( $value)
	Get the complete field as an inline element.

	getLabel ()

	getLabelHtml ( $cellAttributes=[])

	getName ()
	Get the field name that will be used for submission.

	getOOUI ( $value)
	Get the OOUI version of the div.

	getOptions ()
	Fetch the array of options from the field's parameters.

	getOptionsOOUI ()
	Get options and make them into arrays suitable for OOUI.

	getRaw ( $value)
	Get the complete raw fields for the input, including help text, labels, and whatever.

	getTableRow ( $value)
	Get the complete table row for the input, including help text, labels, and whatever.

	getTooltipAndAccessKey ()
	Returns the attributes required for the tooltip and accesskey, for Html::element() etc.

	getTooltipAndAccessKeyOOUI ()
	Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.

	getVForm ( $value)
	Get the complete field for the input, including help text, labels, and whatever.

	hasVisibleOutput ()
	If this field has a user-visible output or not.

	isDisabled ( $alldata)
	Test whether this field is supposed to be disabled, based on the values of the other form fields.

	isHelpInline ()
	Determine if the help text should be displayed inline.

	isHidden ( $alldata)
	Test whether this field is supposed to be hidden, based on the values of the other form fields.

	msg ( $key,... $params)
	Get a translated interface message.

	needsJSForHtml5FormValidation ()
	Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.

	setShowEmptyLabel ( $show)
	Tell the field whether to generate a separate label element if its label is blank.

	skipLoadData ( $request)
	Skip this field when collecting data.

Protected Attributes
const	DEFAULT_ROWS = 5

Protected Attributes inherited from HTMLTextAreaField
	$mPlaceholder = ''

	$mUseEditFont = false

const	DEFAULT_COLS = 80

const	DEFAULT_ROWS = 25

Protected Attributes inherited from HTMLFormField
	$mClass = ''

array	$mCondState = []
	Array to hold params for 'hide-if' or 'disable-if' statements.

	$mCondStateClass = []

	$mDefault

	$mDir

	$mFilterCallback

	$mHelpClass = false

	$mID

	$mLabel

	$mName

array null false	$mOptions = false

	$mOptionsLabelsNotFromMessage = false

bool	$mShowEmptyLabels = true
	If true will generate an empty div element with no label.

	$mVFormClass = ''

Additional Inherited Members
Static Public Member Functions inherited from HTMLFormField
static	flattenOptions ( $options)
	flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>".

static	forceToStringRecursive ( $array)
	Recursively forces values in an array to strings, because issues arise with integer 0 as a value.

Public Attributes inherited from HTMLFormField
array array[]	$mParams

HTMLForm null	$mParent

Protected Member Functions inherited from HTMLFormField
	checkStateRecurse (array $alldata, array $params)
	Helper function for isHidden and isDisabled to handle recursive data structures.

	getClassName ()
	Gets the non namespaced class name.

	getFieldLayoutOOUI ( $inputField, $config)
	Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.

	getLabelAlignOOUI ()
	Get label alignment when generating field for OOUI.

	getMessage ( $value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.

	getNearestField ( $name, $backCompat=false)
	Get the closest field matching a given name.

	getNearestFieldByName ( $alldata, $name, $asDisplay=false)
	Fetch a field value from $alldata for the closest field matching a given name.

	getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
	Fetch a field value from $alldata for the closest field matching a given name.

	getOOUIModules ()
	Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.

	isSubmitAttempt (WebRequest $request)
	Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just view it? This can't normally be distinguished for e.g.

	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to?

	parseCondState ( $params)
	Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML.

	parseCondStateForClient ()
	Parse the cond-state array for client-side.

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

	validateCondState ( $params)
	Validate the cond-state params, the existence check of fields should be done later.

Static Protected Member Functions inherited from HTMLFormField
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Detailed Description

Class for updating an MWRestrictions value (which is, currently, basically just an IP address list).

Will be represented as a textarea with one address per line, with intelligent defaults for label, help text and row count.

The value returned will be an MWRestrictions or the input string if it was not a list of valid IP ranges.

Stability: stable: to extend

Definition at line 19 of file HTMLRestrictionsField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLRestrictionsField::__construct ( array $params )

Stability: stable: to call

Definition at line 26 of file HTMLRestrictionsField.php.

References HTMLFormField\msg().

Member Function Documentation

◆ getDefault()

HTMLRestrictionsField::getDefault ( )

Returns: MWRestrictions

Reimplemented from HTMLFormField.

Definition at line 58 of file HTMLRestrictionsField.php.

Referenced by loadDataFromRequest().

◆ getHelpText()

HTMLRestrictionsField::getHelpText ( )

Determine the help text to display.

Stability: stable: to override

Since: 1.20

Returns: string|null HTML

Reimplemented from HTMLFormField.

Definition at line 33 of file HTMLRestrictionsField.php.

References HTMLFormField\msg().

◆ getInputHTML()

HTMLRestrictionsField::getInputHTML ( $value )

Parameters

string | MWRestrictions $value

Returns: string

Reimplemented from HTMLTextAreaField.

Definition at line 106 of file HTMLRestrictionsField.php.

◆ getInputOOUI()

HTMLRestrictionsField::getInputOOUI ( $value )

Parameters

MWRestrictions $value

Returns: string

Reimplemented from HTMLTextAreaField.

Definition at line 117 of file HTMLRestrictionsField.php.

◆ loadDataFromRequest()

HTMLRestrictionsField::loadDataFromRequest ( $request )

Parameters

WebRequest $request

Returns: string|MWRestrictions Restrictions object or original string if invalid

Reimplemented from HTMLFormField.

Definition at line 41 of file HTMLRestrictionsField.php.

References getDefault().

◆ validate()

HTMLRestrictionsField::validate	(		$value,
			$alldata )

Parameters

string \| MWRestrictions	$value	The value the field was submitted with
array	$alldata	The data collected from the form

Returns: bool|string|Message True on success, or String/Message error to display, or false to fail validation without displaying an error.

Reimplemented from HTMLFormField.

Definition at line 69 of file HTMLRestrictionsField.php.

References HTMLFormField\isHidden(), HTMLFormField\msg(), and MWRestrictions\toArray().

Member Data Documentation

◆ DEFAULT_ROWS

const HTMLRestrictionsField::DEFAULT_ROWS = 5

protected

Definition at line 20 of file HTMLRestrictionsField.php.

The documentation for this class was generated from the following file:

includes/htmlform/fields/HTMLRestrictionsField.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefault()

◆ getHelpText()

◆ getInputHTML()

◆ getInputOOUI()

◆ loadDataFromRequest()

◆ validate()

Member Data Documentation

◆ DEFAULT_ROWS