MediaWiki  master
HTMLRestrictionsField Class Reference

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

Inheritance diagram for HTMLRestrictionsField:
Collaboration diagram for HTMLRestrictionsField:

Public Member Functions

 __construct (array $params)
 Stable to call . More...
 
 getDefault ()
 
 getHelpText ()
 Determine the help text to display Stable to override. More...
 
 getInputHTML ( $value)
 
 getInputOOUI ( $value)
 
 loadDataFromRequest ( $request)
 
 validate ( $value, $alldata)
 
- Public Member Functions inherited from HTMLTextAreaField
 __construct ( $params)
 Stable to call. More...
 
 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. More...
 
 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. More...
 
 filter ( $value, $alldata)
 Stable to override. More...
 
 getAttributes (array $list)
 Returns the given attributes from the parameters Stable to override. More...
 
 getDiv ( $value)
 Get the complete div for the input, including help text, labels, and whatever. More...
 
 getErrorsAndErrorClass ( $value)
 Determine form errors to display and their classes. More...
 
 getErrorsRaw ( $value)
 Determine form errors to display, returning them in an array. More...
 
 getHelpTextHtmlDiv ( $helptext)
 Generate help text HTML in div format. More...
 
 getHelpTextHtmlRaw ( $helptext)
 Generate help text HTML formatted for raw output. More...
 
 getHelpTextHtmlTable ( $helptext)
 Generate help text HTML in table format. More...
 
 getInline ( $value)
 Get the complete field as an inline element. More...
 
 getLabel ()
 Stable to override. More...
 
 getLabelHtml ( $cellAttributes=[])
 Stable to override. More...
 
 getOOUI ( $value)
 Get the OOUI version of the div. More...
 
 getOptions ()
 Fetch the array of options from the field's parameters. More...
 
 getOptionsOOUI ()
 Get options and make them into arrays suitable for OOUI. More...
 
 getRaw ( $value)
 Get the complete raw fields for the input, including help text, labels, and whatever. More...
 
 getTableRow ( $value)
 Get the complete table row for the input, including help text, labels, and whatever. More...
 
 getTooltipAndAccessKey ()
 Returns the attributes required for the tooltip and accesskey, for Html::element() etc. More...
 
 getTooltipAndAccessKeyOOUI ()
 Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config. More...
 
 getVForm ( $value)
 Get the complete field for the input, including help text, labels, and whatever. More...
 
 hasVisibleOutput ()
 If this field has a user-visible output or not. More...
 
 isHelpInline ()
 Determine if the help text should be displayed inline. More...
 
 isHidden ( $alldata)
 Test whether this field is supposed to be hidden, based on the values of the other form fields. More...
 
 msg ( $key,... $params)
 Get a translated interface message. More...
 
 needsJSForHtml5FormValidation ()
 Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly. More...
 
 setShowEmptyLabel ( $show)
 Tell the field whether to generate a separate label element if its label is blank. More...
 
 skipLoadData ( $request)
 Skip this field when collecting data. More...
 

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 = ''
 
 $mDefault
 
 $mDir
 
 $mFilterCallback
 
 $mHelpClass = false
 
 $mHideIf = null
 
 $mID
 
 $mLabel
 
 $mName
 
array bool null $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 
 $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>". More...
 
static forceToStringRecursive ( $array)
 Recursively forces values in an array to strings, because issues arise with integer 0 as a value. More...
 
- Public Attributes inherited from HTMLFormField
array array[] $mParams
 
HTMLForm null $mParent
 
- Protected Member Functions inherited from HTMLFormField
 getFieldLayoutOOUI ( $inputField, $config)
 Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output. More...
 
 getLabelAlignOOUI ()
 Get label alignment when generating field for OOUI. More...
 
 getMessage ( $value)
 Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message. More...
 
 getNearestFieldByName ( $alldata, $name)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 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. More...
 
 isHiddenRecurse (array $alldata, array $params)
 Helper function for isHidden to handle recursive data structures. More...
 
 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. More...
 
 needsLabel ()
 Should this field have a label, or is there no input element with the appropriate id for the label to point to? Stable to override. More...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 

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.

Stable to extend

Definition at line 17 of file HTMLRestrictionsField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLRestrictionsField::__construct ( array  $params)

Stable to call .

Definition at line 24 of file HTMLRestrictionsField.php.

References HTMLFormField\msg().

Member Function Documentation

◆ getDefault()

HTMLRestrictionsField::getDefault ( )
Returns
MWRestrictions

Reimplemented from HTMLFormField.

Definition at line 60 of file HTMLRestrictionsField.php.

References MWRestrictions\newDefault().

Referenced by loadDataFromRequest().

◆ getHelpText()

HTMLRestrictionsField::getHelpText ( )

Determine the help text to display Stable to override.

Since
1.20
Returns
string|null HTML

Reimplemented from HTMLFormField.

Definition at line 31 of file HTMLRestrictionsField.php.

References HTMLFormField\msg().

◆ getInputHTML()

HTMLRestrictionsField::getInputHTML (   $value)
Parameters
string | MWRestrictions$value
Returns
string

Reimplemented from HTMLTextAreaField.

Definition at line 112 of file HTMLRestrictionsField.php.

◆ getInputOOUI()

HTMLRestrictionsField::getInputOOUI (   $value)
Parameters
MWRestrictions$value
Returns
string

Reimplemented from HTMLTextAreaField.

Definition at line 123 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 43 of file HTMLRestrictionsField.php.

References getDefault(), and MWRestrictions\newFromArray().

◆ validate()

HTMLRestrictionsField::validate (   $value,
  $alldata 
)
Parameters
string | MWRestrictions$valueThe value the field was submitted with
array$alldataThe 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 75 of file HTMLRestrictionsField.php.

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

Member Data Documentation

◆ DEFAULT_ROWS

const HTMLRestrictionsField::DEFAULT_ROWS = 5
protected

Definition at line 18 of file HTMLRestrictionsField.php.


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