MediaWiki  master
HTMLFormFieldCloner Class Reference

A container for HTMLFormFields that allows for multiple copies of the set of fields to be displayed to and entered by the user. More...

Inheritance diagram for HTMLFormFieldCloner:
Collaboration diagram for HTMLFormFieldCloner:

Public Member Functions

 __construct ( $params)
 
 cancelSubmit ( $values, $alldata)
 Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.
Stability: stable
to override
Since
1.23
Parameters
string | array$valueThe value the field was submitted with
array$alldataThe data collected from the form
Returns
bool True to cancel the submission
More...
 
 extractFieldData ( $field, $alldata)
 Extract field data for a given field that belongs to this cloner. More...
 
 findNearestField ( $field, $find)
 Find the nearest field to a field in this cloner matched the given name, walk through the chain of cloners. More...
 
 getDefault ()
 
 getInputHTML ( $values)
 This function must be implemented to return the HTML to generate the input object itself. More...
 
 getInputOOUI ( $values)
 Same as getInputHTML, but returns an OOUI object. More...
 
 loadDataFromRequest ( $request)
 Get the value that this input has been set to from a posted form, or the input's default value if it has not been set. More...
 
 validate ( $values, $alldata)
 Override this function to add specific validation checks on the field input.Don't forget to call parent::validate() to ensure that the user-defined callback mValidationCallback is still run

Stability: stable
to override
Parameters
mixed$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.
More...
 
- Public Member Functions inherited from HTMLFormField
 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)
 
 getAttributes (array $list)
 Returns the given attributes from the parameters. 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...
 
 getHelpText ()
 Determine the help text to display. 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 ()
 
 getLabelHtml ( $cellAttributes=[])
 
 getName ()
 Get the field name that will be used for submission. 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...
 
 isDisabled ( $alldata)
 Test whether this field is supposed to be disabled, based on the values of the other form fields. 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 Member Functions

 createFieldsForKey ( $key)
 Create the HTMLFormFields that go inside this element, using the specified key. More...
 
 getCreateButtonHtml ()
 
 getDeleteButtonHtml ( $key)
 
 getFieldPath ( $field)
 
 getFieldsForKey ( $key)
 
 getInputHTMLForKey ( $key, array $values)
 Get the input HTML for the specified key. More...
 
 getInputOOUIForKey ( $key, array $values)
 Get the input OOUI HTML for the specified key. More...
 
 needsLabel ()
 Should this field have a label, or is there no input element with the appropriate id for the label to point to? More...
 
 parseFieldPath ( $name)
 
 rekeyValuesArray ( $key, $values)
 Re-key the specified values array to match the names applied by createFieldsForKey(). More...
 
- Protected Member Functions inherited from HTMLFormField
 checkStateRecurse (array $alldata, array $params)
 Helper function for isHidden and isDisabled to handle recursive data structures. More...
 
 getClassName ()
 Gets the non namespaced class name. More...
 
 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...
 
 getNearestField ( $name, $backCompat=false)
 Get the closest field matching a given name. More...
 
 getNearestFieldByName ( $alldata, $name, $asDisplay=false)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
 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...
 
 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...
 
 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. More...
 
 parseCondStateForClient ()
 Parse the cond-state array for client-side. More...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 
 validateCondState ( $params)
 Validate the cond-state params, the existence check of fields should be done later. More...
 

Protected Attributes

 $mFields = []
 
string $uniqueId
 String uniquely identifying this cloner instance and unlikely to exist otherwise in the generated HTML, while still being valid as part of an HTML id. More...
 
- Protected Attributes inherited from HTMLFormField
 $mClass = ''
 
array $mCondState = []
 Array to hold params for 'hide-if' or 'disable-if' statements. More...
 
 $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. 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
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 

Detailed Description

A container for HTMLFormFields that allows for multiple copies of the set of fields to be displayed to and entered by the user.

