VectorTemplate.php

Go to the documentation of this file.

<?php
class VectorTemplate extends BaseTemplate {
 
    public function execute() {
        $this->data['namespace_urls'] = $this->data['content_navigation']['namespaces'];
        $this->data['view_urls'] = $this->data['content_navigation']['views'];
        $this->data['action_urls'] = $this->data['content_navigation']['actions'];
        $this->data['variant_urls'] = $this->data['content_navigation']['variants'];
 
        // Move the watch/unwatch star outside of the collapsed "actions" menu to the main "views" menu
        if ( $this->config->get( 'VectorUseIconWatch' ) ) {
            $mode = $this->getSkin()->getUser()->isWatched( $this->getSkin()->getRelevantTitle() )
                ? 'unwatch'
                : 'watch';
 
            if ( isset( $this->data['action_urls'][$mode] ) ) {
                $this->data['view_urls'][$mode] = $this->data['action_urls'][$mode];
                unset( $this->data['action_urls'][$mode] );
            }
        }
 
        // Naming conventions for Mustache parameters:
        // - Prefix "is" for boolean values.
        // - Prefix "msg-" for interface messages.
        // - Prefix "page-" for data relating to the current page (e.g. Title, WikiPage, or OutputPage).
        // - Prefix "html-" for raw HTML (in front of other keys, if applicable).
        // - Conditional values are null if absent.
        $params = [
            'html-headelement' => $this->get( 'headelement', '' ),
            'html-sitenotice' => $this->get( 'sitenotice', null ),
            'html-indicators' => $this->getIndicators(),
            'page-langcode' => $this->getSkin()->getTitle()->getPageViewLanguage()->getHtmlCode(),
            'page-isarticle' => (bool)$this->data['isarticle'],
 
            // Remember that the string '0' is a valid title.
            // From OutputPage::getPageTitle, via ::setPageTitle().
            'html-title' => $this->get( 'title', '' ),
 
            'html-prebodyhtml' => $this->get( 'prebodyhtml', '' ),
            'msg-tagline' => $this->getMsg( 'tagline' )->text(),
            // TODO: mediawiki/SkinTemplate should expose langCode and langDir properly.
            'html-userlangattributes' => $this->get( 'userlangattributes', '' ),
            // From OutputPage::getSubtitle()
            'html-subtitle' => $this->get( 'subtitle', '' ),
 
            // TODO: Use directly Skin::getUndeleteLink() directly.
            // Always returns string, cast to null if empty.
            'html-undelete' => $this->get( 'undelete', null ) ?: null,
 
            // From Skin::getNewtalks(). Always returns string, cast to null if empty.
            'html-newtalk' => $this->get( 'newtalk', '' ) ?: null,
 
            'msg-jumptonavigation' => $this->getMsg( 'vector-jumptonavigation' )->text(),
            'msg-jumptosearch' => $this->getMsg( 'vector-jumptosearch' )->text(),
 
            // Result of OutputPage::addHTML calls
            'html-bodycontent' => $this->get( 'bodycontent' ),
 
            'html-printfooter' => $this->get( 'printfooter', null ),
            'html-catlinks' => $this->get( 'catlinks', '' ),
            'html-dataAfterContent' => $this->get( 'dataAfterContent', '' ),
            // From MWDebug::getHTMLDebugLog (when $wgShowDebug is enabled)
            'html-debuglog' => $this->get( 'debughtml', '' ),
            // From BaseTemplate::getTrail (handles bottom JavaScript)
            'html-printtail' => $this->getTrail(),
        ];
 
        // TODO: Convert the rest to Mustache
        ob_start();
        ?>
        <div id="mw-navigation">
            <h2><?php $this->msg( 'navigation-heading' ) ?></h2>
            <div id="mw-head">
                <?php $this->renderNavigation( [ 'PERSONAL' ] ); ?>
                <div id="left-navigation">
                    <?php $this->renderNavigation( [ 'NAMESPACES', 'VARIANTS' ] ); ?>
                </div>
                <div id="right-navigation">
                    <?php $this->renderNavigation( [ 'VIEWS', 'ACTIONS', 'SEARCH' ] ); ?>
                </div>
            </div>
            <div id="mw-panel">
                <div id="p-logo" role="banner"><a class="mw-wiki-logo" href="<?php
                    echo htmlspecialchars( $this->data['nav_urls']['mainpage']['href'] )
                    ?>"<?php
                    echo Xml::expandAttributes( Linker::tooltipAndAccesskeyAttribs( 'p-logo' ) )
                    ?>></a></div>
                <?php $this->renderPortals( $this->data['sidebar'] ); ?>
            </div>
        </div>
        <?php Hooks::run( 'VectorBeforeFooter' ); ?>
        <div id="footer" role="contentinfo"<?php $this->html( 'userlangattributes' ) ?>>
            <?php
            foreach ( $this->getFooterLinks() as $category => $links ) {
            ?>
            <ul id="footer-<?php echo $category ?>">
                <?php
                foreach ( $links as $link ) {
                ?>
                <li id="footer-<?php echo $category ?>-<?php echo $link ?>"><?php $this->html( $link ) ?></li>
                <?php
                }
                ?>
            </ul>
            <?php
            }
            ?>
            <?php $footericons = $this->getFooterIcons( 'icononly' );
            if ( count( $footericons ) > 0 ) {
                ?>
                <ul id="footer-icons" class="noprint">
                    <?php
                    foreach ( $footericons as $blockName => $footerIcons ) {
                    ?>
                    <li id="footer-<?php echo htmlspecialchars( $blockName ); ?>ico">
                        <?php
                        foreach ( $footerIcons as $icon ) {
                            echo $this->getSkin()->makeFooterIcon( $icon );
                        }
                        ?>
                    </li>
                    <?php
                    }
                    ?>
                </ul>
            <?php
            }
            ?>
            <div style="clear: both;"></div>
        </div>
        <?php
        $params['html-unported'] = ob_get_contents();
        ob_end_clean();
 
        // Prepare and output the HTML response
        $templates = new TemplateParser( __DIR__ . '/templates' );
        echo $templates->processTemplate( 'index', $params );
    }
 
