BaseTemplate.php

Go to the documentation of this file.

<?php
use Wikimedia\WrappedString;
use Wikimedia\WrappedStringList;
 
abstract class BaseTemplate extends QuickTemplate {
 
    public function getMsg( $name, ...$params ) {
        return $this->getSkin()->msg( $name, ...$params );
    }
 
    public function msg( $str ) {
        echo $this->getMsg( $str )->escaped();
    }
 
    public function getToolbox() {
        $toolbox = $this->getSkin()->makeToolbox(
            $this->data['nav_urls'],
            $this->data['feeds']
        );
 
        // Merge content that might be added to the toolbox section by hook
        if ( isset( $this->data['sidebar']['TOOLBOX'] ) ) {
            $toolbox = array_merge( $toolbox, $this->data['sidebar']['TOOLBOX'] ?? [] );
        }
 
        // T253416: Deprecated hook
        $this->getHookRunner()->onBaseTemplateToolbox( $this, $toolbox );
        return $toolbox;
    }
 
    public function getPersonalTools() {
        return $this->getSkin()->getPersonalToolsForMakeListItem( $this->get( 'personal_urls' ) );
    }
 
    protected function getSidebar( $options = [] ) {
        // Force the rendering of the following portals
        $sidebar = $this->data['sidebar'];
        if ( !isset( $sidebar['SEARCH'] ) ) {
            $sidebar['SEARCH'] = true;
        }
        if ( !isset( $sidebar['TOOLBOX'] ) ) {
            $sidebar['TOOLBOX'] = true;
        }
        if ( !isset( $sidebar['LANGUAGES'] ) ) {
            $sidebar['LANGUAGES'] = true;
        }
 
        if ( !isset( $options['search'] ) || $options['search'] !== true ) {
            unset( $sidebar['SEARCH'] );
        }
        if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
            unset( $sidebar['TOOLBOX'] );
        }
        if ( isset( $options['languages'] ) && $options['languages'] === false ) {
            unset( $sidebar['LANGUAGES'] );
        }
 
        $boxes = [];
        foreach ( $sidebar as $boxName => $content ) {
            if ( $content === false ) {
                continue;
            }
            switch ( $boxName ) {
                case 'SEARCH':
                    // Search is a special case, skins should custom implement this
                    $boxes[$boxName] = [
                        'id' => 'p-search',
                        'header' => $this->getMsg( 'search' )->text(),
                        'generated' => false,
                        'content' => true,
                    ];
                    break;
                case 'TOOLBOX':
                    $msgObj = $this->getMsg( 'toolbox' );
                    $boxes[$boxName] = [
                        'id' => 'p-tb',
                        'header' => $msgObj->exists() ? $msgObj->text() : 'toolbox',
                        'generated' => false,
                        'content' => $this->getToolbox(),
                    ];
                    break;
                case 'LANGUAGES':
                    if ( $this->data['language_urls'] !== false ) {
                        $msgObj = $this->getMsg( 'otherlanguages' );
                        $boxes[$boxName] = [
                            'id' => 'p-lang',
                            'header' => $msgObj->exists() ? $msgObj->text() : 'otherlanguages',
                            'generated' => false,
                            'content' => $this->data['language_urls'] ?: [],
                        ];
                    }
                    break;
                default:
                    $msgObj = $this->getMsg( $boxName );
                    $boxes[$boxName] = [
                        'id' => "p-$boxName",
                        'header' => $msgObj->exists() ? $msgObj->text() : $boxName,
                        'generated' => true,
                        'content' => $content,
                    ];
                    break;
            }
        }
 
        // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
        $hookContents = null;
        if ( isset( $boxes['TOOLBOX'] ) ) {
            ob_start();
            // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
            // can abort and avoid outputting double toolbox links
            $this->getHookRunner()->onSkinTemplateToolboxEnd( $this, true );
            $hookContents = ob_get_contents();
            ob_end_clean();
            if ( !trim( $hookContents ) ) {
                $hookContents = null;
            }
        }
        // END hack
 
