includes/htmlform/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  *
  17  * Note that the buttonlabel parameters are not supported on IE6 and IE7 due to
  18  * bugs in those browsers. If detected, they will be served buttons using the
  19  * value of 'default' as the button label.
  20  *
  21  * @since 1.22
  22  */
  23 class HTMLButtonField extends HTMLFormField {
  24         protected $buttonType = 'button';
  25         protected $buttonLabel = null;
  26
  27         /** @var array $mFlags Flags to add to OOUI Button widget */
  28         protected $mFlags = [];
  29
  30         public function __construct( $info ) {
  31                 $info['nodata'] = true;
  32                 if ( isset( $info['flags'] ) ) {
  33                         $this->mFlags = $info['flags'];
  34                 }
  35
  36                 # Generate the label from a message, if possible
  37                 if ( isset( $info['buttonlabel-message'] ) ) {
  38                         $msgInfo = $info['buttonlabel-message'];
  39
  40                         if ( is_array( $msgInfo ) ) {
  41                                 $msg = array_shift( $msgInfo );
  42                         } else {
  43                                 $msg = $msgInfo;
  44                                 $msgInfo = [];
  45                         }
  46
  47                         $this->buttonLabel = $this->msg( $msg, $msgInfo )->parse();
  48                 } elseif ( isset( $info['buttonlabel'] ) ) {
  49                         if ( $info['buttonlabel'] === '&#160;' ) {
  50                                 // Apparently some things set &nbsp directly and in an odd format
  51                                 $this->buttonLabel = '&#160;';
  52                         } else {
  53                                 $this->buttonLabel = htmlspecialchars( $info['buttonlabel'] );
  54                         }
  55                 } elseif ( isset( $info['buttonlabel-raw'] ) ) {
  56                         $this->buttonLabel = $info['buttonlabel-raw'];
  57                 }
  58
  59                 $this->setShowEmptyLabel( false );
  60
  61                 parent::__construct( $info );
  62         }
  63
  64         public function getInputHTML( $value ) {
  65                 $flags = '';
  66                 $prefix = 'mw-htmlform-';
  67                 if ( $this->mParent instanceof VFormHTMLForm ||
  68                         $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' )
  69                 ) {
  70                         $prefix = 'mw-ui-';
  71                         // add mw-ui-button separately, so the descriptor doesn't need to set it
  72                         $flags .= ' ' . $prefix . 'button';
  73                 }
  74                 foreach ( $this->mFlags as $flag ) {
  75                         $flags .= ' ' . $prefix . $flag;
  76                 }
  77                 $attr = [
  78                         'class' => 'mw-htmlform-submit ' . $this->mClass . $flags,
  79                         'id' => $this->mID,
  80                         'type' => $this->buttonType,
  81                         'name' => $this->mName,
  82                         'value' => $this->getDefault(),
  83                 ] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
  84
  85                 if ( $this->isBadIE() ) {
  86                         return Html::element( 'input', $attr );
  87                 } else {
  88                         return Html::rawElement( 'button', $attr,
  89                                 $this->buttonLabel ?: htmlspecialchars( $this->getDefault() ) );
  90                 }
  91         }
  92
  93         /**
  94          * Get the OOUI widget for this field.
  95          * @param string $value
  96          * @return OOUI\ButtonInputWidget
  97          */
  98         public function getInputOOUI( $value ) {
  99                 return new OOUI\ButtonInputWidget( [
 100                         'name' => $this->mName,
 101                         'value' => $this->getDefault(),
 102                         'label' => !$this->isBadIE() && $this->buttonLabel
 103                                 ? new OOUI\HtmlSnippet( $this->buttonLabel )
 104                                 : $this->getDefault(),
 105                         'type' => $this->buttonType,
 106                         'classes' => [ 'mw-htmlform-submit', $this->mClass ],
 107                         'id' => $this->mID,
 108                         'flags' => $this->mFlags,
 109                         'useInputTag' => $this->isBadIE(),
 110                 ] + OOUI\Element::configFromHtmlAttributes(
 111                         $this->getAttributes( [ 'disabled', 'tabindex' ] )
 112                 ) );
 113         }
 114
 115         protected function needsLabel() {
 116                 return false;
 117         }
 118
 119         /**
 120          * Button cannot be invalid
 121          *
 122          * @param string $value
 123          * @param array $alldata
 124          *
 125          * @return bool
 126          */
 127         public function validate( $value, $alldata ) {
 128                 return true;
 129         }
 130
 131         /**
 132          * IE<8 has bugs with <button>, so we'll need to avoid them.
 133          * @return bool Whether the request is from a bad version of IE
 134          */
 135         private function isBadIE() {
 136                 $request = $this->mParent
 137                         ? $this->mParent->getRequest()
 138                         : RequestContext::getMain()->getRequest();
 139                 return preg_match( '/MSIE [1-7]\./i', $request->getHeader( 'User-Agent' ) );
 140         }
 141 }