includes/htmlform/fields/HTMLButtonField.php

   1 <?php
   2
   3 /**
   4  * Adds a generic button inline to the form. Does not do anything, you must add
   5  * click handling code in JavaScript. Use a HTMLSubmitField if you merely
   6  * wish to add a submit button to a form.
   7  *
   8  * Additional recognized configuration parameters include:
   9  * - flags: OOUI flags for the button, see OOUI\FlaggedElement
  10  * - buttonlabel-message: Message to use for the button display text, instead
  11  *   of the value from 'default'. Overrides 'buttonlabel' and 'buttonlabel-raw'.
  12  * - buttonlabel: Text to display for the button display text, instead
  13  *   of the value from 'default'. Overrides 'buttonlabel-raw'.
  14  * - buttonlabel-raw: HTMLto display for the button display text, instead
  15  *   of the value from 'default'.
  16  * - formnovalidate: Set to true if clicking this button should suppress
  17  *   client-side form validation. Used in HTMLFormFieldCloner for add/remove
  18  *   buttons.
  19  *
  20  * Note that the buttonlabel parameters are not supported on IE6 and IE7 due to
  21  * bugs in those browsers. If detected, they will be served buttons using the
  22  * value of 'default' as the button label.
  23  *
  24  * @since 1.22
  25  */
  26 class HTMLButtonField extends HTMLFormField {
  27         protected $buttonType = 'button';
  28         protected $buttonLabel = null;
  29
  30         /** @var array $mFlags Flags to add to OOUI Button widget */
  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
  95         /**
  96          * Get the OOUI widget for this field.
  97          * @param string $value
  98          * @return OOUI\ButtonInputWidget
  99          */
 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
 121         /**
 122          * Button cannot be invalid
 123          *
 124          * @param string $value
 125          * @param array $alldata
 126          *
 127          * @return bool|string|Message
 128          */
 129         public function validate( $value, $alldata ) {
 130                 return true;
 131         }
 132
 133         /**
 134          * IE<8 has bugs with <button>, so we'll need to avoid them.
 135          * @return bool Whether the request is from a bad version of IE
 136          */
 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 }