    protected function renderPortals( array $portals ) {
        // Force the rendering of the following portals
        if ( !isset( $portals['TOOLBOX'] ) ) {
            $portals['TOOLBOX'] = true;
        }
        if ( !isset( $portals['LANGUAGES'] ) ) {
            $portals['LANGUAGES'] = true;
        }
        // Render portals
        foreach ( $portals as $name => $content ) {
            if ( $content === false ) {
                continue;
            }
 
            // Numeric strings gets an integer when set as key, cast back - T73639
            $name = (string)$name;
 
            switch ( $name ) {
                case 'SEARCH':
                    break;
                case 'TOOLBOX':
                    $this->renderPortal( 'tb', $this->getToolbox(), 'toolbox', 'SkinTemplateToolboxEnd' );
                    Hooks::run( 'VectorAfterToolbox' );
                    break;
                case 'LANGUAGES':
                    if ( $this->data['language_urls'] !== false ) {
                        $this->renderPortal( 'lang', $this->data['language_urls'], 'otherlanguages' );
                    }
                    break;
                default:
                    $this->renderPortal( $name, $content );
                    break;
            }
        }
    }
 
    protected function renderPortal( $name, $content, $msg = null, $hook = null ) {
        if ( $msg === null ) {
            $msg = $name;
        }
        $msgObj = $this->getMsg( $msg );
        $labelId = Sanitizer::escapeIdForAttribute( "p-$name-label" );
        ?>
        <div class="portal" role="navigation" id="<?php
        echo htmlspecialchars( Sanitizer::escapeIdForAttribute( "p-$name" ) )
        ?>"<?php
        echo Linker::tooltip( 'p-' . $name )
        ?> aria-labelledby="<?php echo htmlspecialchars( $labelId ) ?>">
            <h3<?php $this->html( 'userlangattributes' ) ?> id="<?php echo htmlspecialchars( $labelId )
                ?>"><?php
                echo htmlspecialchars( $msgObj->exists() ? $msgObj->text() : $msg );
                ?></h3>
            <div class="body">
                <?php
                if ( is_array( $content ) ) {
                ?>
                <ul>
                    <?php
                    foreach ( $content as $key => $val ) {
                        echo $this->makeListItem( $key, $val );
                    }
                    if ( $hook !== null ) {
                        // Avoid PHP 7.1 warning
                        $skin = $this;
                        Hooks::run( $hook, [ &$skin, true ] );
                    }
                    ?>
                </ul>
                <?php
                } else {
                    // Allow raw HTML block to be defined by extensions
                    echo $content;
                }
 
                $this->renderAfterPortlet( $name );
                ?>
            </div>
        </div>
    <?php
    }
 
