includes/htmlform/OOUIHTMLForm.php

   1 <?php
   2
   3 /**
   4  * HTML form generation and submission handling, OOUI style.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23
  24 /**
  25  * Compact stacked vertical format for forms, implemented using OOUI widgets.
  26  */
  27 class OOUIHTMLForm extends HTMLForm {
  28         private $oouiErrors;
  29         private $oouiWarnings;
  30
  31         public function __construct( $descriptor, $context = null, $messagePrefix = '' ) {
  32                 parent::__construct( $descriptor, $context, $messagePrefix );
  33                 $this->getOutput()->enableOOUI();
  34                 $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.ooui.styles' );
  35         }
  36
  37         /**
  38          * Symbolic display format name.
  39          * @var string
  40          */
  41         protected $displayFormat = 'ooui';
  42
  43         public static function loadInputFromParameters( $fieldname, $descriptor,
  44                 HTMLForm $parent = null
  45         ) {
  46                 $field = parent::loadInputFromParameters( $fieldname, $descriptor, $parent );
  47                 $field->setShowEmptyLabel( false );
  48                 return $field;
  49         }
  50
  51         public function getButtons() {
  52                 $buttons = '';
  53
  54                 // IE<8 has bugs with <button>, so we'll need to avoid them.
  55                 $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
  56
  57                 if ( $this->mShowSubmit ) {
  58                         $attribs = [ 'infusable' => true ];
  59
  60                         if ( isset( $this->mSubmitID ) ) {
  61                                 $attribs['id'] = $this->mSubmitID;
  62                         }
  63
  64                         if ( isset( $this->mSubmitName ) ) {
  65                                 $attribs['name'] = $this->mSubmitName;
  66                         }
  67
  68                         if ( isset( $this->mSubmitTooltip ) ) {
  69                                 $attribs += [
  70                                         'title' => Linker::titleAttrib( $this->mSubmitTooltip ),
  71                                         'accessKey' => Linker::accesskey( $this->mSubmitTooltip ),
  72                                 ];
  73                         }
  74
  75                         $attribs['classes'] = [ 'mw-htmlform-submit' ];
  76                         $attribs['type'] = 'submit';
  77                         $attribs['label'] = $this->getSubmitText();
  78                         $attribs['value'] = $this->getSubmitText();
  79                         $attribs['flags'] = $this->mSubmitFlags;
  80                         $attribs['useInputTag'] = $isBadIE;
  81
  82                         $buttons .= new OOUI\ButtonInputWidget( $attribs );
  83                 }
  84
  85                 if ( $this->mShowReset ) {
  86                         $buttons .= new OOUI\ButtonInputWidget( [
  87                                 'type' => 'reset',
  88                                 'label' => $this->msg( 'htmlform-reset' )->text(),
  89                                 'useInputTag' => $isBadIE,
  90                         ] );
  91                 }
  92
  93                 if ( $this->mShowCancel ) {
  94                         $target = $this->mCancelTarget ?: Title::newMainPage();
  95                         if ( $target instanceof Title ) {
  96                                 $target = $target->getLocalURL();
  97                         }
  98                         $buttons .= new OOUI\ButtonWidget( [
  99                                 'label' => $this->msg( 'cancel' )->text(),
 100                                 'href' => $target,
 101                         ] );
 102                 }
 103
 104                 foreach ( $this->mButtons as $button ) {
 105                         $attrs = [];
 106
 107                         if ( $button['attribs'] ) {
 108                                 $attrs += $button['attribs'];
 109                         }
 110
 111                         if ( isset( $button['id'] ) ) {
 112                                 $attrs['id'] = $button['id'];
 113                         }
 114
 115                         if ( $isBadIE ) {
 116                                 $label = $button['value'];
 117                         } elseif ( isset( $button['label-message'] ) ) {
 118                                 $label = new OOUI\HtmlSnippet( $this->getMessage( $button['label-message'] )->parse() );
 119                         } elseif ( isset( $button['label'] ) ) {
 120                                 $label = $button['label'];
 121                         } elseif ( isset( $button['label-raw'] ) ) {
 122                                 $label = new OOUI\HtmlSnippet( $button['label-raw'] );
 123                         } else {
 124                                 $label = $button['value'];
 125                         }
 126
 127                         $attrs['classes'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
 128
 129                         $buttons .= new OOUI\ButtonInputWidget( [
 130                                 'type' => 'submit',
 131                                 'name' => $button['name'],
 132                                 'value' => $button['value'],
 133                                 'label' => $label,
 134                                 'flags' => $button['flags'],
 135                                 'framed' => $button['framed'],
 136                                 'useInputTag' => $isBadIE,
 137                         ] + $attrs );
 138                 }
 139
 140                 if ( !$buttons ) {
 141                         return '';
 142                 }
 143
 144                 return Html::rawElement( 'div',
 145                         [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
 146         }
 147
 148         protected function wrapFieldSetSection( $legend, $section, $attributes ) {
 149                 // to get a user visible effect, wrap the fieldset into a framed panel layout
 150                 $layout = new OOUI\PanelLayout( [
 151                         'expanded' => false,
 152                         'padded' => true,
 153                         'framed' => true,
 154                         'infusable' => false,
 155                 ] );
 156
 157                 $layout->appendContent(
 158                         new OOUI\FieldsetLayout( [
 159                                 'label' => $legend,
 160                                 'infusable' => false,
 161                                 'items' => [
 162                                         new OOUI\Widget( [
 163                                                 'content' => new OOUI\HtmlSnippet( $section )
 164                                         ] ),
 165                                 ],
 166                         ] + $attributes )
 167                 );
 168                 return $layout;
 169         }
 170
 171         /**
 172          * Put a form section together from the individual fields' HTML, merging it and wrapping.
 173          * @param OOUI\FieldLayout[] $fieldsHtml
 174          * @param string $sectionName
 175          * @param bool $anyFieldHasLabel Unused
 176          * @return string HTML
 177          */
 178         protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
 179                 if ( !$fieldsHtml ) {
 180                         // Do not generate any wrappers for empty sections. Sections may be empty if they only have
 181                         // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
 182                         return '';
 183                 }
 184
 185                 $config = [
 186                         'items' => $fieldsHtml,
 187                 ];
 188                 if ( $sectionName ) {
 189                         $config['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
 190                 }
 191                 if ( is_string( $this->mWrapperLegend ) ) {
 192                         $config['label'] = $this->mWrapperLegend;
 193                 }
 194                 return new OOUI\FieldsetLayout( $config );
 195         }
 196
 197         /**
 198          * @param string|array|Status $elements
 199          * @param string $elementsType
 200          * @return string
 201          */
 202         public function getErrorsOrWarnings( $elements, $elementsType ) {
 203                 if ( $elements === '' ) {
 204                         return '';
 205                 }
 206
 207                 if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
 208                         throw new DomainException( $elementsType . ' is not a valid type.' );
 209                 }
 210                 $errors = [];
 211                 if ( $elements instanceof Status ) {
 212                         if ( !$elements->isGood() ) {
 213                                 $errors = $elements->getErrorsByType( $elementsType );
 214                                 foreach ( $errors as &$error ) {
 215                                         // Input:  [ 'message' => 'foo', 'errors' => [ 'a', 'b', 'c' ] ]
 216                                         // Output: [ 'foo', 'a', 'b', 'c' ]
 217                                         $error = array_merge( [ $error['message'] ], $error['params'] );
 218                                 }
 219                         }
 220                 } elseif ( $elementsType === 'error' ) {
 221                         if ( is_array( $elements ) ) {
 222                                 $errors = $elements;
 223                         } elseif ( is_string( $elements ) ) {
 224                                 $errors = [ $elements ];
 225                         }
 226                 }
 227
 228                 foreach ( $errors as &$error ) {
 229                         $error = $this->getMessage( $error )->parse();
 230                         $error = new OOUI\HtmlSnippet( $error );
 231                 }
 232
 233                 // Used in getBody()
 234                 if ( $elementsType === 'error' ) {
 235                         $this->oouiErrors = $errors;
 236                 } else {
 237                         $this->oouiWarnings = $errors;
 238                 }
 239                 return '';
 240         }
 241
 242         public function getHeaderText( $section = null ) {
 243                 if ( is_null( $section ) ) {
 244                         // We handle $this->mHeader elsewhere, in getBody()
 245                         return '';
 246                 } else {
 247                         return parent::getHeaderText( $section );
 248                 }
 249         }
 250
 251         public function getBody() {
 252                 $fieldset = parent::getBody();
 253                 // FIXME This only works for forms with no subsections
 254                 if ( $fieldset instanceof OOUI\FieldsetLayout ) {
 255                         $classes = [ 'mw-htmlform-ooui-header' ];
 256                         if ( $this->oouiErrors ) {
 257                                 $classes[] = 'mw-htmlform-ooui-header-errors';
 258                         }
 259                         if ( $this->oouiWarnings ) {
 260                                 $classes[] = 'mw-htmlform-ooui-header-warnings';
 261                         }
 262                         if ( $this->mHeader || $this->oouiErrors || $this->oouiWarnings ) {
 263                                 // if there's no header, don't create an (empty) LabelWidget, simply use a placeholder
 264                                 if ( $this->mHeader ) {
 265                                         $element = new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet( $this->mHeader ) ] );
 266                                 } else {
 267                                         $element = new OOUI\Widget( [] );
 268                                 }
 269                                 $fieldset->addItems( [
 270                                         new OOUI\FieldLayout(
 271                                                 $element,
 272                                                 [
 273                                                         'align' => 'top',
 274                                                         'errors' => $this->oouiErrors,
 275                                                         'notices' => $this->oouiWarnings,
 276                                                         'classes' => $classes,
 277                                                 ]
 278                                         )
 279                                 ], 0 );
 280                         }
 281                 }
 282                 return $fieldset;
 283         }
 284
 285         public function wrapForm( $html ) {
 286                 $form = new OOUI\FormLayout( $this->getFormAttributes() + [
 287                         'classes' => [ 'mw-htmlform', 'mw-htmlform-ooui' ],
 288                         'content' => new OOUI\HtmlSnippet( $html ),
 289                 ] );
 290
 291                 // Include a wrapper for style, if requested.
 292                 $form = new OOUI\PanelLayout( [
 293                         'classes' => [ 'mw-htmlform-ooui-wrapper' ],
 294                         'expanded' => false,
 295                         'padded' => $this->mWrapperLegend !== false,
 296                         'framed' => $this->mWrapperLegend !== false,
 297                         'content' => $form,
 298                 ] );
 299
 300                 return $form;
 301         }
 302 }