wiki.techinc.nl/includes/htmlform/fields/HTMLCheckField.php
Bartosz Dziewoński 8c1a1a62a1 Avoid duplicate accesskey hints on OOUI widgets
Values returned by `Linker::tooltipAndAccesskeyAttribs()` and
`Linker::titleAttrib( ..., 'withaccess' )` include an accesskey
hint in the title text. This is unnecessary when used for OOjs UI
widgets, since after the changes from T168408 they display an
accesskey hint automatically.

Also fixed some other accesskey bugs in HTMLForm which probably
no one ever ran into.

Bug: T168408
Change-Id: I63285b5bce3341875a6d82eba059623bf105ca62
2017-08-01 20:59:13 +00:00

131 lines
3.1 KiB
PHP

<?php
/**
* A checkbox field
*/
class HTMLCheckField extends HTMLFormField {
public function getInputHTML( $value ) {
global $wgUseMediaWikiUIEverywhere;
if ( !empty( $this->mParams['invert'] ) ) {
$value = !$value;
}
$attr = $this->getTooltipAndAccessKey();
$attr['id'] = $this->mID;
$attr += $this->getAttributes( [ 'disabled', 'tabindex' ] );
if ( $this->mClass !== '' ) {
$attr['class'] = $this->mClass;
}
$attrLabel = [ 'for' => $this->mID ];
if ( isset( $attr['title'] ) ) {
// propagate tooltip to label
$attrLabel['title'] = $attr['title'];
}
$chkLabel = Xml::check( $this->mName, $value, $attr ) .
'&#160;' .
Html::rawElement( 'label', $attrLabel, $this->mLabel );
if ( $wgUseMediaWikiUIEverywhere || $this->mParent instanceof VFormHTMLForm ) {
$chkLabel = Html::rawElement(
'div',
[ 'class' => 'mw-ui-checkbox' ],
$chkLabel
);
}
return $chkLabel;
}
/**
* Get the OOUI version of this field.
* @since 1.26
* @param string $value
* @return OOUI\CheckboxInputWidget The checkbox widget.
*/
public function getInputOOUI( $value ) {
if ( !empty( $this->mParams['invert'] ) ) {
$value = !$value;
}
$attr = $this->getTooltipAndAccessKeyOOUI();
$attr['id'] = $this->mID;
$attr['name'] = $this->mName;
$attr += OOUI\Element::configFromHtmlAttributes(
$this->getAttributes( [ 'disabled', 'tabindex' ] )
);
if ( $this->mClass !== '' ) {
$attr['classes'] = [ $this->mClass ];
}
$attr['selected'] = $value;
$attr['value'] = '1'; // Nasty hack, but needed to make this work
return new OOUI\CheckboxInputWidget( $attr );
}
/**
* For a checkbox, the label goes on the right hand side, and is
* added in getInputHTML(), rather than HTMLFormField::getRow()
*
* ...unless OOUI is being used, in which case we actually return
* the label here.
*
* @return string
*/
public function getLabel() {
if ( $this->mParent instanceof OOUIHTMLForm ) {
return $this->mLabel;
} elseif (
$this->mParent instanceof HTMLForm &&
$this->mParent->getDisplayFormat() === 'div'
) {
return '';
} else {
return '&#160;';
}
}
/**
* Get label alignment when generating field for OOUI.
* @return string 'left', 'right', 'top' or 'inline'
*/
protected function getLabelAlignOOUI() {
return 'inline';
}
/**
* checkboxes don't need a label.
* @return bool
*/
protected function needsLabel() {
return false;
}
/**
* @param WebRequest $request
*
* @return bool
*/
public function loadDataFromRequest( $request ) {
$invert = isset( $this->mParams['invert'] ) && $this->mParams['invert'];
// GetCheck won't work like we want for checks.
// Fetch the value in either one of the two following case:
// - we have a valid submit attempt (form was just submitted, or a GET URL forged by the user)
// - checkbox name has a value (false or true), ie is not null
if ( $this->isSubmitAttempt( $request ) || $request->getVal( $this->mName ) !== null ) {
return $invert
? !$request->getBool( $this->mName )
: $request->getBool( $this->mName );
} else {
return (bool)$this->getDefault();
}
}
}