$info,
* where $info is an Associative Array with any of the following:
*
* 'class' -- the subclass of HTMLFormField that will be used
* to create the object. *NOT* the CSS class!
* 'type' -- roughly translates into the type attribute.
* if 'class' is not specified, this is used as a map
* through HTMLForm::$typeMappings to get the class name.
* 'default' -- default value when the form is displayed
* 'nodata' -- if set (to any value, which casts to true), the data
* for this field will not be loaded from the actual request. Instead,
* always the default data is set as the value of this field.
* 'id' -- HTML id attribute
* 'cssclass' -- CSS class
* 'csshelpclass' -- CSS class used to style help text
* 'dir' -- Direction of the element.
* 'options' -- associative array mapping raw text labels to values.
* Some field types support multi-level arrays.
* Overwrites 'options-message'.
* 'options-messages' -- associative array mapping message keys to values.
* Some field types support multi-level arrays.
* Overwrites 'options' and 'options-message'.
* 'options-message' -- message key or object to be parsed to extract the list of
* options (like 'ipbreason-dropdown').
* 'label-message' -- message key or object for a message to use as the label.
* can be an array of msg key and then parameters to
* the message.
* 'label' -- alternatively, a raw text message. Overridden by
* label-message
* 'help' -- message text for a message to use as a help text.
* 'help-message' -- message key or object for a message to use as a help text.
* can be an array of msg key and then parameters to
* the message.
* Overwrites 'help-messages' and 'help'.
* 'help-messages' -- array of message keys/objects. As above, each item can
* be an array of msg key and then parameters.
* Overwrites 'help'.
* 'help-inline' -- Whether help text (defined using options above) will be shown
* inline after the input field, rather than in a popup.
* Defaults to true. Only used by OOUI form fields.
* 'required' -- passed through to the object, indicating that it
* is a required field.
* 'size' -- the length of text fields
* 'filter-callback' -- a function name to give you the chance to
* massage the inputted value before it's processed.
* @see HTMLFormField::filter()
* 'validation-callback' -- a function name to give you the chance
* to impose extra validation on the field input.
* @see HTMLFormField::validate()
* 'name' -- By default, the 'name' attribute of the input field
* is "wp{$fieldname}". If you want a different name
* (eg one without the "wp" prefix), specify it here and
* it will be used without modification.
* 'hide-if' -- expression given as an array stating when the field
* should be hidden. The first array value has to be the
* expression's logic operator. Supported expressions:
* 'NOT'
* [ 'NOT', array $expression ]
* To hide a field if a given expression is not true.
* '==='
* [ '===', string $fieldName, string $value ]
* To hide a field if another field identified by
* $field has the value $value.
* '!=='
* [ '!==', string $fieldName, string $value ]
* Same as [ 'NOT', [ '===', $fieldName, $value ]
* 'OR', 'AND', 'NOR', 'NAND'
* [ 'XXX', array $expression1, ..., array $expressionN ]
* To hide a field if one or more (OR), all (AND),
* neither (NOR) or not all (NAND) given expressions
* are evaluated as true.
* The expressions will be given to a JavaScript frontend
* module which will continually update the field's
* visibility.
*
* Since 1.20, you can chain mutators to ease the form generation:
* @par Example:
* @code
* $form = new HTMLForm( $someFields );
* $form->setMethod( 'get' )
* ->setWrapperLegendMsg( 'message-key' )
* ->prepareForm()
* ->displayForm( '' );
* @endcode
* Note that you will have prepareForm and displayForm at the end. Other
* method calls done after that would simply not be part of the form :(
*
* @stable to extend
*
* @todo Document 'section' / 'subsection' stuff
*/
class HTMLForm extends ContextSource {
use ProtectedHookAccessorTrait;
// A mapping of 'type' inputs onto standard HTMLFormField subclasses
public static $typeMappings = [
'api' => HTMLApiField::class,
'text' => HTMLTextField::class,
'textwithbutton' => HTMLTextFieldWithButton::class,
'textarea' => HTMLTextAreaField::class,
'select' => HTMLSelectField::class,
'combobox' => HTMLComboboxField::class,
'radio' => HTMLRadioField::class,
'multiselect' => HTMLMultiSelectField::class,
'limitselect' => HTMLSelectLimitField::class,
'check' => HTMLCheckField::class,
'toggle' => HTMLCheckField::class,
'int' => HTMLIntField::class,
'float' => HTMLFloatField::class,
'info' => HTMLInfoField::class,
'selectorother' => HTMLSelectOrOtherField::class,
'selectandother' => HTMLSelectAndOtherField::class,
'namespaceselect' => HTMLSelectNamespace::class,
'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton::class,
'tagfilter' => HTMLTagFilter::class,
'sizefilter' => HTMLSizeFilterField::class,
'submit' => HTMLSubmitField::class,
'hidden' => HTMLHiddenField::class,
'edittools' => HTMLEditTools::class,
'checkmatrix' => HTMLCheckMatrix::class,
'cloner' => HTMLFormFieldCloner::class,
'autocompleteselect' => HTMLAutoCompleteSelectField::class,
'language' => HTMLSelectLanguageField::class,
'date' => HTMLDateTimeField::class,
'time' => HTMLDateTimeField::class,
'datetime' => HTMLDateTimeField::class,
'expiry' => HTMLExpiryField::class,
// HTMLTextField will output the correct type="" attribute automagically.
// There are about four zillion other HTML5 input types, like range, but
// we don't use those at the moment, so no point in adding all of them.
'email' => HTMLTextField::class,
'password' => HTMLTextField::class,
'url' => HTMLTextField::class,
'title' => HTMLTitleTextField::class,
'user' => HTMLUserTextField::class,
'usersmultiselect' => HTMLUsersMultiselectField::class,
'titlesmultiselect' => HTMLTitlesMultiselectField::class,
'namespacesmultiselect' => HTMLNamespacesMultiselectField::class,
];
public $mFieldData;
protected $mMessagePrefix;
/** @var HTMLFormField[] */
protected $mFlatFields = [];
protected $mFieldTree = [];
protected $mShowReset = false;
protected $mShowSubmit = true;
/** @var string[] */
protected $mSubmitFlags = [ 'primary', 'progressive' ];
protected $mShowCancel = false;
protected $mCancelTarget;
protected $mSubmitCallback;
protected $mValidationErrorMessage;
protected $mPre = '';
protected $mHeader = '';
protected $mFooter = '';
protected $mSectionHeaders = [];
protected $mSectionFooters = [];
protected $mPost = '';
protected $mId;
protected $mName;
protected $mTableId = '';
protected $mSubmitID;
protected $mSubmitName;
protected $mSubmitText;
protected $mSubmitTooltip;
protected $mFormIdentifier;
protected $mTitle;
protected $mMethod = 'post';
protected $mWasSubmitted = false;
/**
* Form action URL. false means we will use the URL to set Title
* @since 1.19
* @var bool|string
*/
protected $mAction = false;
/**
* Whether the form can be collapsed
* @since 1.34
* @var bool
*/
protected $mCollapsible = false;
/**
* Whether the form is collapsed by default
* @since 1.34
* @var bool
*/
protected $mCollapsed = false;
/**
* Form attribute autocomplete. A typical value is "off". null does not set the attribute
* @since 1.27
* @var string|null
*/
protected $mAutocomplete = null;
protected $mUseMultipart = false;
/**
* @var array[]
* @phan-var array
*/
protected $mHiddenFields = [];
/**
* @var array[]
* @phan-var array
*/
protected $mButtons = [];
protected $mWrapperLegend = false;
protected $mWrapperAttributes = [];
/**
* Salt for the edit token.
* @var string|array
*/
protected $mTokenSalt = '';
/**
* If true, sections that contain both fields and subsections will
* render their subsections before their fields.
*
* Subclasses may set this to false to render subsections after fields
* instead.
*/
protected $mSubSectionBeforeFields = true;
/**
* Format in which to display form. For viable options,
* @see $availableDisplayFormats
* @var string
*/
protected $displayFormat = 'table';
/**
* Available formats in which to display the form
* @var array
*/
protected $availableDisplayFormats = [
'table',
'div',
'raw',
'inline',
];
/**
* Available formats in which to display the form
* @var array
*/
protected $availableSubclassDisplayFormats = [
'vform',
'ooui',
];
/**
* Construct a HTMLForm object for given display type. May return a HTMLForm subclass.
*
* @stable to call
*
* @param string $displayFormat
* @param mixed ...$arguments Additional arguments to pass to the constructor.
* @return HTMLForm
*/
public static function factory( $displayFormat, ...$arguments ) {
switch ( $displayFormat ) {
case 'vform':
return new VFormHTMLForm( ...$arguments );
case 'ooui':
return new OOUIHTMLForm( ...$arguments );
default:
$form = new self( ...$arguments );
$form->setDisplayFormat( $displayFormat );
return $form;
}
}
/**
* Build a new HTMLForm from an array of field attributes
*
* @stable to call
*
* @param array $descriptor Array of Field constructs, as described
* in the class documentation
* @param IContextSource|null $context Available since 1.18, will become compulsory in 1.18.
* Obviates the need to call $form->setTitle()
* @param string $messagePrefix A prefix to go in front of default messages
*/
public function __construct( $descriptor, /*IContextSource*/ $context = null,
$messagePrefix = ''
) {
if ( $context instanceof IContextSource ) {
$this->setContext( $context );
$this->mTitle = false; // We don't need them to set a title
$this->mMessagePrefix = $messagePrefix;
} elseif ( $context === null && $messagePrefix !== '' ) {
$this->mMessagePrefix = $messagePrefix;
} elseif ( is_string( $context ) && $messagePrefix === '' ) {
// B/C since 1.18
// it's actually $messagePrefix
$this->mMessagePrefix = $context;
}
// Evil hack for mobile :(
if (
!$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
&& $this->displayFormat === 'table'
) {
$this->displayFormat = 'div';
}
$this->addFields( $descriptor );
}
/**
* Add fields to the form
*
* @since 1.34
*
* @param array $descriptor Array of Field constructs, as described
* in the class documentation
* @return HTMLForm
*/
public function addFields( $descriptor ) {
$loadedDescriptor = [];
foreach ( $descriptor as $fieldname => $info ) {
$section = $info['section'] ?? '';
if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
$this->mUseMultipart = true;
}
$field = static::loadInputFromParameters( $fieldname, $info, $this );
$setSection =& $loadedDescriptor;
if ( $section ) {
foreach ( explode( '/', $section ) as $newName ) {
if ( !isset( $setSection[$newName] ) ) {
$setSection[$newName] = [];
}
$setSection =& $setSection[$newName];
}
}
$setSection[$fieldname] = $field;
$this->mFlatFields[$fieldname] = $field;
}
$this->mFieldTree = array_merge( $this->mFieldTree, $loadedDescriptor );
return $this;
}
/**
* @param string $fieldname
* @return bool
*/
public function hasField( $fieldname ) {
return isset( $this->mFlatFields[$fieldname] );
}
/**
* @param string $fieldname
* @return HTMLFormField
* @throws DomainException on invalid field name
*/
public function getField( $fieldname ) {
if ( !$this->hasField( $fieldname ) ) {
throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
}
return $this->mFlatFields[$fieldname];
}
/**
* Set format in which to display the form
*
* @param string $format The name of the format to use, must be one of
* $this->availableDisplayFormats
*
* @throws MWException
* @since 1.20
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setDisplayFormat( $format ) {
if (
in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
) {
throw new MWException( 'Cannot change display format after creation, ' .
'use HTMLForm::factory() instead' );
}
if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
throw new MWException( 'Display format must be one of ' .
print_r(
array_merge(
$this->availableDisplayFormats,
$this->availableSubclassDisplayFormats
),
true
) );
}
// Evil hack for mobile :(
if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
$format = 'div';
}
$this->displayFormat = $format;
return $this;
}
/**
* Getter for displayFormat
* @since 1.20
* @return string
*/
public function getDisplayFormat() {
return $this->displayFormat;
}
/**
* Get the HTMLFormField subclass for this descriptor.
*
* The descriptor can be passed either 'class' which is the name of
* a HTMLFormField subclass, or a shorter 'type' which is an alias.
* This makes sure the 'class' is always set, and also is returned by
* this function for ease.
*
* @since 1.23
*
* @param string $fieldname Name of the field
* @param array &$descriptor Input Descriptor, as described
* in the class documentation
*
* @throws MWException
* @return string Name of a HTMLFormField subclass
*/
public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
if ( isset( $descriptor['class'] ) ) {
$class = $descriptor['class'];
} elseif ( isset( $descriptor['type'] ) ) {
$class = static::$typeMappings[$descriptor['type']];
$descriptor['class'] = $class;
} else {
$class = null;
}
if ( !$class ) {
throw new MWException( "Descriptor with no class for $fieldname: "
. print_r( $descriptor, true ) );
}
return $class;
}
/**
* Initialise a new Object for the field
* @stable to override
*
* @param string $fieldname Name of the field
* @param array $descriptor Input Descriptor, as described
* in the class documentation
* @param HTMLForm|null $parent Parent instance of HTMLForm
*
* @throws MWException
* @return HTMLFormField Instance of a subclass of HTMLFormField
*/
public static function loadInputFromParameters( $fieldname, $descriptor,
HTMLForm $parent = null
) {
$class = static::getClassFromDescriptor( $fieldname, $descriptor );
$descriptor['fieldname'] = $fieldname;
if ( $parent ) {
$descriptor['parent'] = $parent;
}
# @todo This will throw a fatal error whenever someone try to use
# 'class' to feed a CSS class instead of 'cssclass'. Would be
# great to avoid the fatal error and show a nice error.
return new $class( $descriptor );
}
/**
* Prepare form for submission.
*
* @warning When doing method chaining, that should be the very last
* method call before displayForm().
*
* @throws MWException
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function prepareForm() {
# Check if we have the info we need
if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
throw new MWException( 'You must call setTitle() on an HTMLForm' );
}
# Load data from the request.
if (
$this->mFormIdentifier === null ||
$this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
) {
$this->loadData();
} else {
$this->mFieldData = [];
}
return $this;
}
/**
* Try submitting, with edit token check first
* @return Status|bool
*/
public function tryAuthorizedSubmit() {
$result = false;
if ( $this->mFormIdentifier === null ) {
$identOkay = true;
} else {
$identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
}
$tokenOkay = false;
if ( $this->getMethod() !== 'post' ) {
$tokenOkay = true; // no session check needed
} elseif ( $this->getRequest()->wasPosted() ) {
$editToken = $this->getRequest()->getVal( 'wpEditToken' );
if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
// Session tokens for logged-out users have no security value.
// However, if the user gave one, check it in order to give a nice
// "session expired" error instead of "permission denied" or such.
$tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
} else {
$tokenOkay = true;
}
}
if ( $tokenOkay && $identOkay ) {
$this->mWasSubmitted = true;
$result = $this->trySubmit();
}
return $result;
}
/**
* The here's-one-I-made-earlier option: do the submission if
* posted, or display the form with or without funky validation
* errors
* @stable to override
* @return bool|Status Whether submission was successful.
*/
public function show() {
$this->prepareForm();
$result = $this->tryAuthorizedSubmit();
if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
return $result;
}
$this->displayForm( $result );
return false;
}
/**
* 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.
* @return bool|Status Whether submission was successful.
*/
public function showAlways() {
$this->prepareForm();
$result = $this->tryAuthorizedSubmit();
$this->displayForm( $result );
return $result;
}
/**
* Validate all the fields, and call the submission callback
* function if everything is kosher.
* @stable to override
* @throws MWException
* @return bool|string|array|Status
* - Bool true or a good Status object indicates success,
* - Bool false indicates no submission was attempted,
* - Anything else indicates failure. The value may be a fatal Status
* object, an HTML string, or an array of arrays (message keys and
* params) or strings (message keys)
*/
public function trySubmit() {
$valid = true;
$hoistedErrors = Status::newGood();
if ( $this->mValidationErrorMessage ) {
foreach ( $this->mValidationErrorMessage as $error ) {
$hoistedErrors->fatal( ...$error );
}
} else {
$hoistedErrors->fatal( 'htmlform-invalid-input' );
}
$this->mWasSubmitted = true;
# Check for cancelled submission
foreach ( $this->mFlatFields as $fieldname => $field ) {
if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
continue;
}
if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
$this->mWasSubmitted = false;
return false;
}
}
# Check for validation
foreach ( $this->mFlatFields as $fieldname => $field ) {
if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
continue;
}
if ( $field->isHidden( $this->mFieldData ) ) {
continue;
}
$res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
if ( $res !== true ) {
$valid = false;
if ( $res !== false && !$field->canDisplayErrors() ) {
if ( is_string( $res ) ) {
$hoistedErrors->fatal( 'rawmessage', $res );
} else {
$hoistedErrors->fatal( $res );
}
}
}
}
if ( !$valid ) {
return $hoistedErrors;
}
$callback = $this->mSubmitCallback;
if ( !is_callable( $callback ) ) {
throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
'setSubmitCallback() to set one.' );
}
$data = $this->filterDataForSubmit( $this->mFieldData );
$res = call_user_func( $callback, $data, $this );
if ( $res === false ) {
$this->mWasSubmitted = false;
}
return $res;
}
/**
* Test whether the form was considered to have been submitted or not, i.e.
* whether the last call to tryAuthorizedSubmit or trySubmit returned
* non-false.
*
* This will return false until HTMLForm::tryAuthorizedSubmit or
* HTMLForm::trySubmit is called.
*
* @since 1.23
* @return bool
*/
public function wasSubmitted() {
return $this->mWasSubmitted;
}
/**
* Set a callback to a function to do something with the form
* once it's been successfully validated.
*
* @param callable $cb The function will be passed the output from
* HTMLForm::filterDataForSubmit and this HTMLForm object, and must
* return as documented for HTMLForm::trySubmit
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setSubmitCallback( $cb ) {
$this->mSubmitCallback = $cb;
return $this;
}
/**
* Set a message to display on a validation error.
*
* @param array $msg Array of valid inputs to wfMessage()
* (so each entry must itself be an array of arguments)
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setValidationErrorMessage( $msg ) {
$this->mValidationErrorMessage = $msg;
return $this;
}
/**
* Set the introductory message, overwriting any existing message.
*
* @param string $msg Complete text of message to display
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setIntro( $msg ) {
$this->setPreText( $msg );
return $this;
}
/**
* Set the introductory message HTML, overwriting any existing message.
* @since 1.19
*
* @param string $msg Complete HTML of message to display
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setPreText( $msg ) {
$this->mPre = $msg;
return $this;
}
/**
* Add HTML to introductory message.
*
* @param string $msg Complete HTML of message to display
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function addPreText( $msg ) {
$this->mPre .= $msg;
return $this;
}
/**
* Get the introductory message HTML.
*
* @since 1.32
*
* @return string
*/
public function getPreText() {
return $this->mPre;
}
/**
* Add HTML to the header, inside the form.
*
* @param string $msg Additional HTML to display in header
* @param string|null $section The section to add the header to
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function addHeaderText( $msg, $section = null ) {
if ( $section === null ) {
$this->mHeader .= $msg;
} else {
if ( !isset( $this->mSectionHeaders[$section] ) ) {
$this->mSectionHeaders[$section] = '';
}
$this->mSectionHeaders[$section] .= $msg;
}
return $this;
}
/**
* Set header text, inside the form.
* @since 1.19
*
* @param string $msg Complete HTML of header to display
* @param string|null $section The section to add the header to
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setHeaderText( $msg, $section = null ) {
if ( $section === null ) {
$this->mHeader = $msg;
} else {
$this->mSectionHeaders[$section] = $msg;
}
return $this;
}
/**
* Get header text.
* @stable to override
*
* @param string|null $section The section to get the header text for
* @since 1.26
* @return string HTML
*/
public function getHeaderText( $section = null ) {
if ( $section === null ) {
return $this->mHeader;
} else {
return $this->mSectionHeaders[$section] ?? '';
}
}
/**
* Add footer text, inside the form.
*
* @param string $msg Complete text of message to display
* @param string|null $section The section to add the footer text to
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function addFooterText( $msg, $section = null ) {
if ( $section === null ) {
$this->mFooter .= $msg;
} else {
if ( !isset( $this->mSectionFooters[$section] ) ) {
$this->mSectionFooters[$section] = '';
}
$this->mSectionFooters[$section] .= $msg;
}
return $this;
}
/**
* Set footer text, inside the form.
* @since 1.19
*
* @param string $msg Complete text of message to display
* @param string|null $section The section to add the footer text to
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setFooterText( $msg, $section = null ) {
if ( $section === null ) {
$this->mFooter = $msg;
} else {
$this->mSectionFooters[$section] = $msg;
}
return $this;
}
/**
* Get footer text.
*
* @param string|null $section The section to get the footer text for
* @since 1.26
* @return string
*/
public function getFooterText( $section = null ) {
if ( $section === null ) {
return $this->mFooter;
} else {
return $this->mSectionFooters[$section] ?? '';
}
}
/**
* Add text to the end of the display.
*
* @param string $msg Complete text of message to display
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function addPostText( $msg ) {
$this->mPost .= $msg;
return $this;
}
/**
* Set text at the end of the display.
*
* @param string $msg Complete text of message to display
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function setPostText( $msg ) {
$this->mPost = $msg;
return $this;
}
/**
* Add a hidden field to the output
*
* @param string $name Field name. This will be used exactly as entered
* @param mixed $value Field value
* @param array $attribs
*
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function addHiddenField( $name, $value, array $attribs = [] ) {
$attribs += [ 'name' => $name ];
$this->mHiddenFields[] = [ $value, $attribs ];
return $this;
}
/**
* Add an array of hidden fields to the output
*
* @since 1.22
*
* @param array $fields Associative array of fields to add;
* mapping names to their values
*
* @return HTMLForm $this for chaining calls
*/
public function addHiddenFields( array $fields ) {
foreach ( $fields as $name => $value ) {
$this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
}
return $this;
}
/**
* Add a button to the form
*
* @since 1.27 takes an array as shown. Earlier versions accepted
* 'name', 'value', 'id', and 'attribs' as separate parameters in that
* order.
* @param array $data Data to define the button:
* - name: (string) Button name.
* - value: (string) Button value.
* - label-message: (string|string[]|MessageSpecifier, optional) Button label
* message key to use instead of 'value'. Overrides 'label' and 'label-raw'.
* - label: (string, optional) Button label text to use instead of
* 'value'. Overrides 'label-raw'.
* - label-raw: (string, optional) Button label HTML to use instead of
* 'value'.
* - id: (string, optional) DOM id for the button.
* - attribs: (array, optional) Additional HTML attributes.
* - flags: (string|string[], optional) OOUI flags.
* - framed: (boolean=true, optional) OOUI framed attribute.
* @codingStandardsIgnoreStart
* @phan-param array{name:string,value:string,label-message?:string|string[]|MessageSpecifier,label?:string,label-raw?:string,id?:string,attribs?:array,flags?:string|string[],framed?:bool} $data
* @codingStandardsIgnoreEnd
* @return HTMLForm $this for chaining calls (since 1.20)
*/
public function addButton( $data ) {
if ( !is_array( $data ) ) {
$args = func_get_args();
if ( count( $args ) < 2 || count( $args ) > 4 ) {
throw new InvalidArgumentException(
'Incorrect number of arguments for deprecated calling style'
);
}
$data = [
'name' => $args[0],
'value' => $args[1],
'id' => $args[2] ?? null,
'attribs' => $args[3] ?? null,
];
} else {
if ( !isset( $data['name'] ) ) {
throw new InvalidArgumentException( 'A name is required' );
}
if ( !isset( $data['value'] ) ) {
throw new InvalidArgumentException( 'A value is required' );
}
}
$this->mButtons[] = $data + [
'id' => null,
'attribs' => null,
'flags' => null,
'framed' => true,
];
return $this;
}
/**
* Set the salt for the edit token.
*
* Only useful when the method is "post".
*
* @since 1.24
* @param string|array $salt Salt to use
* @return HTMLForm $this For chaining calls
*/
public function setTokenSalt( $salt ) {
$this->mTokenSalt = $salt;
return $this;
}
/**
* Display the form (sending to the context's OutputPage object), with an
* appropriate error message or stack of messages, and any validation errors, etc.
*
* @warning You should call prepareForm() before calling this function.
* Moreover, when doing method chaining this should be the very last method
* call just after prepareForm().
*
* @stable to override
*
* @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
*
* @return void Nothing, should be last call
*/
public function displayForm( $submitResult ) {
$this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
}
/**
* Returns the raw HTML generated by the form
*
* @stable to override
*
* @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
*
* @return string HTML
* @return-taint escaped
*/
public function getHTML( $submitResult ) {
# For good measure (it is the default)
$this->getOutput()->preventClickjacking();
$this->getOutput()->addModules( 'mediawiki.htmlform' );
$this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
$html = ''
. $this->getErrorsOrWarnings( $submitResult, 'error' )
. $this->getErrorsOrWarnings( $submitResult, 'warning' )
. $this->getHeaderText()
. $this->getBody()
. $this->getHiddenFields()
. $this->getButtons()
. $this->getFooterText();
$html = $this->wrapForm( $html );
return '' . $this->mPre . $html . $this->mPost;
}
/**
* Enable collapsible mode, and set whether the form is collapsed by default.
*
* @since 1.34
* @param bool $collapsedByDefault Whether the form is collapsed by default (optional).
* @return HTMLForm $this for chaining calls
*/
public function setCollapsibleOptions( $collapsedByDefault = false ) {
$this->mCollapsible = true;
$this->mCollapsed = $collapsedByDefault;
return $this;
}
/**
* Get HTML attributes for the `