includes/htmlform/HTMLCheckMatrix.php

   1 <?php
   2
   3 /**
   4  * A checkbox matrix
   5  * Operates similarly to HTMLMultiSelectField, but instead of using an array of
   6  * options, uses an array of rows and an array of columns to dynamically
   7  * construct a matrix of options. The tags used to identify a particular cell
   8  * are of the form "columnName-rowName"
   9  *
  10  * Options:
  11  *   - columns
  12  *     - Required list of columns in the matrix.
  13  *   - rows
  14  *     - Required list of rows in the matrix.
  15  *   - force-options-on
  16  *     - Accepts array of column-row tags to be displayed as enabled but unavailable to change
  17  *   - force-options-off
  18  *     - Accepts array of column-row tags to be displayed as disabled but unavailable to change.
  19  *   - tooltips
  20  *     - Optional array mapping row label to tooltip content
  21  *   - tooltip-class
  22  *     - Optional CSS class used on tooltip container span. Defaults to mw-icon-question.
  23  */
  24 class HTMLCheckMatrix extends HTMLFormField implements HTMLNestedFilterable {
  25         static private $requiredParams = array(
  26                 // Required by underlying HTMLFormField
  27                 'fieldname',
  28                 // Required by HTMLCheckMatrix
  29                 'rows',
  30                 'columns'
  31         );
  32
  33         public function __construct( $params ) {
  34                 $missing = array_diff( self::$requiredParams, array_keys( $params ) );
  35                 if ( $missing ) {
  36                         throw new HTMLFormFieldRequiredOptionsException( $this, $missing );
  37                 }
  38                 parent::__construct( $params );
  39         }
  40
  41         function validate( $value, $alldata ) {
  42                 $rows = $this->mParams['rows'];
  43                 $columns = $this->mParams['columns'];
  44
  45                 // Make sure user-defined validation callback is run
  46                 $p = parent::validate( $value, $alldata );
  47                 if ( $p !== true ) {
  48                         return $p;
  49                 }
  50
  51                 // Make sure submitted value is an array
  52                 if ( !is_array( $value ) ) {
  53                         return false;
  54                 }
  55
  56                 // If all options are valid, array_intersect of the valid options
  57                 // and the provided options will return the provided options.
  58                 $validOptions = array();
  59                 foreach ( $rows as $rowTag ) {
  60                         foreach ( $columns as $columnTag ) {
  61                                 $validOptions[] = $columnTag . '-' . $rowTag;
  62                         }
  63                 }
  64                 $validValues = array_intersect( $value, $validOptions );
  65                 if ( count( $validValues ) == count( $value ) ) {
  66                         return true;
  67                 } else {
  68                         return $this->msg( 'htmlform-select-badoption' )->parse();
  69                 }
  70         }
  71
  72         /**
  73          * Build a table containing a matrix of checkbox options.
  74          * The value of each option is a combination of the row tag and column tag.
  75          * mParams['rows'] is an array with row labels as keys and row tags as values.
  76          * mParams['columns'] is an array with column labels as keys and column tags as values.
  77          *
  78          * @param array $value Array of the options that should be checked
  79          *
  80          * @return string
  81          */
  82         function getInputHTML( $value ) {
  83                 $html = '';
  84                 $tableContents = '';
  85                 $rows = $this->mParams['rows'];
  86                 $columns = $this->mParams['columns'];
  87
  88                 $attribs = $this->getAttributes( array( 'disabled', 'tabindex' ) );
  89
  90                 // Build the column headers
  91                 $headerContents = Html::rawElement( 'td', array(), '&#160;' );
  92                 foreach ( $columns as $columnLabel => $columnTag ) {
  93                         $headerContents .= Html::rawElement( 'td', array(), $columnLabel );
  94                 }
  95                 $tableContents .= Html::rawElement( 'tr', array(), "\n$headerContents\n" );
  96
  97                 $tooltipClass = 'mw-icon-question';
  98                 if ( isset( $this->mParams['tooltip-class'] ) ) {
  99                         $tooltipClass = $this->mParams['tooltip-class'];
 100                 }
 101
 102                 // Build the options matrix
 103                 foreach ( $rows as $rowLabel => $rowTag ) {
 104                         // Append tooltip if configured
 105                         if ( isset( $this->mParams['tooltips'][$rowLabel] ) ) {
 106                                 $tooltipAttribs = array(
 107                                         'class' => "mw-htmlform-tooltip $tooltipClass",
 108                                         'title' => $this->mParams['tooltips'][$rowLabel],
 109                                 );
 110                                 $rowLabel .= ' ' . Html::element( 'span', $tooltipAttribs, '' );
 111                         }
 112                         $rowContents = Html::rawElement( 'td', array(), $rowLabel );
 113                         foreach ( $columns as $columnTag ) {
 114                                 $thisTag = "$columnTag-$rowTag";
 115                                 // Construct the checkbox
 116                                 $thisAttribs = array(
 117                                         'id' => "{$this->mID}-$thisTag",
 118                                         'value' => $thisTag,
 119                                 );
 120                                 $checked = in_array( $thisTag, (array)$value, true );
 121                                 if ( $this->isTagForcedOff( $thisTag ) ) {
 122                                         $checked = false;
 123                                         $thisAttribs['disabled'] = 1;
 124                                 } elseif ( $this->isTagForcedOn( $thisTag ) ) {
 125                                         $checked = true;
 126                                         $thisAttribs['disabled'] = 1;
 127                                 }
 128                                 $rowContents .= Html::rawElement(
 129                                         'td',
 130                                         array(),
 131                                         Xml::check( "{$this->mName}[]", $checked, $attribs + $thisAttribs )
 132                                 );
 133                         }
 134                         $tableContents .= Html::rawElement( 'tr', array(), "\n$rowContents\n" );
 135                 }
 136
 137                 // Put it all in a table
 138                 $html .= Html::rawElement( 'table',
 139                                 array( 'class' => 'mw-htmlform-matrix' ),
 140                                 Html::rawElement( 'tbody', array(), "\n$tableContents\n" ) ) . "\n";
 141
 142                 return $html;
 143         }
 144
 145         protected function isTagForcedOff( $tag ) {
 146                 return isset( $this->mParams['force-options-off'] )
 147                         && in_array( $tag, $this->mParams['force-options-off'] );
 148         }
 149
 150         protected function isTagForcedOn( $tag ) {
 151                 return isset( $this->mParams['force-options-on'] )
 152                         && in_array( $tag, $this->mParams['force-options-on'] );
 153         }
 154
 155         /**
 156          * Get the complete table row for the input, including help text,
 157          * labels, and whatever.
 158          * We override this function since the label should always be on a separate
 159          * line above the options in the case of a checkbox matrix, i.e. it's always
 160          * a "vertical-label".
 161          *
 162          * @param string $value The value to set the input to
 163          *
 164          * @return string Complete HTML table row
 165          */
 166         function getTableRow( $value ) {
 167                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 168                 $inputHtml = $this->getInputHTML( $value );
 169                 $fieldType = get_class( $this );
 170                 $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
 171                 $cellAttributes = array( 'colspan' => 2 );
 172
 173                 $label = $this->getLabelHtml( $cellAttributes );
 174
 175                 $field = Html::rawElement(
 176                         'td',
 177                         array( 'class' => 'mw-input' ) + $cellAttributes,
 178                         $inputHtml . "\n$errors"
 179                 );
 180
 181                 $html = Html::rawElement( 'tr', array( 'class' => 'mw-htmlform-vertical-label' ), $label );
 182                 $html .= Html::rawElement( 'tr',
 183                         array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
 184                         $field );
 185
 186                 return $html . $helptext;
 187         }
 188
 189         /**
 190          * @param WebRequest $request
 191          *
 192          * @return array
 193          */
 194         function loadDataFromRequest( $request ) {
 195                 if ( $this->mParent->getMethod() == 'post' ) {
 196                         if ( $request->wasPosted() ) {
 197                                 // Checkboxes are not added to the request arrays if they're not checked,
 198                                 // so it's perfectly possible for there not to be an entry at all
 199                                 return $request->getArray( $this->mName, array() );
 200                         } else {
 201                                 // That's ok, the user has not yet submitted the form, so show the defaults
 202                                 return $this->getDefault();
 203                         }
 204                 } else {
 205                         // This is the impossible case: if we look at $_GET and see no data for our
 206                         // field, is it because the user has not yet submitted the form, or that they
 207                         // have submitted it with all the options unchecked. We will have to assume the
 208                         // latter, which basically means that you can't specify 'positive' defaults
 209                         // for GET forms.
 210                         return $request->getArray( $this->mName, array() );
 211                 }
 212         }
 213
 214         function getDefault() {
 215                 if ( isset( $this->mDefault ) ) {
 216                         return $this->mDefault;
 217                 } else {
 218                         return array();
 219                 }
 220         }
 221
 222         function filterDataForSubmit( $data ) {
 223                 $columns = HTMLFormField::flattenOptions( $this->mParams['columns'] );
 224                 $rows = HTMLFormField::flattenOptions( $this->mParams['rows'] );
 225                 $res = array();
 226                 foreach ( $columns as $column ) {
 227                         foreach ( $rows as $row ) {
 228                                 // Make sure option hasn't been forced
 229                                 $thisTag = "$column-$row";
 230                                 if ( $this->isTagForcedOff( $thisTag ) ) {
 231                                         $res[$thisTag] = false;
 232                                 } elseif ( $this->isTagForcedOn( $thisTag ) ) {
 233                                         $res[$thisTag] = true;
 234                                 } else {
 235                                         $res[$thisTag] = in_array( $thisTag, $data );
 236                                 }
 237                         }
 238                 }
 239
 240                 return $res;
 241         }
 242 }