PreferencesFormOOUI.php

Go to the documentation of this file.

<?php
class PreferencesFormOOUI extends OOUIHTMLForm {
    // 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() {
        if ( !$this->getModifiedUser()->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
            return '';
        }
 
        $html = parent::getButtons();
 
        if ( $this->getModifiedUser()->isAllowed( 'editmyoptions' ) ) {
            $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;
    }
 
    function filterDataForSubmit( $data ) {
        foreach ( $this->mFlatFields as $fieldname => $field ) {
            if ( $field instanceof HTMLNestedFilterable ) {
                $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 ) {
        // to get a user visible effect, wrap the fieldset into a framed panel layout
        if ( $isRoot ) {
            // Mimic TabPanelLayout
            $wrapper = new OOUI\PanelLayout( [
                'expanded' => false,
                'scrollable' => true,
                // Framed and padded for no-JS, frame hidden with CSS
                'framed' => true,
                'infusable' => false,
                'classes' => [ 'oo-ui-stackLayout oo-ui-indexLayout-stackLayout' ]
            ] );
            $layout = new OOUI\PanelLayout( [
                'expanded' => false,
                'scrollable' => true,
                'infusable' => false,
                'classes' => [ 'oo-ui-tabPanelLayout' ]
            ] );
            $wrapper->appendContent( $layout );
        } else {
            $wrapper = $layout = new OOUI\PanelLayout( [
                'expanded' => false,
                'padded' => true,
                'framed' => true,
                'infusable' => false,
            ] );
        }
 
        $layout->appendContent(
            new OOUI\FieldsetLayout( [
                'label' => $legend,
                'infusable' => false,
                'items' => [
                    new OOUI\Widget( [
                        'content' => new OOUI\HtmlSnippet( $section )
                    ] ),
                ],
            ] + $attributes )
        );
        return $wrapper;
    }
 
    function getBody() {
        // Construct fake tabs to avoid FOUC. The structure mimics OOUI's tabPanelLayout.
        // TODO: Consider creating an infusable TabPanelLayout in OOUI-PHP.
        $fakeTabs = [];
        foreach ( $this->getPreferenceSections() as $i => $key ) {
            $fakeTabs[] =
                Html::rawElement(
                    'div',
                    [
                        'class' =>
                            'oo-ui-widget oo-ui-widget-enabled oo-ui-optionWidget ' .
                            'oo-ui-tabOptionWidget oo-ui-labelElement' .
                            ( $i === 0 ? ' oo-ui-optionWidget-selected' : '' )
                    ],
                    Html::element(
                        'a',
                        [
                            'class' => 'oo-ui-labelElement-label',
                            // Make this a usable link instead of a span so the tabs
                            // can be used before JS runs
                            'href' => '#mw-prefsection-' . $key
                        ],
                        $this->getLegend( $key )
                    )
                );
        }
        $fakeTabsHtml = Html::rawElement(
            'div',
            [ 'class' => 'oo-ui-layout oo-ui-panelLayout oo-ui-indexLayout-tabPanel' ],
            Html::rawElement(
                'div',
                [ 'class' => 'oo-ui-widget oo-ui-widget-enabled oo-ui-selectWidget ' .
                    'oo-ui-selectWidget-depressed oo-ui-tabSelectWidget' ],
                implode( $fakeTabs )
            )
        );
 
        return Html::rawElement(
            'div',
            [ 'class' => 'oo-ui-layout oo-ui-panelLayout oo-ui-panelLayout-framed mw-prefs-faketabs' ],
            Html::rawElement(
                'div',
                [ 'class' => 'oo-ui-layout oo-ui-menuLayout oo-ui-menuLayout-static ' .
                    'oo-ui-menuLayout-top oo-ui-menuLayout-showMenu oo-ui-indexLayout' ],
                Html::rawElement(
                    'div',
                    [ 'class' => 'oo-ui-menuLayout-menu' ],
                    $fakeTabsHtml
                ) .
                Html::rawElement(
                    'div',
                    [ 'class' => 'oo-ui-menuLayout-content mw-htmlform-autoinfuse-lazy' ],
                    $this->displaySection( $this->mFieldTree, '', 'mw-prefsection-' )
                )
            )
        );
    }
 
    function getLegend( $key ) {
        $aliasKey = ( $key === 'optoutwatchlist' || $key === 'optoutrc' ) ? 'opt-out' : $key;
        $legend = parent::getLegend( $aliasKey );
        Hooks::run( 'PreferencesGetLegend', [ $this, $key, &$legend ] );
        return $legend;
    }
 
    function getPreferenceSections() {
        return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
    }
}