includes/htmlform/HTMLFormFieldWithButton.php

   1 <?php
   2 /**
   3  * Enables HTMLFormField elements to be build with a button.
   4  */
   5 class HTMLFormFieldWithButton extends HTMLFormField {
   6         /** @var string $mButtonClass CSS class for the button in this field */
   7         protected $mButtonClass = '';
   8
   9         /** @var string|integer $mButtonId Element ID for the button in this field */
  10         protected $mButtonId = '';
  11
  12         /** @var string $mButtonName Name the button in this field */
  13         protected $mButtonName = '';
  14
  15         /** @var string $mButtonType Type of the button in this field (e.g. button or submit) */
  16         protected $mButtonType = 'submit';
  17
  18         /** @var string $mButtonType Value for the button in this field */
  19         protected $mButtonValue;
  20
  21         /** @var string $mButtonType Value for the button in this field */
  22         protected $mButtonFlags = [ 'progressive' ];
  23
  24         public function __construct( $info ) {
  25                 if ( isset( $info['buttonclass'] ) ) {
  26                         $this->mButtonClass = $info['buttonclass'];
  27                 }
  28                 if ( isset( $info['buttonid'] ) ) {
  29                         $this->mButtonId = $info['buttonid'];
  30                 }
  31                 if ( isset( $info['buttonname'] ) ) {
  32                         $this->mButtonName = $info['buttonname'];
  33                 }
  34                 if ( isset( $info['buttondefault'] ) ) {
  35                         $this->mButtonValue = $info['buttondefault'];
  36                 }
  37                 if ( isset( $info['buttontype'] ) ) {
  38                         $this->mButtonType = $info['buttontype'];
  39                 }
  40                 if ( isset( $info['buttonflags'] ) ) {
  41                         $this->mButtonFlags = $info['buttonflags'];
  42                 }
  43                 parent::__construct( $info );
  44         }
  45
  46         public function getInputHTML( $value ) {
  47                 $attr = [
  48                         'class' => 'mw-htmlform-submit ' . $this->mButtonClass,
  49                         'id' => $this->mButtonId,
  50                 ] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
  51
  52                 return Html::input( $this->mButtonName, $this->mButtonValue, $this->mButtonType, $attr );
  53         }
  54
  55         public function getInputOOUI( $value ) {
  56                 return new OOUI\ButtonInputWidget( [
  57                         'name' => $this->mButtonName,
  58                         'value' => $this->mButtonValue,
  59                         'type' => $this->mButtonType,
  60                         'label' => $this->mButtonValue,
  61                         'flags' => $this->mButtonFlags,
  62                 ] + OOUI\Element::configFromHtmlAttributes(
  63                         $this->getAttributes( [ 'disabled', 'tabindex' ] )
  64                 ) );
  65         }
  66
  67         /**
  68          * Combines the passed element with a button.
  69          * @param String $element Element to combine the button with.
  70          * @return String
  71          */
  72         public function getElement( $element ) {
  73                 return $element . '&#160;' . $this->getInputHTML( '' );
  74         }
  75 }