MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / vendor / oojs / oojs-ui / php / widgets / ButtonInputWidget.php

diff --git a/vendor/oojs/oojs-ui/php/widgets/ButtonInputWidget.php b/vendor/oojs/oojs-ui/php/widgets/ButtonInputWidget.php
new file mode 100644 (file)
index 0000000..b356f7c
--- /dev/null
+++ b/vendor/oojs/oojs-ui/php/widgets/ButtonInputWidget.php
@@ -0,0 +1,123 @@
+<?php
+
+namespace OOUI;
+
+/**
+ * A button that is an input widget. Intended to be used within a FormLayout.
+ */
+class ButtonInputWidget extends InputWidget {
+       use ButtonElement;
+       use IconElement;
+       use IndicatorElement;
+       use LabelElement {
+               LabelElement::setLabel as setLabelElementLabel;
+       }
+
+       /* Static Properties */
+
+       public static $tagName = 'span';
+
+       /* Properties */
+
+       /**
+        * Whether to use `<input>` rather than `<button>`.
+        *
+        * @var boolean
+        */
+       protected $useInputTag;
+
+       /**
+        * @param array $config Configuration options
+        * @param string $config['type'] HTML tag `type` attribute, may be 'button', 'submit' or 'reset'
+        *   (default: 'button')
+        * @param bool $config['useInputTag'] Whether to use `<input>` rather than `<button>`. Only
+        *   useful if you need IE 6 support in a form with multiple buttons. If you use this option,
+        *   icons and indicators will not be displayed, it won't be possible to have a non-plaintext
+        *   label, and it won't be possible to set a value (which will internally become identical to the
+        *   label). (default: false)
+        */
+       public function __construct( array $config = [] ) {
+               // Configuration initialization
+               $config = array_merge( [ 'type' => 'button', 'useInputTag' => false ], $config );
+
+               // Properties (must be set before parent constructor, which calls setValue())
+               $this->useInputTag = $config['useInputTag'];
+
+               // Parent constructor
+               parent::__construct( $config );
+
+               // Traits
+               $this->initializeButtonElement(
+                       array_merge( $config, [ 'button' => $this->input ] ) );
+               $this->initializeIconElement( $config );
+               $this->initializeIndicatorElement( $config );
+               $this->initializeLabelElement( $config );
+               $this->initializeTitledElement(
+                       array_merge( $config, [ 'titled' => $this->input ] ) );
+
+               // Initialization
+               if ( !$config['useInputTag'] ) {
+                       $this->input->appendContent( $this->icon, $this->label, $this->indicator );
+               }
+
+               $this->addClasses( [ 'oo-ui-buttonInputWidget' ] );
+       }
+
+       protected function getInputElement( $config ) {
+               $type = in_array( $config['type'], [ 'button', 'submit', 'reset' ] ) ?
+                       $config['type'] :
+                       'button';
+               $tag = $config['useInputTag'] ? 'input' : 'button';
+               return ( new Tag( $tag ) )->setAttributes( [ 'type' => $type ] );
+       }
+
+       /**
+        * Set label value.
+        *
+        * Overridden to support setting the 'value' of `<input>` elements.
+        *
+        * @param string|null $label Label text
+        * @return $this
+        */
+       public function setLabel( $label ) {
+               if ( $this->useInputTag ) {
+                       // Discard non-plaintext labels
+                       if ( !is_string( $label ) ) {
+                               $label = '';
+                       }
+
+                       $this->input->setValue( $label );
+               }
+
+               return $this->setLabelElementLabel( $label );
+       }
+
+       /**
+        * Set the value of the input.
+        *
+        * Overridden to disable for `<input>` elements, which have value identical to the label.
+        *
+        * @param string $value New value
+        * @return $this
+        */
+       public function setValue( $value ) {
+               if ( !$this->useInputTag ) {
+                       parent::setValue( $value );
+               }
+               return $this;
+       }
+
+       public function getInputId() {
+               // Disable generating `<label>` elements for buttons. One would very rarely need additional label
+               // for a button, and it's already a big clickable target, and it causes unexpected rendering.
+               return null;
+       }
+
+       public function getConfig( &$config ) {
+               if ( $this->useInputTag ) {
+                       $config['useInputTag'] = true;
+               }
+               $config['type'] = $this->input->getAttribute( 'type' );
+               return parent::getConfig( $config );
+       }
+}