PreferencesForm.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
class PreferencesForm extends HTMLForm {
    // Override default value from HTMLForm
    protected $mSubSectionBeforeFields = false;
 
    private $modifiedUser;
 
    public function setModifiedUser( $user ) {
        $this->modifiedUser = $user;
    }
 
    public function getModifiedUser() {
        if ( $this->modifiedUser === null ) {
            return $this->getUser();
        } else {
            return $this->modifiedUser;
        }
    }
 
    public function getExtraSuccessRedirectParameters() {
        return [];
    }
 
    function wrapForm( $html ) {
        $html = Xml::tags( 'div', [ 'id' => 'preferences' ], $html );
 
        return parent::wrapForm( $html );
    }
 
    function getButtons() {
        $attrs = [ 'id' => 'mw-prefs-restoreprefs' ];
 
        if ( !$this->getModifiedUser()->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
            return '';
        }
 
        $html = parent::getButtons();
 
        if ( $this->getModifiedUser()->isAllowed( 'editmyoptions' ) ) {
            $t = $this->getTitle()->getSubpage( 'reset' );
 
            $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
            $html .= "\n" . $linkRenderer->makeLink( $t, $this->msg( 'restoreprefs' )->text(),
                Html::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ) );
 
            $html = Xml::tags( 'div', [ 'class' => 'mw-prefs-buttons' ], $html );
        }
 
        return $html;
    }
 
    function filterDataForSubmit( $data ) {
        foreach ( $this->mFlatFields as $fieldname => $field ) {
            if ( $field instanceof HTMLNestedFilterable ) {
                $info = $field->mParams;
                $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $fieldname;
                foreach ( $field->filterDataForSubmit( $data[$fieldname] ) as $key => $value ) {
                    $data["$prefix$key"] = $value;
                }
                unset( $data[$fieldname] );
            }
        }
 
        return $data;
    }
 
    function getBody() {
        return $this->displaySection( $this->mFieldTree, '', 'mw-prefsection-' );
    }
 
    function getLegend( $key ) {
        $legend = parent::getLegend( $key );
        Hooks::run( 'PreferencesGetLegend', [ $this, $key, &$legend ] );
        return $legend;
    }
 
    function getPreferenceSections() {
        return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
    }
}