Recognized parameters, besides the general ones, include: fields - HTMLFormField descriptors for the subfields this cloner manages. The format is just like for the HTMLForm. A field with key 'delete' is special: it must have type = submit and will serve to delete the group of fields. required - If specified, at least one group of fields must be submitted. format - HTMLForm display format to use when displaying the subfields: 'table', 'div', or 'raw'. This is ignored when using OOUI. row-legend - If non-empty, each group of subfields will be enclosed in a fieldset. The value is the name of a message key to use as the legend. create-button-message - Message to use as the text of the button to add an additional group of fields. delete-button-message - Message to use as the text of automatically- generated 'delete' button. Ignored if 'delete' is included in 'fields'.

In the generated HTML, the subfields will be named along the lines of "clonerName[index][fieldname]", with ids "clonerId--index--fieldid". 'index' may be a number or an arbitrary string, and may likely change when the page is resubmitted. Cloners may be nested, resulting in field names along the lines of "cloner1Name[index1][cloner2Name][index2][fieldname]" and corresponding ids.

Use of cloner may result in submissions of the page that are not submissions of the HTMLForm, when non-JavaScript clients use the create or remove buttons.

The result is an array, with values being arrays mapping subfield names to their values. On non-HTMLForm-submission page loads, there may also be additional (string) keys present with other types of values.

Since
1.23
Stability: stable
to extend

Definition at line 41 of file HTMLFormFieldCloner.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLFormFieldCloner::__construct (   $params)
Stability: stable
to call Initialise the object.

Reimplemented from HTMLFormField.

Definition at line 58 of file HTMLFormFieldCloner.php.

References HTMLFormField\getClassName().

Member Function Documentation

◆ cancelSubmit()

HTMLFormFieldCloner::cancelSubmit (   $values,
  $alldata 
)

Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.

Stability: stable
to override
Since
1.23
Parameters
string | array$valueThe value the field was submitted with
array$alldataThe data collected from the form
Returns
bool True to cancel the submission

Reimplemented from HTMLFormField.

Definition at line 308 of file HTMLFormFieldCloner.php.

References getFieldsForKey().

◆ createFieldsForKey()

HTMLFormFieldCloner::createFieldsForKey (   $key)
protected

Create the HTMLFormFields that go inside this element, using the specified key.

Parameters
string$keyArray key under which these fields should be named
Returns
HTMLFormField[]

Definition at line 107 of file HTMLFormFieldCloner.php.

References $type, Sanitizer\escapeIdForAttribute(), and HTMLForm\loadInputFromParameters().

Referenced by getFieldsForKey().

◆ extractFieldData()

HTMLFormFieldCloner::extractFieldData (   $field,
  $alldata 
)

Extract field data for a given field that belongs to this cloner.

Parameters
HTMLFormField$field
mixed[]$alldata
Returns
mixed

Definition at line 222 of file HTMLFormFieldCloner.php.

References getFieldPath().

◆ findNearestField()

HTMLFormFieldCloner::findNearestField (   $field,
  $find 
)

Find the nearest field to a field in this cloner matched the given name, walk through the chain of cloners.

Parameters
HTMLFormField$field
string$find
Returns
HTMLFormField|null

Definition at line 186 of file HTMLFormFieldCloner.php.

References getFieldsForKey(), and parseFieldPath().

◆ getCreateButtonHtml()

HTMLFormFieldCloner::getCreateButtonHtml ( )
protected

Definition at line 460 of file HTMLFormFieldCloner.php.

◆ getDefault()

HTMLFormFieldCloner::getDefault ( )
Stability: stable
to override
Returns
mixed

Reimplemented from HTMLFormField.

Definition at line 285 of file HTMLFormFieldCloner.php.

References getFieldsForKey().

Referenced by loadDataFromRequest().

◆ getDeleteButtonHtml()

HTMLFormFieldCloner::getDeleteButtonHtml (   $key)
protected
Parameters
string$keyArray key indicating to which field the delete button belongs
Returns
HTMLFormField

Definition at line 445 of file HTMLFormFieldCloner.php.

Referenced by getInputHTMLForKey().

◆ getFieldPath()

HTMLFormFieldCloner::getFieldPath (   $field)
protected
Parameters
HTMLFormField$field
Returns
string[]

Definition at line 207 of file HTMLFormFieldCloner.php.

References $path.

Referenced by extractFieldData().

◆ getFieldsForKey()

HTMLFormFieldCloner::getFieldsForKey (   $key)
protected
Parameters
string$keyArray key under which these fields should be named
Returns
HTMLFormField[]

