includes/specials/forms/PreferencesFormOOUI.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 /**
  22  * Form to edit user preferences.
  23  *
  24  * @since 1.32
  25  */
  26 class PreferencesFormOOUI extends OOUIHTMLForm {
  27         // Override default value from HTMLForm
  28         protected $mSubSectionBeforeFields = false;
  29
  30         /** @var User|null */
  31         private $modifiedUser;
  32
  33         /** @var bool */
  34         private $privateInfoEditable = true;
  35
  36         /** @var bool */
  37         private $optionsEditable = true;
  38
  39         /**
  40          * @param User $user
  41          */
  42         public function setModifiedUser( $user ) {
  43                 $this->modifiedUser = $user;
  44         }
  45
  46         /**
  47          * @return User
  48          */
  49         public function getModifiedUser() {
  50                 if ( $this->modifiedUser === null ) {
  51                         return $this->getUser();
  52                 } else {
  53                         return $this->modifiedUser;
  54                 }
  55         }
  56
  57         /**
  58          * @return bool
  59          */
  60         public function isPrivateInfoEditable() {
  61                 return $this->privateInfoEditable;
  62         }
  63
  64         /**
  65          * Whether the
  66          * @param bool $editable
  67          */
  68         public function setPrivateInfoEditable( $editable ) {
  69                 $this->privateInfoEditable = $editable;
  70         }
  71
  72         /**
  73          * @return bool
  74          */
  75         public function areOptionsEditable() {
  76                 return $this->optionsEditable;
  77         }
  78
  79         /**
  80          * @param bool $optionsEditable
  81          */
  82         public function setOptionsEditable( $optionsEditable ) {
  83                 $this->optionsEditable = $optionsEditable;
  84         }
  85
  86         /**
  87          * Get extra parameters for the query string when redirecting after
  88          * successful save.
  89          *
  90          * @return array
  91          */
  92         public function getExtraSuccessRedirectParameters() {
  93                 return [];
  94         }
  95
  96         /**
  97          * @param string $html
  98          * @return string
  99          */
 100         function wrapForm( $html ) {
 101                 $html = Xml::tags( 'div', [ 'id' => 'preferences' ], $html );
 102
 103                 return parent::wrapForm( $html );
 104         }
 105
 106         /**
 107          * @return string
 108          */
 109         function getButtons() {
 110                 if ( !$this->areOptionsEditable() && !$this->isPrivateInfoEditable() ) {
 111                         return '';
 112                 }
 113
 114                 $html = parent::getButtons();
 115
 116                 if ( $this->areOptionsEditable() ) {
 117                         $t = $this->getTitle()->getSubpage( 'reset' );
 118
 119                         $html .= new OOUI\ButtonWidget( [
 120                                 'infusable' => true,
 121                                 'id' => 'mw-prefs-restoreprefs',
 122                                 'label' => $this->msg( 'restoreprefs' )->text(),
 123                                 'href' => $t->getLinkURL(),
 124                                 'flags' => [ 'destructive' ],
 125                                 'framed' => false,
 126                         ] );
 127
 128                         $html = Xml::tags( 'div', [ 'class' => 'mw-prefs-buttons' ], $html );
 129                 }
 130
 131                 return $html;
 132         }
 133
 134         /**
 135          * Separate multi-option preferences into multiple preferences, since we
 136          * have to store them separately
 137          * @param array $data
 138          * @return array
 139          */
 140         function filterDataForSubmit( $data ) {
 141                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 142                         if ( $field instanceof HTMLNestedFilterable ) {
 143                                 // @phan-suppress-next-next-line PhanUndeclaredProperty All HTMLForm fields have mParams,
 144                                 // but the instanceof confuses phan, which doesn't support intersections
 145                                 $info = $field->mParams;
 146                                 $prefix = $info['prefix'] ?? $fieldname;
 147                                 foreach ( $field->filterDataForSubmit( $data[$fieldname] ) as $key => $value ) {
 148                                         $data["$prefix$key"] = $value;
 149                                 }
 150                                 unset( $data[$fieldname] );
 151                         }
 152                 }
 153
 154                 return $data;
 155         }
 156
 157         protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
 158                 $layout = parent::wrapFieldSetSection( $legend, $section, $attributes, $isRoot );
 159
 160                 $layout->addClasses( [ 'mw-prefs-fieldset-wrapper' ] );
 161                 $layout->removeClasses( [ 'oo-ui-panelLayout-framed' ] );
 162
 163                 return $layout;
 164         }
 165
 166         /**
 167          * Get the whole body of the form.
 168          * @return string
 169          */
 170         function getBody() {
 171                 $tabPanels = [];
 172                 foreach ( $this->mFieldTree as $key => $val ) {
 173                         if ( !is_array( $val ) ) {
 174                                 wfDebug( __METHOD__ . " encountered a field not attached to a section: '$key'" );
 175                                 continue;
 176                         }
 177                         $label = $this->getLegend( $key );
 178                         $content =
 179                                 $this->getHeaderText( $key ) .
 180                                 $this->displaySection(
 181                                         $this->mFieldTree[$key],
 182                                         "",
 183                                         "mw-prefsection-$key-"
 184                                 ) .
 185                                 $this->getFooterText( $key );
 186
 187                         $tabPanels[] = new OOUI\TabPanelLayout( 'mw-prefsection-' . $key, [
 188                                 'classes' => [ 'mw-htmlform-autoinfuse-lazy' ],
 189                                 'label' => $label,
 190                                 'content' => new OOUI\FieldsetLayout( [
 191                                         'classes' => [ 'mw-prefs-section-fieldset' ],
 192                                         'id' => "mw-prefsection-$key",
 193                                         'label' => $label,
 194                                         'items' => [
 195                                                 new OOUI\Widget( [
 196                                                         'content' => new OOUI\HtmlSnippet( $content )
 197                                                 ] ),
 198                                         ],
 199                                 ] ),
 200                                 'expanded' => false,
 201                                 'framed' => true,
 202                         ] );
 203                 }
 204
 205                 $indexLayout = new OOUI\IndexLayout( [
 206                         'infusable' => true,
 207                         'expanded' => false,
 208                         'autoFocus' => false,
 209                         'classes' => [ 'mw-prefs-tabs' ],
 210                 ] );
 211                 $indexLayout->addTabPanels( $tabPanels );
 212
 213                 return new OOUI\PanelLayout( [
 214                         'framed' => true,
 215                         'expanded' => false,
 216                         'classes' => [ 'mw-prefs-tabs-wrapper' ],
 217                         'content' => $indexLayout
 218                 ] );
 219         }
 220
 221         /**
 222          * Get the "<legend>" for a given section key. Normally this is the
 223          * prefs-$key message but we'll allow extensions to override it.
 224          * @param string $key
 225          * @return string
 226          */
 227         function getLegend( $key ) {
 228                 $legend = parent::getLegend( $key );
 229                 Hooks::run( 'PreferencesGetLegend', [ $this, $key, &$legend ] );
 230                 return $legend;
 231         }
 232
 233         /**
 234          * Get the keys of each top level preference section.
 235          * @return string[] List of section keys
 236          */
 237         function getPreferenceSections() {
 238                 return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
 239         }
 240 }