MediaWiki REL1_39
VFormHTMLForm Class Reference

Compact stacked vertical format for forms. More...

Inheritance diagram for VFormHTMLForm:
Collaboration diagram for VFormHTMLForm:

Public Member Functions

 getButtons ()
 Get the submit and (potentially) reset buttons.
 
 getHTML ( $submitResult)
 Returns the raw HTML generated by the form.
 
 wrapForm ( $html)
 Wrap the form innards in an actual "<form>" element.
 
- Public Member Functions inherited from HTMLForm
 __construct ( $descriptor, IContextSource $context, $messagePrefix='')
 Build a new HTMLForm from an array of field attributes.
 
 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.
 
 addFooterText ( $msg, $section=null)
 Add footer text, inside the form.
 
 addHeaderHtml ( $html, $section=null)
 Add HTML to the header, inside the form.
 
 addHeaderText ( $msg, $section=null)
 Add HTML to the header, inside the form.
 
 addHiddenField ( $name, $value, array $attribs=[])
 Add a hidden field to the output.
 
 addHiddenFields (array $fields)
 Add an array of hidden fields to the output.
 
 addPostHtml ( $html)
 Add HTML to the end of the display.
 
 addPostText ( $msg)
 Add text to the end of the display.
 
 addPreHtml ( $html)
 Add HTML to introductory message.
 
 addPreText ( $msg)
 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.
 
 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.
 
 getFooterText ( $section=null)
 Get footer text.
 
 getHeaderHtml ( $section=null)
 Get header HTML.
 
 getHeaderText ( $section=null)
 Get header text.
 
 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.
 
 getPreText ()
 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.
 
 setFooterText ( $msg, $section=null)
 Set footer text, inside the form.
 
 setFormIdentifier ( $ident)
 Set an internal identifier for this form.
 
 setHeaderHtml ( $html, $section=null)
 Set header HTML, inside the form.
 
 setHeaderText ( $msg, $section=null)
 Set header text, inside the form.
 
 setId ( $id)
 
 setIntro ( $msg)
 Set the introductory message, overwriting any existing message.
 
 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.
 
 setPostText ( $msg)
 Set text at the end of the display.
 
 setPreHtml ( $html)
 Set the introductory message HTML, overwriting any existing message.
 
 setPreText ( $msg)
 Set the introductory message HTML, overwriting any existing message.
 
 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.
 
 suppressReset ( $suppressReset=true)
 Stop a reset 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 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 ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 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.
 
- Static Public Member Functions inherited from 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

 getFormAttributes ()
 Get HTML attributes for the <form> tag.
 
- Protected Member Functions inherited from 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 an user-visible fieldset.
 

Protected Attributes

string $displayFormat = 'vform'
 Symbolic display format name.
 
bool $mWrapperLegend = false
 Wrapper and its legend are never generated in VForm mode.
 
- Protected Attributes inherited from 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.
 
bool string $mAction = false
 Form action URL.
 
string null $mAutocomplete = null
 Form attribute autocomplete.
 
array[] $mButtons = []
 
 $mCancelTarget
 
bool $mCollapsed = false
 Whether the form is collapsed by default.
 
bool $mCollapsible = false
 Whether the form can be collapsed.
 
 $mFieldTree = []
 
HTMLFormField[] $mFlatFields = []
 
 $mFooter = ''
 
 $mFormIdentifier
 
 $mHeader = ''
 
array[] $mHiddenFields = []
 
 $mId
 
 $mMessagePrefix
 
 $mMethod = 'post'
 
 $mName
 
 $mPost = ''
 
 $mPre = ''
 
 $mSectionFooters = []
 
 $mSectionHeaders = []
 
 $mShowCancel = false
 
 $mShowReset = false
 
 $mShowSubmit = true
 
 $mSubmitCallback
 
string[] $mSubmitFlags = [ 'primary', 'progressive' ]
 
 $mSubmitID
 
 $mSubmitName
 
 $mSubmitText
 
 $mSubmitTooltip
 
bool $mSubSectionBeforeFields = true
 If true, sections that contain both fields and subsections will render their subsections before their fields.
 
 $mTableId = ''
 
Title null $mTitle
 
string array $mTokenSalt = ''
 Salt for the edit token.
 
 $mUseMultipart = false
 
array[] $mValidationErrorMessage
 
 $mWasSubmitted = false
 
 $mWrapperAttributes = []
 
 $mWrapperLegend = false
 

Additional Inherited Members

- Public Attributes inherited from HTMLForm
 $mFieldData
 
- Static Public Attributes inherited from 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

Definition at line 29 of file VFormHTMLForm.php.

Member Function Documentation

◆ getButtons()

VFormHTMLForm::getButtons ( )

Get the submit and (potentially) reset buttons.

Stability: stable
to override
Returns
string HTML.

Reimplemented from HTMLForm.

Definition at line 76 of file VFormHTMLForm.php.

References HTMLForm\$mSubmitID, HTMLForm\$mSubmitName, HTMLForm\getCancelTargetURL(), HTMLForm\getSubmitText(), ContextSource\msg(), and Linker\tooltipAndAccesskeyAttribs().

◆ getFormAttributes()

VFormHTMLForm::getFormAttributes ( )
protected

Get HTML attributes for the <form> tag.

Stability: stable
to override
Returns
array

Reimplemented from HTMLForm.

Definition at line 65 of file VFormHTMLForm.php.

Referenced by wrapForm().

◆ getHTML()

VFormHTMLForm::getHTML ( $submitResult)

Returns the raw HTML generated by the form.

Stability: stable
to override
Parameters
bool | string | array | Status$submitResultOutput from HTMLForm::trySubmit()
Returns
string HTML
-taint escaped

Reimplemented from HTMLForm.

Definition at line 50 of file VFormHTMLForm.php.

References ContextSource\getOutput().

◆ loadInputFromParameters()

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

Initialise a new Object for the field.

Stability: stable
to override
Parameters
string$fieldnameName of the field
array$descriptorInput Descriptor, as described in the class documentation
HTMLForm | null$parentParent instance of HTMLForm
Exceptions
MWException
Returns
HTMLFormField Instance of a subclass of HTMLFormField

Reimplemented from HTMLForm.

Definition at line 42 of file VFormHTMLForm.php.

◆ wrapForm()

VFormHTMLForm::wrapForm ( $html)

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

Stability: stable
to override
Parameters
string$htmlHTML contents to wrap.
Returns
string Wrapped HTML.

Reimplemented from HTMLForm.

Definition at line 71 of file VFormHTMLForm.php.

References getFormAttributes().

Member Data Documentation

◆ $displayFormat

string VFormHTMLForm::$displayFormat = 'vform'
protected

Symbolic display format name.

Definition at line 40 of file VFormHTMLForm.php.

◆ $mWrapperLegend

bool VFormHTMLForm::$mWrapperLegend = false
protected

Wrapper and its legend are never generated in VForm mode.

Definition at line 34 of file VFormHTMLForm.php.


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