TemplatesOnThisPageFormatter.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Linker\LinkTarget;

class TemplatesOnThisPageFormatter {

    private $context;

    private $linkRenderer;

    public function __construct( IContextSource $context, LinkRenderer $linkRenderer ) {
        $this->context = $context;
        $this->linkRenderer = $linkRenderer;
    }

    public function format( array $templates, $type = false, $more = null ) {
        if ( !$templates ) {
            // No templates
            return '';
        }

        # Do a batch existence check
        ( new LinkBatch( $templates ) )->execute();

        # Construct the HTML
        $outText = '<div class="mw-templatesUsedExplanation">';
        $count = count( $templates );
        if ( $type === 'preview' ) {
            $outText .= $this->context->msg( 'templatesusedpreview' )->numParams( $count )
                ->parseAsBlock();
        } elseif ( $type === 'section' ) {
            $outText .= $this->context->msg( 'templatesusedsection' )->numParams( $count )
                ->parseAsBlock();
        } else {
            $outText .= $this->context->msg( 'templatesused' )->numParams( $count )
                ->parseAsBlock();
        }
        $outText .= "</div><ul>\n";

        usort( $templates, 'Title::compare' );
        foreach ( $templates as $template ) {
            $outText .= $this->formatTemplate( $template );
        }

        if ( $more instanceof LinkTarget ) {
            $outText .= Html::rawElement( 'li', [], $this->linkRenderer->makeLink(
                $more, $this->context->msg( 'moredotdotdot' )->text() ) );
        } elseif ( $more ) {
            // Documented as should already be escaped
            $outText .= Html::rawElement( 'li', [], $more );
        }

        $outText .= '</ul>';
        return $outText;
    }

    private function formatTemplate( LinkTarget $target ) {
        // TODO Would be nice if we didn't have to use Title here
        $titleObj = Title::newFromLinkTarget( $target );
        $protected = $this->getRestrictionsText( $titleObj->getRestrictions( 'edit' ) );
        $editLink = $this->buildEditLink( $titleObj );
        return '<li>' . $this->linkRenderer->makeLink( $target )
            . $this->context->msg( 'word-separator' )->escaped()
            . $this->context->msg( 'parentheses' )->rawParams( $editLink )->escaped()
            . $this->context->msg( 'word-separator' )->escaped()
            . $protected . '</li>';
    }

    private function getRestrictionsText( array $restrictions ) {
        $protected = '';
        if ( !$restrictions ) {
            return $protected;
        }

        // Check backwards-compatible messages
        $msg = null;
        if ( $restrictions === [ 'sysop' ] ) {
            $msg = $this->context->msg( 'template-protected' );
        } elseif ( $restrictions === [ 'autoconfirmed' ] ) {
            $msg = $this->context->msg( 'template-semiprotected' );
        }
        if ( $msg && !$msg->isDisabled() ) {
            $protected = $msg->parse();
        } else {
            // Construct the message from restriction-level-*
            // e.g. restriction-level-sysop, restriction-level-autoconfirmed
            $msgs = [];
            foreach ( $restrictions as $r ) {
                $msgs[] = $this->context->msg( "restriction-level-$r" )->parse();
            }
            $protected = $this->context->msg( 'parentheses' )
                ->rawParams( $this->context->getLanguage()->commaList( $msgs ) )->escaped();
        }

        return $protected;
    }

    private function buildEditLink( Title $titleObj ) {
        if ( $titleObj->quickUserCan( 'edit', $this->context->getUser() ) ) {
            $linkMsg = 'editlink';
        } else {
            $linkMsg = 'viewsourcelink';
        }

        return $this->linkRenderer->makeLink(
            $titleObj,
            $this->context->msg( $linkMsg )->text(),
            [],
            [ 'action' => 'edit' ]
        );
    }

}