MediaWiki REL1_34
HTMLButtonField.php
Go to the documentation of this file.
1<?php
2
27 protected $buttonType = 'button';
28 protected $buttonLabel = null;
29
31 protected $mFlags = [];
32
33 protected $mFormnovalidate = false;
34
35 public function __construct( $info ) {
36 $info['nodata'] = true;
37
38 $this->setShowEmptyLabel( false );
39
40 parent::__construct( $info );
41
42 if ( isset( $info['flags'] ) ) {
43 $this->mFlags = $info['flags'];
44 }
45
46 if ( isset( $info['formnovalidate'] ) ) {
47 $this->mFormnovalidate = $info['formnovalidate'];
48 }
49
50 # Generate the label from a message, if possible
51 if ( isset( $info['buttonlabel-message'] ) ) {
52 $this->buttonLabel = $this->getMessage( $info['buttonlabel-message'] )->parse();
53 } elseif ( isset( $info['buttonlabel'] ) ) {
54 if ( $info['buttonlabel'] === '&#160;' || $info['buttonlabel'] === "\u{00A0}" ) {
55 // Apparently some things set &nbsp directly and in an odd format
56 $this->buttonLabel = "\u{00A0}";
57 } else {
58 $this->buttonLabel = htmlspecialchars( $info['buttonlabel'] );
59 }
60 } elseif ( isset( $info['buttonlabel-raw'] ) ) {
61 $this->buttonLabel = $info['buttonlabel-raw'];
62 }
63 }
64
65 public function getInputHTML( $value ) {
66 $flags = '';
67 $prefix = 'mw-htmlform-';
68 if ( $this->mParent instanceof VFormHTMLForm ||
69 $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' )
70 ) {
71 $prefix = 'mw-ui-';
72 // add mw-ui-button separately, so the descriptor doesn't need to set it
73 $flags .= ' ' . $prefix . 'button';
74 }
75 foreach ( $this->mFlags as $flag ) {
76 $flags .= ' ' . $prefix . $flag;
77 }
78 $attr = [
79 'class' => 'mw-htmlform-submit ' . $this->mClass . $flags,
80 'id' => $this->mID,
81 'type' => $this->buttonType,
82 'name' => $this->mName,
83 'value' => $this->getDefault(),
84 'formnovalidate' => $this->mFormnovalidate,
85 ] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
86
87 if ( $this->isBadIE() ) {
88 return Html::element( 'input', $attr );
89 } else {
90 return Html::rawElement( 'button', $attr,
91 $this->buttonLabel ?: htmlspecialchars( $this->getDefault() ) );
92 }
93 }
94
100 public function getInputOOUI( $value ) {
101 return new OOUI\ButtonInputWidget( [
102 'name' => $this->mName,
103 'value' => $this->getDefault(),
104 'label' => !$this->isBadIE() && $this->buttonLabel
105 ? new OOUI\HtmlSnippet( $this->buttonLabel )
106 : $this->getDefault(),
107 'type' => $this->buttonType,
108 'classes' => [ 'mw-htmlform-submit', $this->mClass ],
109 'id' => $this->mID,
110 'flags' => $this->mFlags,
111 'useInputTag' => $this->isBadIE(),
112 ] + OOUI\Element::configFromHtmlAttributes(
113 $this->getAttributes( [ 'disabled', 'tabindex' ] )
114 ) );
115 }
116
117 protected function needsLabel() {
118 return false;
119 }
120
129 public function validate( $value, $alldata ) {
130 return true;
131 }
132
137 private function isBadIE() {
138 $request = $this->mParent
139 ? $this->mParent->getRequest()
140 : RequestContext::getMain()->getRequest();
141 return (bool)preg_match( '/MSIE [1-7]\./i', $request->getHeader( 'User-Agent' ) );
142 }
143}
Adds a generic button inline to the form.
getInputOOUI( $value)
Get the OOUI widget for this field.
__construct( $info)
Initialise the object.
isBadIE()
IE<8 has bugs with <button>, so we'll need to avoid them.
validate( $value, $alldata)
Button cannot be invalid.
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself.
needsLabel()
Should this field have a label, or is there no input element with the appropriate id for the label to...
The parent class to generate form fields.
getMessage( $value)
Turns a *-message parameter (which could be a MessageSpecifier, or a message name,...
getAttributes(array $list)
Returns the given attributes from the parameters.
setShowEmptyLabel( $show)
Tell the field whether to generate a separate label element if its label is blank.
Compact stacked vertical format for forms.