wiki.techinc.nl/includes/htmlform/fields/HTMLFormFieldWithButton.php
James D. Forrester 8e940c4f21 Standardise all our class alias deprecation comments for ease of grepping
Change-Id: I7f85d931d3b79da23e87b4e5692b2e14be8fcaa0
2024-03-19 20:11:29 +00:00

93 lines
2.5 KiB
PHP

<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLFormField;
/**
* Enables HTMLFormField elements to be build with a button.
*
* TODO This class should be a trait
*
* @stable to extend
*/
class HTMLFormFieldWithButton extends HTMLFormField {
/** @var string CSS class for the button in this field */
protected $mButtonClass = '';
/** @var string|int Element ID for the button in this field */
protected $mButtonId = '';
/** @var string Name the button in this field */
protected $mButtonName = '';
/** @var string Type of the button in this field (e.g. button or submit) */
protected $mButtonType = 'submit';
/** @var string Value for the button in this field */
protected $mButtonValue;
/** @var string[] Value for the button in this field */
protected $mButtonFlags = [ 'progressive' ];
/**
* @stable to call
* @inheritDoc
*/
public function __construct( $info ) {
if ( isset( $info['buttonclass'] ) ) {
$this->mButtonClass = $info['buttonclass'];
}
if ( isset( $info['buttonid'] ) ) {
$this->mButtonId = $info['buttonid'];
}
if ( isset( $info['buttonname'] ) ) {
$this->mButtonName = $info['buttonname'];
}
if ( isset( $info['buttondefault'] ) ) {
$this->mButtonValue = $info['buttondefault'];
}
if ( isset( $info['buttontype'] ) ) {
$this->mButtonType = $info['buttontype'];
}
if ( isset( $info['buttonflags'] ) ) {
$this->mButtonFlags = $info['buttonflags'];
}
parent::__construct( $info );
}
public function getInputHTML( $value ) {
$attr = [
'class' => 'mw-htmlform-submit ' . $this->mButtonClass,
'id' => $this->mButtonId,
] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
return Html::input( $this->mButtonName, $this->mButtonValue, $this->mButtonType, $attr );
}
public function getInputOOUI( $value ) {
return new \OOUI\ButtonInputWidget( [
'name' => $this->mButtonName,
'value' => $this->mButtonValue,
'type' => $this->mButtonType,
'label' => $this->mButtonValue,
'flags' => $this->mButtonFlags,
'id' => $this->mButtonId ?: null,
] + \OOUI\Element::configFromHtmlAttributes(
$this->getAttributes( [ 'disabled', 'tabindex' ] )
) );
}
/**
* Combines the passed element with a button.
* @param string $element Element to combine the button with.
* @return string
*/
public function getElement( $element ) {
return $element . "\u{00A0}" . $this->getInputHTML( '' );
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLFormFieldWithButton::class, 'HTMLFormFieldWithButton' );