PrevNextNavigationRenderer.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Navigation;
 
use Html;
use MessageLocalizer;
use Title;
 
class PrevNextNavigationRenderer {
 
    private $messageLocalizer;
 
    public function __construct( MessageLocalizer $messageLocalizer ) {
        $this->messageLocalizer = $messageLocalizer;
    }
 
    public function buildPrevNextNavigation(
        Title $title,
        $offset,
        $limit,
        array $query = [],
        $atend = false
    ) {
        # Make 'previous' link
        $prev = $this->messageLocalizer->msg( 'prevn' )
            ->page( $title )
            ->numParams( $limit )
            ->text();
 
        if ( $offset > 0 ) {
            $plink = $this->numLink(
                $title,
                max( $offset - $limit, 0 ),
                $limit,
                $query,
                $prev,
                'prevn-title',
                'mw-prevlink'
            );
        } else {
            $plink = htmlspecialchars( $prev );
        }
 
        # Make 'next' link
        $next = $this->messageLocalizer->msg( 'nextn' )
            ->page( $title )
            ->numParams( $limit )
            ->text();
        if ( $atend ) {
            $nlink = htmlspecialchars( $next );
        } else {
            $nlink = $this->numLink(
                $title,
                $offset + $limit,
                $limit,
                $query,
                $next,
                'nextn-title',
                'mw-nextlink'
            );
        }
 
        # Make links to set number of items per page
        $numLinks = [];
        // @phan-suppress-next-next-line PhanUndeclaredMethod
        // @fixme MessageLocalizer doesn't have a getLanguage() method!
        $lang = $this->messageLocalizer->getLanguage();
        foreach ( [ 20, 50, 100, 250, 500 ] as $num ) {
            $numLinks[] = $this->numLink(
                $title,
                $offset,
                $num,
                $query,
                $lang->formatNum( $num ),
                'shown-title',
                'mw-numlink'
            );
        }
 
        return $this->messageLocalizer->msg( 'viewprevnext' )
            ->page( $title )
            ->rawParams( $plink, $nlink, $lang->pipeList( $numLinks ) )
            ->escaped();
    }
 
    private function numLink(
        Title $title,
        $offset,
        $limit,
        array $query,
        $link,
        $tooltipMsg,
        $class
    ) {
        $query = [ 'limit' => $limit, 'offset' => $offset ] + $query;
        $tooltip = $this->messageLocalizer->msg( $tooltipMsg )
            ->page( $title )
            ->numParams( $limit )
            ->text();
 
        return Html::element(
            'a',
            [
                'href' => $title->getLocalURL( $query ),
                'title' => $tooltip,
                'class' => $class,
            ],
            $link
        );
    }
 
}