        if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
            foreach ( $boxes as $boxName => $box ) {
                if ( is_array( $box['content'] ) ) {
                    $content = '<ul>';
                    foreach ( $box['content'] as $key => $val ) {
                        $content .= "\n " . $this->getSkin()->makeListItem( $key, $val );
                    }
                    // HACK, shove the toolbox end onto the toolbox if we're rendering itself
                    if ( $hookContents ) {
                        $content .= "\n $hookContents";
                    }
                    // END hack
                    $content .= "\n</ul>\n";
                    $boxes[$boxName]['content'] = $content;
                }
            }
        } elseif ( $hookContents ) {
            $boxes['TOOLBOXEND'] = [
                'id' => 'p-toolboxend',
                'header' => $boxes['TOOLBOX']['header'],
                'generated' => false,
                'content' => "<ul>{$hookContents}</ul>",
            ];
            // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
            $boxes2 = [];
            foreach ( $boxes as $key => $box ) {
                if ( $key === 'TOOLBOXEND' ) {
                    continue;
                }
                $boxes2[$key] = $box;
                if ( $key === 'TOOLBOX' ) {
                    $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
                }
            }
            $boxes = $boxes2;
            // END hack
        }
 
        return $boxes;
    }
 
    protected function renderAfterPortlet( $name ) {
        echo $this->getAfterPortlet( $name );
    }
 
    protected function getAfterPortlet( $name ) {
        $html = '';
        $content = '';
        $this->getHookRunner()->onBaseTemplateAfterPortlet( $this, $name, $content );
        $content .= $this->getSkin()->getAfterPortlet( $name );
 
        if ( $content !== '' ) {
            $html = Html::rawElement(
                'div',
                [ 'class' => [ 'after-portlet', 'after-portlet-' . $name ] ],
                $content
            );
        }
 
        return $html;
    }
 
    protected function makeLink( $key, $item, $options = [] ) {
        return $this->getSkin()->makeLink( $key, $item, $options );
    }
 
    public function makeListItem( $key, $item, $options = [] ) {
        return $this->getSkin()->makeListItem( $key, $item, $options );
    }
 
    protected function makeSearchInput( $attrs = [] ) {
        return $this->getSkin()->makeSearchInput( $attrs );
    }
 
    protected function makeSearchButton( $mode, $attrs = [] ) {
        return $this->getSkin()->makeSearchButton( $mode, $attrs );
    }
 
    protected function getFooterLinks( $option = null ) {
        $footerlinks = $this->get( 'footerlinks' );
 
        // Reduce footer links down to only those which are being used
        $validFooterLinks = [];
        foreach ( $footerlinks as $category => $links ) {
            $validFooterLinks[$category] = [];
            foreach ( $links as $link ) {
                if ( isset( $this->data[$link] ) && $this->data[$link] ) {
                    $validFooterLinks[$category][] = $link;
                }
            }
            if ( count( $validFooterLinks[$category] ) <= 0 ) {
                unset( $validFooterLinks[$category] );
            }
        }
 
        if ( $option == 'flat' && count( $validFooterLinks ) ) {
            // fold footerlinks into a single array using a bit of trickery
            $validFooterLinks = array_merge( ...array_values( $validFooterLinks ) );
        }
 
        return $validFooterLinks;
    }
 
    protected function getFooterIcons( $option = null ) {
        // Generate additional footer icons
        $footericons = $this->get( 'footericons' );
 
        if ( $option == 'icononly' ) {
            // Unset any icons which don't have an image
            foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
                foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
                    if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
                        unset( $footerIconsBlock[$footerIconKey] );
                    }
                }
                if ( $footerIconsBlock === [] ) {
                    unset( $footericons[$footerIconsKey] );
                }
            }
        } elseif ( $option == 'nocopyright' ) {
            unset( $footericons['copyright'] );
        }
 
        return $footericons;
    }
 
    protected function getFooter( $iconStyle = 'icononly', $linkStyle = 'flat' ) {
        $validFooterIcons = $this->getFooterIcons( $iconStyle );
        $validFooterLinks = $this->getFooterLinks( $linkStyle );
 
        $html = '';
 
        if ( count( $validFooterIcons ) + count( $validFooterLinks ) > 0 ) {
            $html .= Html::openElement( 'div', [
                'id' => 'footer-bottom',
                'class' => 'mw-footer',
                'role' => 'contentinfo',
                'lang' => $this->get( 'userlang' ),
                'dir' => $this->get( 'dir' )
            ] );
            $footerEnd = Html::closeElement( 'div' );
        } else {
            $footerEnd = '';
        }
        foreach ( $validFooterIcons as $blockName => $footerIcons ) {
            $html .= Html::openElement( 'div', [
                'id' => Sanitizer::escapeIdForAttribute( "f-{$blockName}ico" ),
                'class' => 'footer-icons'
            ] );
            foreach ( $footerIcons as $icon ) {
                $html .= $this->getSkin()->makeFooterIcon( $icon );
            }
            $html .= Html::closeElement( 'div' );
        }
        if ( count( $validFooterLinks ) > 0 ) {
            $html .= Html::openElement( 'ul', [ 'id' => 'f-list', 'class' => 'footer-places' ] );
            foreach ( $validFooterLinks as $aLink ) {
                $html .= Html::rawElement(
                    'li',
                    [ 'id' => Sanitizer::escapeIdForAttribute( $aLink ) ],
                    $this->get( $aLink )
                );
            }
            $html .= Html::closeElement( 'ul' );
        }
 
        $html .= $this->getClear() . $footerEnd;
 
        return $html;
    }
 
    protected function getClear() {
        return Html::element( 'div', [ 'class' => 'visualClear' ] );
    }
 
    public function getIndicators() {
        $out = "<div class=\"mw-indicators mw-body-content\">\n";
        foreach ( $this->data['indicators'] as $id => $content ) {
            $out .= Html::rawElement(
                'div',
                [
                    'id' => Sanitizer::escapeIdForAttribute( "mw-indicator-$id" ),
                    'class' => 'mw-indicator',
                ],
                $content
            ) . "\n";
        }
        $out .= "</div>\n";
        return $out;
    }
 
    protected function printTrail() {
        echo $this->getTrail();
    }
 
    public function getTrail() {
        return WrappedString::join( "\n", [
            MWDebug::getDebugHTML( $this->getSkin()->getContext() ),
            $this->get( 'bottomscripts' ),
            $this->get( 'reporttime' )
        ] );
    }
}