    protected function renderNavigation( array $elements ) {
        // Render elements
        foreach ( $elements as $name => $element ) {
            switch ( $element ) {
                case 'NAMESPACES':
                    ?>
                    <div id="p-namespaces" role="navigation" class="vectorTabs<?php
                    if ( count( $this->data['namespace_urls'] ) == 0 ) {
                        echo ' emptyPortlet';
                    }
                    ?>" aria-labelledby="p-namespaces-label">
                        <h3 id="p-namespaces-label"><?php $this->msg( 'namespaces' ) ?></h3>
                        <ul<?php $this->html( 'userlangattributes' ) ?>>
                            <?php
                            foreach ( $this->data['namespace_urls'] as $key => $item ) {
                                echo $this->makeListItem( $key, $item, [
                                    'vector-wrap' => true,
                                ] );
                            }
                            ?>
                        </ul>
                    </div>
                    <?php
                    break;
                case 'VARIANTS':
                    ?>
                    <div id="p-variants" role="navigation" class="vectorMenu<?php
                    if ( count( $this->data['variant_urls'] ) == 0 ) {
                        echo ' emptyPortlet';
                    }
                    ?>" aria-labelledby="p-variants-label">
                        <?php
                        // Replace the label with the name of currently chosen variant, if any
                        $variantLabel = $this->getMsg( 'variants' )->text();
                        foreach ( $this->data['variant_urls'] as $item ) {
                            if ( isset( $item['class'] ) && stripos( $item['class'], 'selected' ) !== false ) {
                                $variantLabel = $item['text'];
                                break;
                            }
                        }
                        ?>
                        <input type="checkbox" class="vectorMenuCheckbox" aria-labelledby="p-variants-label" />
                        <h3 id="p-variants-label">
                            <span><?php echo htmlspecialchars( $variantLabel ) ?></span>
                        </h3>
                        <ul class="menu">
                            <?php
                            foreach ( $this->data['variant_urls'] as $key => $item ) {
                                echo $this->makeListItem( $key, $item );
                            }
                            ?>
                        </ul>
                    </div>
                    <?php
                    break;
                case 'VIEWS':
                    ?>
                    <div id="p-views" role="navigation" class="vectorTabs<?php
                    if ( count( $this->data['view_urls'] ) == 0 ) {
                        echo ' emptyPortlet';
                    }
                    ?>" aria-labelledby="p-views-label">
                        <h3 id="p-views-label"><?php $this->msg( 'views' ) ?></h3>
                        <ul<?php $this->html( 'userlangattributes' ) ?>>
                            <?php
                            foreach ( $this->data['view_urls'] as $key => $item ) {
                                echo $this->makeListItem( $key, $item, [
                                    'vector-wrap' => true,
                                    'vector-collapsible' => true,
                                ] );
                            }
                            ?>
                        </ul>
                    </div>
                    <?php
                    break;
                case 'ACTIONS':
                    ?>
                    <div id="p-cactions" role="navigation" class="vectorMenu<?php
                    if ( count( $this->data['action_urls'] ) == 0 ) {
                        echo ' emptyPortlet';
                    }
                    ?>" aria-labelledby="p-cactions-label">
                        <input type="checkbox" class="vectorMenuCheckbox" aria-labelledby="p-cactions-label" />
                        <h3 id="p-cactions-label"><span><?php
                            $this->msg( 'vector-more-actions' )
                        ?></span></h3>
                        <ul class="menu"<?php $this->html( 'userlangattributes' ) ?>>
                            <?php
                            foreach ( $this->data['action_urls'] as $key => $item ) {
                                echo $this->makeListItem( $key, $item );
                            }
                            ?>
                        </ul>
                    </div>
                    <?php
                    break;
                case 'PERSONAL':
                    ?>
                    <div id="p-personal" role="navigation"<?php
                    if ( count( $this->data['personal_urls'] ) == 0 ) {
                        echo ' class="emptyPortlet"';
                    }
                    ?> aria-labelledby="p-personal-label">
                        <h3 id="p-personal-label"><?php $this->msg( 'personaltools' ) ?></h3>
                        <ul<?php $this->html( 'userlangattributes' ) ?>>
                            <?php
                            $notLoggedIn = '';
 
                            if ( !$this->getSkin()->getUser()->isLoggedIn() &&
                                User::groupHasPermission( '*', 'edit' )
                            ) {
                                $notLoggedIn =
                                    Html::element( 'li',
                                        [ 'id' => 'pt-anonuserpage' ],
                                        $this->getMsg( 'notloggedin' )->text()
                                    );
                            }
 
                            $personalTools = $this->getPersonalTools();
 
                            $langSelector = '';
                            if ( array_key_exists( 'uls', $personalTools ) ) {
                                $langSelector = $this->makeListItem( 'uls', $personalTools[ 'uls' ] );
                                unset( $personalTools[ 'uls' ] );
                            }
 
                            echo $langSelector;
                            echo $notLoggedIn;
                            foreach ( $personalTools as $key => $item ) {
                                echo $this->makeListItem( $key, $item );
                            }
                            ?>
                        </ul>
                    </div>
                    <?php
                    break;
                case 'SEARCH':
                    ?>
                    <div id="p-search" role="search">
                        <h3<?php $this->html( 'userlangattributes' ) ?>>
                            <label for="searchInput"><?php $this->msg( 'search' ) ?></label>
                        </h3>
                        <form action="<?php $this->text( 'wgScript' ) ?>" id="searchform">
                            <div<?php echo $this->config->get( 'VectorUseSimpleSearch' ) ? ' id="simpleSearch"' : '' ?>>
                                <?php
                                echo $this->makeSearchInput( [ 'id' => 'searchInput' ] );
                                echo Html::hidden( 'title', $this->get( 'searchtitle' ) );
                                /* We construct two buttons (for 'go' and 'fulltext' search modes),
                                 * but only one will be visible and actionable at a time (they are
                                 * overlaid on top of each other in CSS).
                                 * * Browsers will use the 'fulltext' one by default (as it's the
                                 *   first in tree-order), which is desirable when they are unable
                                 *   to show search suggestions (either due to being broken or
                                 *   having JavaScript turned off).
                                 * * The mediawiki.searchSuggest module, after doing tests for the
                                 *   broken browsers, removes the 'fulltext' button and handles
                                 *   'fulltext' search itself; this will reveal the 'go' button and
                                 *   cause it to be used.
                                 */
                                echo $this->makeSearchButton(
                                    'fulltext',
                                    [ 'id' => 'mw-searchButton', 'class' => 'searchButton mw-fallbackSearchButton' ]
                                );
                                echo $this->makeSearchButton(
                                    'go',
                                    [ 'id' => 'searchButton', 'class' => 'searchButton' ]
                                );
                                ?>
                            </div>
                        </form>
                    </div>
                    <?php
 
                    break;
            }
        }
    }
 
    public function makeLink( $key, $item, $options = [] ) {
        $html = parent::makeLink( $key, $item, $options );
        // Add an extra wrapper because our CSS is weird
        if ( isset( $options['vector-wrap'] ) && $options['vector-wrap'] ) {
            $html = Html::rawElement( 'span', [], $html );
        }
        return $html;
    }
 
    public function makeListItem( $key, $item, $options = [] ) {
        // For fancy styling of watch/unwatch star
        if (
            $this->config->get( 'VectorUseIconWatch' )
            && ( $key === 'watch' || $key === 'unwatch' )
        ) {
            $item['class'] = rtrim( 'icon ' . $item['class'], ' ' );
            $item['primary'] = true;
        }
 
        // Add CSS class 'collapsible' to links which are not marked as "primary"
        if (
            isset( $options['vector-collapsible'] ) && $options['vector-collapsible'] ) {
            $item['class'] = rtrim( 'collapsible ' . $item['class'], ' ' );
        }
 
        // We don't use this, prevent it from popping up in HTML output
        unset( $item['redundant'] );
 
        return parent::makeListItem( $key, $item, $options );
    }
}