Amritsreekumar has uploaded a new change for review.
https://gerrit.wikimedia.org/r/320369
Change subject: Change Checkboxes from right to left of Labels
......................................................................
Change Checkboxes from right to left of Labels
The Checkboxes on Special:BotPasswords should be moved from right to left for
the convenience of the users.
Bug: T150079
Change-Id: I513dd979436f0c27f51768e56e419f332fa2c97d
---
M includes/htmlform/fields/HTMLCheckMatrix.php
1 file changed, 225 insertions(+), 237 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/69/320369/1
diff --git a/includes/htmlform/fields/HTMLCheckMatrix.php
b/includes/htmlform/fields/HTMLCheckMatrix.php
index b324fb6..150ebef6 100644
--- a/includes/htmlform/fields/HTMLCheckMatrix.php
+++ b/includes/htmlform/fields/HTMLCheckMatrix.php
@@ -1,5 +1,4 @@
<?php
-
/**
* A checkbox matrix
* Operates similarly to HTMLMultiSelectField, but instead of using an array of
@@ -22,245 +21,234 @@
* - Optional CSS class used on tooltip container span. Defaults to
mw-icon-question.
*/
class HTMLCheckMatrix extends HTMLFormField implements HTMLNestedFilterable {
- static private $requiredParams = [
- // Required by underlying HTMLFormField
- 'fieldname',
- // Required by HTMLCheckMatrix
- 'rows',
- 'columns'
- ];
+ static private $requiredParams = [
+ // Required by underlying HTMLFormField
+ 'fieldname',
+ // Required by HTMLCheckMatrix
+ 'rows',
+ 'columns'
+ ];
+ public function __construct( $params ) {
+ $missing = array_diff( self::$requiredParams, array_keys( $params ) );
+ if ( $missing ) {
+ throw new HTMLFormFieldRequiredOptionsException( $this, $missing );
+ }
+ parent::__construct( $params );
+ }
+ function validate( $value, $alldata ) {
+ $rows = $this->mParams['rows'];
+ $columns = $this->mParams['columns'];
+ // Make sure user-defined validation callback is run
+ $p = parent::validate( $value, $alldata );
+ if ( $p !== true ) {
+ return $p;
+ }
+ // Make sure submitted value is an array
+ if ( !is_array( $value ) ) {
+ return false;
+ }
+ // If all options are valid, array_intersect of the valid options
+ // and the provided options will return the provided options.
+ $validOptions = [];
+ foreach ( $rows as $rowTag ) {
+ foreach ( $columns as $columnTag ) {
+ $validOptions[] = $columnTag . '-' . $rowTag;
+ }
+ }
+ $validValues = array_intersect( $value, $validOptions );
+ if ( count( $validValues ) == count( $value ) ) {
+ return true;
+ } else {
+ return $this->msg( 'htmlform-select-badoption' )->parse();
+ }
+ }
+ /**
+ * Build a table containing a matrix of checkbox options.
+ * The value of each option is a combination of the row tag and column tag.
+ * mParams['rows'] is an array with row labels as keys and row tags as
values.
+ * mParams['columns'] is an array with column labels as keys and column
tags as values.
+ *
+ * @param array $value Array of the options that should be checked
+ *
+ * @return string
+ */
+ function getInputHTML( $value ) {
+ $html = '';
+ $tableContents = '';
+ $rows = $this->mParams['rows'];
+ $columns = $this->mParams['columns'];
- public function __construct( $params ) {
- $missing = array_diff( self::$requiredParams, array_keys(
$params ) );
- if ( $missing ) {
- throw new HTMLFormFieldRequiredOptionsException( $this,
$missing );
- }
- parent::__construct( $params );
- }
+ $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
- function validate( $value, $alldata ) {
- $rows = $this->mParams['rows'];
- $columns = $this->mParams['columns'];
+ // Build the column headers
+ $headerContents = Html::rawElement( 'tr', [], ' ' );
+ foreach ( $columns as $columnLabel => $columnTag ) {
+ $headerContents .= Html::rawElement( 'tr', [], $columnLabel );
+ }
+ $tableContents .= Html::rawElement( 'tr', [], "\n$headerContents\n" );
- // Make sure user-defined validation callback is run
- $p = parent::validate( $value, $alldata );
- if ( $p !== true ) {
- return $p;
- }
+ $tooltipClass = 'mw-icon-question';
+ if ( isset( $this->mParams['tooltip-class'] ) ) {
+ $tooltipClass = $this->mParams['tooltip-class'];
+ }
- // Make sure submitted value is an array
- if ( !is_array( $value ) ) {
- return false;
- }
+ // Build the options matrix
+ foreach ( $rows as $rowLabel => $rowTag ) {
+ // Append tooltip if configured
+ if ( isset( $this->mParams['tooltips'][$rowLabel] ) ) {
+ $tooltipAttribs = [
+ 'class' => "mw-htmlform-tooltip $tooltipClass",
+ 'title' => $this->mParams['tooltips'][$rowLabel],
+ ];
+ $rowLabel .= ' ' . Html::element( 'span', $tooltipAttribs, ''
);
+ }
+ foreach ( $columns as $columnTag ) {
+ $thisTag = "$columnTag-$rowTag";
+ // Construct the checkbox
+ $thisAttribs = [
+ 'id' => "{$this->mID}-$thisTag",
+ 'value' => $thisTag,
+ ];
+ $checked = in_array( $thisTag, (array)$value, true );
+ if ( $this->isTagForcedOff( $thisTag ) ) {
+ $checked = false;
+ $thisAttribs['disabled'] = 1;
+ } elseif ( $this->isTagForcedOn( $thisTag ) ) {
+ $checked = true;
+ $thisAttribs['disabled'] = 1;
+ }
+ $checkbox = $this->getOneCheckbox( $checked, $attribs +
$thisAttribs );
- // If all options are valid, array_intersect of the valid
options
- // and the provided options will return the provided options.
- $validOptions = [];
- foreach ( $rows as $rowTag ) {
- foreach ( $columns as $columnTag ) {
- $validOptions[] = $columnTag . '-' . $rowTag;
- }
- }
- $validValues = array_intersect( $value, $validOptions );
- if ( count( $validValues ) == count( $value ) ) {
- return true;
- } else {
- return $this->msg( 'htmlform-select-badoption'
)->parse();
- }
- }
+ $rowContents = Html::rawElement( 'td', [], $checkbox );
+ $rowContents .= Html::rawElement(
+ 'td',
+ [],
+ $rowLabel
+ );
+ }
+ $tableContents .= Html::rawElement( 'tr', [], "$rowContents" );
+ }
+
+ // Put it all in a table
+ $html .= Html::rawElement( 'table',
+ [ 'class' => 'mw-htmlform-matrix' ],
+ Html::rawElement( 'tbody', [], "$tableContents" ) ) . "\n";
- /**
- * Build a table containing a matrix of checkbox options.
- * The value of each option is a combination of the row tag and column
tag.
- * mParams['rows'] is an array with row labels as keys and row tags as
values.
- * mParams['columns'] is an array with column labels as keys and column
tags as values.
- *
- * @param array $value Array of the options that should be checked
- *
- * @return string
- */
- function getInputHTML( $value ) {
- $html = '';
- $tableContents = '';
- $rows = $this->mParams['rows'];
- $columns = $this->mParams['columns'];
-
- $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
-
- // Build the column headers
- $headerContents = Html::rawElement( 'td', [], ' ' );
- foreach ( $columns as $columnLabel => $columnTag ) {
- $headerContents .= Html::rawElement( 'td', [],
$columnLabel );
- }
- $tableContents .= Html::rawElement( 'tr', [],
"\n$headerContents\n" );
-
- $tooltipClass = 'mw-icon-question';
- if ( isset( $this->mParams['tooltip-class'] ) ) {
- $tooltipClass = $this->mParams['tooltip-class'];
- }
-
- // Build the options matrix
- foreach ( $rows as $rowLabel => $rowTag ) {
- // Append tooltip if configured
- if ( isset( $this->mParams['tooltips'][$rowLabel] ) ) {
- $tooltipAttribs = [
- 'class' => "mw-htmlform-tooltip
$tooltipClass",
- 'title' =>
$this->mParams['tooltips'][$rowLabel],
- ];
- $rowLabel .= ' ' . Html::element( 'span',
$tooltipAttribs, '' );
- }
- $rowContents = Html::rawElement( 'td', [], $rowLabel );
- foreach ( $columns as $columnTag ) {
- $thisTag = "$columnTag-$rowTag";
- // Construct the checkbox
- $thisAttribs = [
- 'id' => "{$this->mID}-$thisTag",
- 'value' => $thisTag,
- ];
- $checked = in_array( $thisTag, (array)$value,
true );
- if ( $this->isTagForcedOff( $thisTag ) ) {
- $checked = false;
- $thisAttribs['disabled'] = 1;
- } elseif ( $this->isTagForcedOn( $thisTag ) ) {
- $checked = true;
- $thisAttribs['disabled'] = 1;
- }
-
- $checkbox = $this->getOneCheckbox( $checked,
$attribs + $thisAttribs );
-
- $rowContents .= Html::rawElement(
- 'td',
- [],
- $checkbox
- );
- }
- $tableContents .= Html::rawElement( 'tr', [],
"\n$rowContents\n" );
- }
-
- // Put it all in a table
- $html .= Html::rawElement( 'table',
- [ 'class' => 'mw-htmlform-matrix' ],
- Html::rawElement( 'tbody', [],
"\n$tableContents\n" ) ) . "\n";
-
- return $html;
- }
-
- protected function getOneCheckbox( $checked, $attribs ) {
- if ( $this->mParent instanceof OOUIHTMLForm ) {
- return new OOUI\CheckboxInputWidget( [
- 'name' => "{$this->mName}[]",
- 'selected' => $checked,
- ] + OOUI\Element::configFromHtmlAttributes(
- $attribs
- ) );
- } else {
- $checkbox = Xml::check( "{$this->mName}[]", $checked,
$attribs );
- if ( $this->mParent->getConfig()->get(
'UseMediaWikiUIEverywhere' ) ) {
- $checkbox = Html::openElement( 'div', [ 'class'
=> 'mw-ui-checkbox' ] ) .
- $checkbox .
- Html::element( 'label', [ 'for' =>
$attribs['id'] ] ) .
- Html::closeElement( 'div' );
- }
- return $checkbox;
- }
- }
-
- protected function isTagForcedOff( $tag ) {
- return isset( $this->mParams['force-options-off'] )
- && in_array( $tag, $this->mParams['force-options-off']
);
- }
-
- protected function isTagForcedOn( $tag ) {
- return isset( $this->mParams['force-options-on'] )
- && in_array( $tag, $this->mParams['force-options-on'] );
- }
-
- /**
- * Get the complete table row for the input, including help text,
- * labels, and whatever.
- * We override this function since the label should always be on a
separate
- * line above the options in the case of a checkbox matrix, i.e. it's
always
- * a "vertical-label".
- *
- * @param string $value The value to set the input to
- *
- * @return string Complete HTML table row
- */
- function getTableRow( $value ) {
- list( $errors, $errorClass ) = $this->getErrorsAndErrorClass(
$value );
- $inputHtml = $this->getInputHTML( $value );
- $fieldType = get_class( $this );
- $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
- $cellAttributes = [ 'colspan' => 2 ];
-
- $hideClass = '';
- $hideAttributes = [];
- if ( $this->mHideIf ) {
- $hideAttributes['data-hide-if'] = FormatJson::encode(
$this->mHideIf );
- $hideClass = 'mw-htmlform-hide-if';
- }
-
- $label = $this->getLabelHtml( $cellAttributes );
-
- $field = Html::rawElement(
- 'td',
- [ 'class' => 'mw-input' ] + $cellAttributes,
- $inputHtml . "\n$errors"
- );
-
- $html = Html::rawElement( 'tr',
- [ 'class' => "mw-htmlform-vertical-label $hideClass" ]
+ $hideAttributes,
- $label );
- $html .= Html::rawElement( 'tr',
- [ 'class' => "mw-htmlform-field-$fieldType
{$this->mClass} $errorClass $hideClass" ] +
- $hideAttributes,
- $field );
-
- return $html . $helptext;
- }
-
- /**
- * @param WebRequest $request
- *
- * @return array
- */
- function loadDataFromRequest( $request ) {
- if ( $this->isSubmitAttempt( $request ) ) {
- // Checkboxes are just not added to the request arrays
if they're not checked,
- // so it's perfectly possible for there not to be an
entry at all
- return $request->getArray( $this->mName, [] );
- } else {
- // That's ok, the user has not yet submitted the form,
so show the defaults
- return $this->getDefault();
- }
- }
-
- function getDefault() {
- if ( isset( $this->mDefault ) ) {
- return $this->mDefault;
- } else {
- return [];
- }
- }
-
- function filterDataForSubmit( $data ) {
- $columns = HTMLFormField::flattenOptions(
$this->mParams['columns'] );
- $rows = HTMLFormField::flattenOptions( $this->mParams['rows'] );
- $res = [];
- foreach ( $columns as $column ) {
- foreach ( $rows as $row ) {
- // Make sure option hasn't been forced
- $thisTag = "$column-$row";
- if ( $this->isTagForcedOff( $thisTag ) ) {
- $res[$thisTag] = false;
- } elseif ( $this->isTagForcedOn( $thisTag ) ) {
- $res[$thisTag] = true;
- } else {
- $res[$thisTag] = in_array( $thisTag,
$data );
- }
- }
- }
-
- return $res;
- }
-}
+ return $html;
+ }
+ protected function getOneCheckbox( $checked, $attribs ) {
+ if ( $this->mParent instanceof OOUIHTMLForm ) {
+ return new OOUI\CheckboxInputWidget( [
+ 'name' => "{$this->mName}[]",
+ 'selected' => $checked,
+ ] + OOUI\Element::configFromHtmlAttributes(
+ $attribs
+ ) );
+ } else {
+ $checkbox = Xml::check( "{$this->mName}[]", $checked, $attribs );
+ if ( $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere'
) ) {
+ $checkbox = Html::openElement( 'div', [ 'class' =>
'mw-ui-checkbox' ] ) .
+ $checkbox .
+ Html::element( 'label', [ 'for' => $attribs['id'] ] ) .
+ Html::closeElement( 'div' );
+ }
+ return $checkbox;
+ }
+ }
+ protected function isTagForcedOff( $tag ) {
+ return isset( $this->mParams['force-options-off'] )
+ && in_array( $tag, $this->mParams['force-options-off'] );
+ }
+ protected function isTagForcedOn( $tag ) {
+ return isset( $this->mParams['force-options-on'] )
+ && in_array( $tag, $this->mParams['force-options-on'] );
+ }
+ /**
+ * Get the complete table row for the input, including help text,
+ * labels, and whatever.
+ * We override this function since the label should always be on a separate
+ * line above the options in the case of a checkbox matrix, i.e. it's
always
+ * a "vertical-label".
+ *
+ * @param string $value The value to set the input to
+ *
+ * @return string Complete HTML table row
+ */
+ function getTableRow( $value ) {
+ list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
+ $inputHtml = $this->getInputHTML( $value );
+ $fieldType = get_class( $this );
+ $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
+ $cellAttributes = [ 'colspan' => 2 ];
+ $hideClass = '';
+ $hideAttributes = [];
+ if ( $this->mHideIf ) {
+ $hideAttributes['data-hide-if'] = FormatJson::encode(
$this->mHideIf );
+ $hideClass = 'mw-htmlform-hide-if';
+ }
+ $label = $this->getLabelHtml( $cellAttributes );
+ $field = Html::rawElement(
+ 'td',
+ [ 'class' => 'mw-input' ] + $cellAttributes,
+ $inputHtml . "\n$errors"
+ );
+ $html = Html::rawElement( 'tr',
+ [ 'class' => "mw-htmlform-vertical-label $hideClass" ] +
$hideAttributes,
+ $label );
+ $html .= Html::rawElement( 'tr',
+ [ 'class' => "mw-htmlform-field-$fieldType {$this->mClass}
$errorClass $hideClass" ] +
+ $hideAttributes,
+ $field );
+ return $html . $helptext;
+ }
+ /**
+ * @param WebRequest $request
+ *
+ * @return array
+ */
+ function loadDataFromRequest( $request ) {
+ if ( $this->mParent->getMethod() == 'post' ) {
+ if ( $request->wasPosted() ) {
+ // Checkboxes are not added to the request arrays if they're
not checked,
+ // so it's perfectly possible for there not to be an entry at
all
+ return $request->getArray( $this->mName, [] );
+ } else {
+ // That's ok, the user has not yet submitted the form, so show
the defaults
+ return $this->getDefault();
+ }
+ } else {
+ // This is the impossible case: if we look at $_GET and see no
data for our
+ // field, is it because the user has not yet submitted the form,
or that they
+ // have submitted it with all the options unchecked. We will have
to assume the
+ // latter, which basically means that you can't specify 'positive'
defaults
+ // for GET forms.
+ return $request->getArray( $this->mName, [] );
+ }
+ }
+ function getDefault() {
+ if ( isset( $this->mDefault ) ) {
+ return $this->mDefault;
+ } else {
+ return [];
+ }
+ }
+ function filterDataForSubmit( $data ) {
+ $columns = HTMLFormField::flattenOptions( $this->mParams['columns'] );
+ $rows = HTMLFormField::flattenOptions( $this->mParams['rows'] );
+ $res = [];
+ foreach ( $columns as $column ) {
+ foreach ( $rows as $row ) {
+ // Make sure option hasn't been forced
+ $thisTag = "$column-$row";
+ if ( $this->isTagForcedOff( $thisTag ) ) {
+ $res[$thisTag] = false;
+ } elseif ( $this->isTagForcedOn( $thisTag ) ) {
+ $res[$thisTag] = true;
+ } else {
+ $res[$thisTag] = in_array( $thisTag, $data );
+ }
+ }
+ }
+ return $res;
+ }
+}
\ No newline at end of file
--
To view, visit https://gerrit.wikimedia.org/r/320369
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I513dd979436f0c27f51768e56e419f332fa2c97d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Amritsreekumar <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
