4085db348e
Remove "\\" in namespacing. This is a Doxygen compatibility hack but does not seem needed anymore, Doxygen reads namespaced class names correctly, see e.g. https://doc.wikimedia.org/mediawiki-core/master/php/classMediaWiki_1_1Services_1_1ServiceContainer.html PHP IDEs, on the other hand, were broken by the double backslash. As an unrelated small doc fix, add parameter docs to PermissionError constructor (parent has different arguments so the inherited documentation is wrong). Change-Id: I6da0f512b8c84f65fd20e90e4617108fe6a8fcd2
132 lines
4 KiB
PHP
132 lines
4 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Adds a generic button inline to the form. Does not do anything, you must add
|
|
* click handling code in JavaScript. Use a HTMLSubmitField if you merely
|
|
* wish to add a submit button to a form.
|
|
*
|
|
* Additional recognized configuration parameters include:
|
|
* - flags: OOUI flags for the button, see OOUI\FlaggedElement
|
|
* - buttonlabel-message: Message to use for the button display text, instead
|
|
* of the value from 'default'. Overrides 'buttonlabel' and 'buttonlabel-raw'.
|
|
* - buttonlabel: Text to display for the button display text, instead
|
|
* of the value from 'default'. Overrides 'buttonlabel-raw'.
|
|
* - buttonlabel-raw: HTMLto display for the button display text, instead
|
|
* of the value from 'default'.
|
|
*
|
|
* Note that the buttonlabel parameters are not supported on IE6 and IE7 due to
|
|
* bugs in those browsers. If detected, they will be served buttons using the
|
|
* value of 'default' as the button label.
|
|
*
|
|
* @since 1.22
|
|
*/
|
|
class HTMLButtonField extends HTMLFormField {
|
|
protected $buttonType = 'button';
|
|
protected $buttonLabel = null;
|
|
|
|
/** @var array $mFlags Flags to add to OOUI Button widget */
|
|
protected $mFlags = [];
|
|
|
|
public function __construct( $info ) {
|
|
$info['nodata'] = true;
|
|
if ( isset( $info['flags'] ) ) {
|
|
$this->mFlags = $info['flags'];
|
|
}
|
|
|
|
# Generate the label from a message, if possible
|
|
if ( isset( $info['buttonlabel-message'] ) ) {
|
|
$this->buttonLabel = $this->getMessage( $info['buttonlabel-message'] )->parse();
|
|
} elseif ( isset( $info['buttonlabel'] ) ) {
|
|
if ( $info['buttonlabel'] === ' ' ) {
|
|
// Apparently some things set   directly and in an odd format
|
|
$this->buttonLabel = ' ';
|
|
} else {
|
|
$this->buttonLabel = htmlspecialchars( $info['buttonlabel'] );
|
|
}
|
|
} elseif ( isset( $info['buttonlabel-raw'] ) ) {
|
|
$this->buttonLabel = $info['buttonlabel-raw'];
|
|
}
|
|
|
|
$this->setShowEmptyLabel( false );
|
|
|
|
parent::__construct( $info );
|
|
}
|
|
|
|
public function getInputHTML( $value ) {
|
|
$flags = '';
|
|
$prefix = 'mw-htmlform-';
|
|
if ( $this->mParent instanceof VFormHTMLForm ||
|
|
$this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' )
|
|
) {
|
|
$prefix = 'mw-ui-';
|
|
// add mw-ui-button separately, so the descriptor doesn't need to set it
|
|
$flags .= ' ' . $prefix . 'button';
|
|
}
|
|
foreach ( $this->mFlags as $flag ) {
|
|
$flags .= ' ' . $prefix . $flag;
|
|
}
|
|
$attr = [
|
|
'class' => 'mw-htmlform-submit ' . $this->mClass . $flags,
|
|
'id' => $this->mID,
|
|
'type' => $this->buttonType,
|
|
'name' => $this->mName,
|
|
'value' => $this->getDefault(),
|
|
] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
|
|
|
|
if ( $this->isBadIE() ) {
|
|
return Html::element( 'input', $attr );
|
|
} else {
|
|
return Html::rawElement( 'button', $attr,
|
|
$this->buttonLabel ?: htmlspecialchars( $this->getDefault() ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the OOUI widget for this field.
|
|
* @param string $value
|
|
* @return OOUI\ButtonInputWidget
|
|
*/
|
|
public function getInputOOUI( $value ) {
|
|
return new OOUI\ButtonInputWidget( [
|
|
'name' => $this->mName,
|
|
'value' => $this->getDefault(),
|
|
'label' => !$this->isBadIE() && $this->buttonLabel
|
|
? new OOUI\HtmlSnippet( $this->buttonLabel )
|
|
: $this->getDefault(),
|
|
'type' => $this->buttonType,
|
|
'classes' => [ 'mw-htmlform-submit', $this->mClass ],
|
|
'id' => $this->mID,
|
|
'flags' => $this->mFlags,
|
|
'useInputTag' => $this->isBadIE(),
|
|
] + OOUI\Element::configFromHtmlAttributes(
|
|
$this->getAttributes( [ 'disabled', 'tabindex' ] )
|
|
) );
|
|
}
|
|
|
|
protected function needsLabel() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Button cannot be invalid
|
|
*
|
|
* @param string $value
|
|
* @param array $alldata
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function validate( $value, $alldata ) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* IE<8 has bugs with <button>, so we'll need to avoid them.
|
|
* @return bool Whether the request is from a bad version of IE
|
|
*/
|
|
private function isBadIE() {
|
|
$request = $this->mParent
|
|
? $this->mParent->getRequest()
|
|
: RequestContext::getMain()->getRequest();
|
|
return preg_match( '/MSIE [1-7]\./i', $request->getHeader( 'User-Agent' ) );
|
|
}
|
|
}
|