PreferencesFormOOUI.php

Go to the documentation of this file.

<?php
class PreferencesFormOOUI extends OOUIHTMLForm {
    // Override default value from HTMLForm
    protected $mSubSectionBeforeFields = false;
 
    private $modifiedUser;
 
    private $privateInfoEditable = true;
 
    private $optionsEditable = true;
 
    public function setModifiedUser( $user ) {
        $this->modifiedUser = $user;
    }
 
    public function getModifiedUser() {
        if ( $this->modifiedUser === null ) {
            return $this->getUser();
        } else {
            return $this->modifiedUser;
        }
    }
 
    public function isPrivateInfoEditable() {
        return $this->privateInfoEditable;
    }
 
    public function setPrivateInfoEditable( $editable ) {
        $this->privateInfoEditable = $editable;
    }
 
    public function areOptionsEditable() {
        return $this->optionsEditable;
    }
 
    public function setOptionsEditable( $optionsEditable ) {
        $this->optionsEditable = $optionsEditable;
    }
 
    public function getExtraSuccessRedirectParameters() {
        return [];
    }
 
    public function wrapForm( $html ) {
        $html = Xml::tags( 'div', [ 'id' => 'preferences' ], $html );
 
        return parent::wrapForm( $html );
    }
 
    public function getButtons() {
        if ( !$this->areOptionsEditable() && !$this->isPrivateInfoEditable() ) {
            return '';
        }
 
        $html = parent::getButtons();
 
        if ( $this->areOptionsEditable() ) {
            $t = $this->getTitle()->getSubpage( 'reset' );
 
            $html .= new OOUI\ButtonWidget( [
                'infusable' => true,
                'id' => 'mw-prefs-restoreprefs',
                'label' => $this->msg( 'restoreprefs' )->text(),
                'href' => $t->getLinkURL(),
                'flags' => [ 'destructive' ],
                'framed' => false,
            ] );
 
            $html = Xml::tags( 'div', [ 'class' => 'mw-prefs-buttons' ], $html );
        }
 
        return $html;
    }
 
    public function filterDataForSubmit( $data ) {
        foreach ( $this->mFlatFields as $fieldname => $field ) {
            if ( $field instanceof HTMLNestedFilterable ) {
                // @phan-suppress-next-next-line PhanUndeclaredProperty All HTMLForm fields have mParams,
                // but the instanceof confuses phan, which doesn't support intersections
                $info = $field->mParams;
                $prefix = $info['prefix'] ?? $fieldname;
                foreach ( $field->filterDataForSubmit( $data[$fieldname] ) as $key => $value ) {
                    $data["$prefix$key"] = $value;
                }
                unset( $data[$fieldname] );
            }
        }
 
        return $data;
    }
 
    protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
        $layout = parent::wrapFieldSetSection( $legend, $section, $attributes, $isRoot );
 
        $layout->addClasses( [ 'mw-prefs-fieldset-wrapper' ] );
        $layout->removeClasses( [ 'oo-ui-panelLayout-framed' ] );
 
        return $layout;
    }
 
    public function getBody() {
        $tabPanels = [];
        foreach ( $this->mFieldTree as $key => $val ) {
            if ( !is_array( $val ) ) {
                wfDebug( __METHOD__ . " encountered a field not attached to a section: '$key'" );
                continue;
            }
            $label = $this->getLegend( $key );
            $content =
                $this->getHeaderText( $key ) .
                $this->displaySection(
                    $val,
                    "",
                    "mw-prefsection-$key-"
                ) .
                $this->getFooterText( $key );
 
            $tabPanels[] = new OOUI\TabPanelLayout( 'mw-prefsection-' . $key, [
                'classes' => [ 'mw-htmlform-autoinfuse-lazy' ],
                'label' => $label,
                'content' => new OOUI\FieldsetLayout( [
                    'classes' => [ 'mw-prefs-section-fieldset' ],
                    'id' => "mw-prefsection-$key",
                    'label' => $label,
                    'items' => [
                        new OOUI\Widget( [
                            'content' => new OOUI\HtmlSnippet( $content )
                        ] ),
                    ],
                ] ),
                'expanded' => false,
                'framed' => true,
            ] );
        }
 
        $indexLayout = new OOUI\IndexLayout( [
            'infusable' => true,
            'expanded' => false,
            'autoFocus' => false,
            'classes' => [ 'mw-prefs-tabs' ],
        ] );
        $indexLayout->addTabPanels( $tabPanels );
 
        $header = $this->formatFormHeader();
        $form = new OOUI\PanelLayout( [
            'framed' => true,
            'expanded' => false,
            'classes' => [ 'mw-prefs-tabs-wrapper' ],
            'content' => $indexLayout
        ] );
 
        return $header . $form;
    }
 
    public function getLegend( $key ) {
        $legend = parent::getLegend( $key );
        $this->getHookRunner()->onPreferencesGetLegend( $this, $key, $legend );
        return $legend;
    }
 
    public function getPreferenceSections() {
        return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
    }
}