Definition at line 93 of file HTMLFormFieldCloner.php.

References createFieldsForKey().

Referenced by cancelSubmit(), findNearestField(), getDefault(), getInputHTMLForKey(), loadDataFromRequest(), and validate().

◆ getInputHTML()

HTMLFormFieldCloner::getInputHTML (   $value)

This function must be implemented to return the HTML to generate the input object itself.

It should not implement the surrounding table cells/rows, or labels/help messages.

Parameters
mixed$valueThe value to set the input to; eg a default text for a text input.
Returns
string Valid HTML.

Reimplemented from HTMLFormField.

Definition at line 474 of file HTMLFormFieldCloner.php.

References Html\rawElement().

◆ getInputHTMLForKey()

HTMLFormFieldCloner::getInputHTMLForKey (   $key,
array  $values 
)
protected

Get the input HTML for the specified key.

Parameters
string$keyArray key under which the fields should be named
array$values
Returns
string

Definition at line 373 of file HTMLFormFieldCloner.php.

References Xml\fieldset(), getDeleteButtonHtml(), getFieldsForKey(), Html\hidden(), HTMLFormField\msg(), and Html\rawElement().

◆ getInputOOUI()

HTMLFormFieldCloner::getInputOOUI (   $value)

Same as getInputHTML, but returns an OOUI object.

Defaults to false, which getOOUI will interpret as "use the HTML version"

Stability: stable
to override
Parameters
string$value
Returns
OOUI\Widget|string|false

Reimplemented from HTMLFormField.

Definition at line 546 of file HTMLFormFieldCloner.php.

References Html\rawElement().

◆ getInputOOUIForKey()

HTMLFormFieldCloner::getInputOOUIForKey (   $key,
array  $values 
)
protected

Get the input OOUI HTML for the specified key.

Parameters
string$keyArray key under which the fields should be named
array$values
Returns
string

Definition at line 507 of file HTMLFormFieldCloner.php.

References Xml\fieldset(), Html\hidden(), and Html\rawElement().

◆ loadDataFromRequest()

HTMLFormFieldCloner::loadDataFromRequest (   $request)

Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.

Stability: stable
to override
Parameters
WebRequest$request
Returns
mixed The value

Reimplemented from HTMLFormField.

Definition at line 233 of file HTMLFormFieldCloner.php.

References getDefault(), getFieldsForKey(), and rekeyValuesArray().

◆ needsLabel()

HTMLFormFieldCloner::needsLabel ( )
protected

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

Stability: stable
to override
Returns
bool True to output a label, false to suppress

Reimplemented from HTMLFormField.

Definition at line 229 of file HTMLFormFieldCloner.php.

◆ parseFieldPath()

HTMLFormFieldCloner::parseFieldPath (   $name)
protected
Parameters
string$name
Returns
string[]

Definition at line 168 of file HTMLFormFieldCloner.php.

Referenced by findNearestField().

◆ rekeyValuesArray()

HTMLFormFieldCloner::rekeyValuesArray (   $key,
  $values 
)
protected

Re-key the specified values array to match the names applied by createFieldsForKey().

Parameters
string$keyArray key under which these fields should be named
array$valuesValues array from the request
Returns
array

Definition at line 155 of file HTMLFormFieldCloner.php.

Referenced by loadDataFromRequest().

◆ validate()

HTMLFormFieldCloner::validate (   $values,
  $alldata 
)

Override this function to add specific validation checks on the field input.Don't forget to call parent::validate() to ensure that the user-defined callback mValidationCallback is still run

Stability: stable
to override
Parameters
mixed$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 332 of file HTMLFormFieldCloner.php.

References getFieldsForKey(), and HTMLFormField\msg().

Member Data Documentation

◆ $mFields

HTMLFormFieldCloner::$mFields = []
protected

Definition at line 52 of file HTMLFormFieldCloner.php.

◆ $uniqueId

string HTMLFormFieldCloner::$uniqueId
protected

String uniquely identifying this cloner instance and unlikely to exist otherwise in the generated HTML, while still being valid as part of an HTML id.

Definition at line 49 of file HTMLFormFieldCloner.php.


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