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         /**
 149          * @inheritDoc
 150          * @return OOUI\PanelLayout
 151          */
 152         protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
 153                 // to get a user visible effect, wrap the fieldset into a framed panel layout
 154                 $layout = new OOUI\PanelLayout( [
 155                         'expanded' => false,
 156                         'padded' => true,
 157                         'framed' => true,
 158                 ] );
 159
 160                 $layout->appendContent(
 161                         new OOUI\FieldsetLayout( [
 162                                 'label' => $legend,
 163                                 'items' => [
 164                                         new OOUI\Widget( [
 165                                                 'content' => new OOUI\HtmlSnippet( $section )
 166                                         ] ),
 167                                 ],
 168                         ] + $attributes )
 169                 );
 170                 return $layout;
 171         }
 172
 173         /**
 174          * Put a form section together from the individual fields' HTML, merging it and wrapping.
 175          * @param OOUI\FieldLayout[] $fieldsHtml
 176          * @param string $sectionName
 177          * @param bool $anyFieldHasLabel Unused
 178          * @return string HTML
 179          */
 180         protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
 181                 if ( !$fieldsHtml ) {
 182                         // Do not generate any wrappers for empty sections. Sections may be empty if they only have
 183                         // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
 184                         return '';
 185                 }
 186
 187                 $html = implode( '', $fieldsHtml );
 188
 189                 if ( $sectionName ) {
 190                         $html = Html::rawElement(
 191                                 'div',
 192                                 [ 'id' => Sanitizer::escapeIdForAttribute( $sectionName ) ],
 193                                 $html
 194                         );
 195                 }
 196                 return $html;
 197         }
 198
 199         /**
 200          * @param string|array|Status $elements
 201          * @param string $elementsType
 202          * @return string
 203          */
 204         public function getErrorsOrWarnings( $elements, $elementsType ) {
 205                 if ( $elements === '' ) {
 206                         return '';
 207                 }
 208
 209                 if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
 210                         throw new DomainException( $elementsType . ' is not a valid type.' );
 211                 }
 212                 $errors = [];
 213                 if ( $elements instanceof Status ) {
 214                         if ( !$elements->isGood() ) {
 215                                 $errors = $elements->getErrorsByType( $elementsType );
 216                                 foreach ( $errors as &$error ) {
 217                                         // Input:  [ 'message' => 'foo', 'errors' => [ 'a', 'b', 'c' ] ]
 218                                         // Output: [ 'foo', 'a', 'b', 'c' ]
 219                                         $error = array_merge( [ $error['message'] ], $error['params'] );
 220                                 }
 221                         }
 222                 } elseif ( $elementsType === 'error' ) {
 223                         if ( is_array( $elements ) ) {
 224                                 $errors = $elements;
 225                         } elseif ( is_string( $elements ) ) {
 226                                 $errors = [ $elements ];
 227                         }
 228                 }
 229
 230                 foreach ( $errors as &$error ) {
 231                         $error = $this->getMessage( $error )->parse();
 232                         $error = new OOUI\HtmlSnippet( $error );
 233                 }
 234
 235                 // Used in getBody()
 236                 if ( $elementsType === 'error' ) {
 237                         $this->oouiErrors = $errors;
 238                 } else {
 239                         $this->oouiWarnings = $errors;
 240                 }
 241                 return '';
 242         }
 243
 244         public function getHeaderText( $section = null ) {
 245                 if ( is_null( $section ) ) {
 246                         // We handle $this->mHeader elsewhere, in getBody()
 247                         return '';
 248                 } else {
 249                         return parent::getHeaderText( $section );
 250                 }
 251         }
 252
 253         public function getBody() {
 254                 $html = parent::getBody();
 255                 if ( $this->mHeader || $this->oouiErrors || $this->oouiWarnings ) {
 256                         $classes = [ 'mw-htmlform-ooui-header' ];
 257                         if ( $this->oouiErrors ) {
 258                                 $classes[] = 'mw-htmlform-ooui-header-errors';
 259                         }
 260                         if ( $this->oouiWarnings ) {
 261                                 $classes[] = 'mw-htmlform-ooui-header-warnings';
 262                         }
 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                         $html = new OOUI\FieldLayout(
 270                                 $element,
 271                                 [
 272                                         'align' => 'top',
 273                                         'errors' => $this->oouiErrors,
 274                                         'notices' => $this->oouiWarnings,
 275                                         'classes' => $classes,
 276                                 ]
 277                         ) . $html;
 278                 }
 279                 return $html;
 280         }
 281
 282         public function wrapForm( $html ) {
 283                 if ( is_string( $this->mWrapperLegend ) ) {
 284                         $content = new OOUI\FieldsetLayout( [
 285                                 'label' => $this->mWrapperLegend,
 286                                 'items' => [
 287                                         new OOUI\Widget( [
 288                                                 'content' => new OOUI\HtmlSnippet( $html )
 289                                         ] ),
 290                                 ],
 291                         ] + OOUI\Element::configFromHtmlAttributes( $this->mWrapperAttributes ) );
 292                 } else {
 293                         $content = new OOUI\HtmlSnippet( $html );
 294                 }
 295
 296                 $form = new OOUI\FormLayout( $this->getFormAttributes() + [
 297                         'classes' => [ 'mw-htmlform', 'mw-htmlform-ooui' ],
 298                         'content' => $content,
 299                 ] );
 300
 301                 // Include a wrapper for style, if requested.
 302                 $form = new OOUI\PanelLayout( [
 303                         'classes' => [ 'mw-htmlform-ooui-wrapper' ],
 304                         'expanded' => false,
 305                         'padded' => $this->mWrapperLegend !== false,
 306                         'framed' => $this->mWrapperLegend !== false,
 307                         'content' => $form,
 308                 ] );
 309
 310                 return $form;
 311         }
 312 }