MediaWiki\HTMLForm\VFormHTMLForm Class Reference

Compact stacked vertical format for forms. More...

Inherits MediaWiki\HTMLForm\HTMLForm.

Collaboration diagram for MediaWiki\HTMLForm\VFormHTMLForm:

Public Member Functions
	__construct ( $descriptor, IContextSource $context, $messagePrefix='')
	Build a new HTMLForm from an array of field attributes. Stability: stable to call Parameters array $descriptor Array of Field constructs, as described in the class documentation IContextSource $context Context used to fetch submitted form fields and generate localisation messages string $messagePrefix A prefix to go in front of default messages
	getHTML ( $submitResult)
	Returns the raw HTML generated by the form. Stability: stable to override Parameters bool | string | array | Status $submitResult Output from HTMLForm::trySubmit() Returns string HTML
	wrapForm ( $html)
	Wrap the form innards in an actual "<form>" element. Stability: stable to override Parameters string $html HTML contents to wrap. Returns string|\OOUI\Tag Wrapped HTML.
Public Member Functions inherited from MediaWiki\HTMLForm\HTMLForm
	addButton ( $data)
	Add a button to the form.
	addFields ( $descriptor)
	Add fields to the form.
	addFooterHtml ( $html, $section=null)
	Add footer HTML, inside the form.
	addHeaderHtml ( $html, $section=null)
	Add HTML to the header, inside the form.
	addHiddenField ( $name, $value, array $attribs=[])
	Add a hidden field to the output Array values are discarded for security reasons (per WebRequest::getVal)
	addHiddenFields (array $fields)
	Add an array of hidden fields to the output Array values are discarded for security reasons (per WebRequest::getVal)
	addPostHtml ( $html)
	Add HTML to the end of the display.
	addPreHtml ( $html)
	Add HTML to introductory message.
	displayForm ( $submitResult)
	Display the form (sending to the context's OutputPage object), with an appropriate error message or stack of messages, and any validation errors, etc.
	displaySection ( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
	filterDataForSubmit ( $data)
	Overload this if you want to apply special filtration routines to the form as a whole, after it's submitted but before it's processed.
	formatErrors ( $errors)
	Format a stack of error messages into a single HTML string.
	getAction ()
	Get the value for the action attribute of the form.
	getBody ()
	Get the whole body of the form.
	getButtons ()
	Get the submit and (potentially) reset buttons.
	getDisplayFormat ()
	Getter for displayFormat.
	getErrorsOrWarnings ( $elements, $elementsType)
	Returns a formatted list of errors or warnings from the given elements.
	getField ( $fieldname)
	getFooterHtml ( $section=null)
	Get footer HTML.
	getHeaderHtml ( $section=null)
	Get header HTML.
	getHiddenFields ()
	Get the hidden fields that should go inside the form.
	getLegend ( $key)
	Get a string to go in the "<legend>" of a section fieldset.
	getMethod ()
	getPostHtml ()
	Get HTML at the end of the display.
	getPreHtml ()
	Get the introductory message HTML.
	getSubmitText ()
	Get the text for the submit button, either customised or a default.
	getTitle ()
	hasField ( $fieldname)
	loadData ()
	needsJSForHtml5FormValidation ()
	Whether this form, with its current fields, requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.
	prepareForm ()
	Prepare form for submission.
	setAction ( $action)
	Set the value for the action attribute of the form.
	setAutocomplete ( $autocomplete)
	Set the value for the autocomplete attribute of the form.
	setCancelTarget ( $target)
	Sets the target where the user is redirected to after clicking cancel.
	setCollapsibleOptions ( $collapsedByDefault=false)
	Enable collapsible mode, and set whether the form is collapsed by default.
	setDisplayFormat ( $format)
	Set format in which to display the form.
	setFooterHtml ( $html, $section=null)
	Set footer HTML, inside the form.
	setFormIdentifier (string $ident, bool $single=false)
	Set an internal identifier for this form.
	setHeaderHtml ( $html, $section=null)
	Set header HTML, inside the form.
	setId ( $id)
	setMessagePrefix ( $p)
	Set the prefix for various default messages.
	setMethod ( $method='post')
	Set the method used to submit the form.
	setName ( $name)
	setPostHtml ( $html)
	Set HTML at the end of the display.
	setPreHtml ( $html)
	Set the introductory message HTML, overwriting any existing message.
	setSections ( $sections)
	Set an array of information about sections.
	setSubmitCallback ( $cb)
	Set a callback to a function to do something with the form once it's been successfully validated.
	setSubmitDestructive ()
	Identify that the submit button in the form has a destructive action.
	setSubmitID ( $t)
	Set the id for the submit button.
	setSubmitName ( $name)
	setSubmitText ( $t)
	Set the text for the submit button.
	setSubmitTextMsg ( $msg)
	Set the text for the submit button to a message.
	setSubmitTooltip ( $name)
	setTableId ( $id)
	Set the id of the \<table\> or outermost \<div\> element.
	setTitle ( $t)
	Set the title for form submission.
	setTokenSalt ( $salt)
	Set the salt for the edit token.
	setValidationErrorMessage ( $msg)
	Set a message to display on a validation error.
	setWrapperAttributes ( $attributes)
	For internal use only.
	setWrapperLegend ( $legend)
	Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element.
	setWrapperLegendMsg ( $msg)
	Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
	show ()
	The here's-one-I-made-earlier option: do the submission if posted, or display the form with or without funky validation errors.
	showAlways ()
	Same as self::show with the difference, that the form will be added to the output, no matter, if the validation was good or not.
	showCancel ( $show=true)
	Show a cancel button (or prevent it).
	suppressDefaultSubmit ( $suppressSubmit=true)
	Stop a default submit button being shown for this form.
	tryAuthorizedSubmit ()
	Try submitting, with edit token check first.
	trySubmit ()
	Validate all the fields, and call the submission callback function if everything is kosher.
	wasSubmitted ()
	Test whether the form was considered to have been submitted or not, i.e.
Public Member Functions inherited from MediaWiki\Context\ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().
	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.
	getActionName ()
	Get the action name for the current web request.
	getAuthority ()
	getConfig ()
	getContext ()
	Get the base IContextSource object.
	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.
	getLanguage ()
	getLanguageCode ()
	getOutput ()
	getRequest ()
	getSkin ()
	getTiming ()
	getUser ()
	getWikiPage ()
	Get the WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)

Static Public Member Functions
static	loadInputFromParameters ( $fieldname, $descriptor, ?HTMLForm $parent=null)
	Initialise a new Object for the field. Stability: stable to override Parameters string $fieldname Name of the field array $descriptor Input Descriptor, as described in the class documentation HTMLForm | null $parent Parent instance of HTMLForm Warning Not passing (or passing null) for $parent is deprecated as of 1.40 Returns HTMLFormField Instance of a subclass of HTMLFormField
Static Public Member Functions inherited from MediaWiki\HTMLForm\HTMLForm
static	factory ( $displayFormat, $descriptor, IContextSource $context, $messagePrefix='')
	Construct a HTMLForm object for given display type.
static	getClassFromDescriptor ( $fieldname, &$descriptor)
	Get the HTMLFormField subclass for this descriptor.

Protected Member Functions
	formatField (HTMLFormField $field, $value)
	Generate the HTML for an individual field in the current display format. Since 1.41 Stability: stable to override Parameters HTMLFormField $field mixed $value Returns string|Stringable HTML
	getFormAttributes ()
	Get HTML attributes for the <form> tag. Stability: stable to override Returns array
Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLForm
	formatSection (array $fieldsHtml, $sectionName, $anyFieldHasLabel)
	Put a form section together from the individual fields' HTML, merging it and wrapping.
	getCancelTargetURL ()
	getMessage ( $value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.
	loadFieldData ()
	Load data of form fields from the request.
	wrapFieldSetSection ( $legend, $section, $attributes, $isRoot)
	Wraps the given $section into a user-visible fieldset.

Protected Attributes
	$displayFormat = 'vform'
bool	$mWrapperLegend = false
	Wrapper and its legend are never generated in VForm mode.
Protected Attributes inherited from MediaWiki\HTMLForm\HTMLForm
array	$availableDisplayFormats
	Available formats in which to display the form.
array	$availableSubclassDisplayFormats
	Available formats in which to display the form.
string	$displayFormat = 'table'
	Format in which to display form.
string false	$mAction = false
	Form action URL.
string null	$mAutocomplete = null
	Form attribute autocomplete.
array[]	$mButtons = []
LinkTarget string null	$mCancelTarget
bool	$mCollapsed = false
	Whether the form is collapsed by default.
bool	$mCollapsible = false
	Whether the form can be collapsed.
array	$mFieldTree = []
HTMLFormField[]	$mFlatFields = []
string	$mFooter = ''
string null	$mFormIdentifier
string	$mHeader = ''
array[]	$mHiddenFields = []
string null	$mId
string	$mMessagePrefix
string	$mMethod = 'post'
string null	$mName
string	$mPost = ''
string	$mPre = ''
string[]	$mSectionFooters = []
string[]	$mSectionHeaders = []
array[]	$mSections = []
	Additional information about form sections.
bool	$mShowCancel = false
bool	$mShowSubmit = true
bool	$mSingleForm = false
callable null	$mSubmitCallback
string[]	$mSubmitFlags = [ 'primary', 'progressive' ]
string null	$mSubmitID
string null	$mSubmitName
string null	$mSubmitText
string null	$mSubmitTooltip
bool	$mSubSectionBeforeFields = true
	If true, sections that contain both fields and subsections will render their subsections before their fields.
string	$mTableId = ''
Title null	$mTitle
string array	$mTokenSalt = ''
	Salt for the edit token.
bool	$mUseMultipart = false
array[]	$mValidationErrorMessage
bool	$mWasSubmitted = false
array	$mWrapperAttributes = []
string false	$mWrapperLegend = false

Additional Inherited Members
Public Attributes inherited from MediaWiki\HTMLForm\HTMLForm
array	$mFieldData
Static Public Attributes inherited from MediaWiki\HTMLForm\HTMLForm
static string[]	$typeMappings
	A mapping of 'type' inputs onto standard HTMLFormField subclasses.

Detailed Description

Compact stacked vertical format for forms.

Stability: stable

to extend

Deprecated

since 1.45

Definition at line 21 of file VFormHTMLForm.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\HTMLForm\VFormHTMLForm::__construct	(		$descriptor,
		IContextSource	$context,
			$messagePrefix = '' )

Build a new HTMLForm from an array of field attributes.

Stability: stable

to call

Parameters

array	$descriptor	Array of Field constructs, as described in the class documentation
IContextSource	$context	Context used to fetch submitted form fields and generate localisation messages
string	$messagePrefix	A prefix to go in front of default messages

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 32 of file VFormHTMLForm.php.

References wfDeprecated().

Member Function Documentation

formatField()

MediaWiki\HTMLForm\VFormHTMLForm::formatField ( HTMLFormField $field, $value )

protected

Generate the HTML for an individual field in the current display format.

Since

1.41

Stability: stable

to override

Parameters

HTMLFormField	$field
mixed	$value

Returns

string|Stringable HTML

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 61 of file VFormHTMLForm.php.

References MediaWiki\HTMLForm\HTMLFormField\getVForm().

getFormAttributes()

MediaWiki\HTMLForm\VFormHTMLForm::getFormAttributes ( )

protected

Get HTML attributes for the <form> tag.

Stability: stable

to override

Returns

array

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 66 of file VFormHTMLForm.php.

Referenced by MediaWiki\HTMLForm\VFormHTMLForm\wrapForm().

getHTML()

MediaWiki\HTMLForm\VFormHTMLForm::getHTML

(

$submitResult

)

Returns the raw HTML generated by the form.

Stability: stable

to override

Parameters

bool | string | array | Status

$submitResult

Output from HTMLForm::trySubmit()

Returns

string HTML

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 47 of file VFormHTMLForm.php.

References MediaWiki\Context\ContextSource\getOutput().

loadInputFromParameters()

static MediaWiki\HTMLForm\VFormHTMLForm::loadInputFromParameters ( $fieldname, $descriptor, ?HTMLForm $parent = null )

static

Initialise a new Object for the field.

Stability: stable

to override

Parameters

string	$fieldname	Name of the field
array	$descriptor	Input Descriptor, as described in the class documentation
HTMLForm | null	$parent	Parent instance of HTMLForm

Warning

Not passing (or passing null) for $parent is deprecated as of 1.40

Returns

HTMLFormField Instance of a subclass of HTMLFormField

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 38 of file VFormHTMLForm.php.

wrapForm()

MediaWiki\HTMLForm\VFormHTMLForm::wrapForm

(

$html

)

Wrap the form innards in an actual "<form>" element.

Stability: stable

to override

Parameters

string

$html

HTML contents to wrap.

Returns

string|\OOUI\Tag Wrapped HTML.

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 72 of file VFormHTMLForm.php.

References MediaWiki\HTMLForm\VFormHTMLForm\getFormAttributes().

Member Data Documentation

$displayFormat

MediaWiki\HTMLForm\VFormHTMLForm::$displayFormat = 'vform'

protected

Definition at line 29 of file VFormHTMLForm.php.

$mWrapperLegend

bool MediaWiki\HTMLForm\VFormHTMLForm::$mWrapperLegend = false

protected

Wrapper and its legend are never generated in VForm mode.

Definition at line 26 of file VFormHTMLForm.php.

---

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

• includes/HTMLForm/VFormHTMLForm.php