ReverseChronologicalPager.php

Go to the documentation of this file.

<?php
use Wikimedia\Timestamp\TimestampException;
 
abstract class ReverseChronologicalPager extends IndexPager {
    public $mDefaultDirection = IndexPager::DIR_DESCENDING;
    public $mYear;
    public $mMonth;
    public $mDay;
 
    public function getNavigationBar() {
        if ( !$this->isNavigationBarShown() ) {
            return '';
        }
 
        if ( isset( $this->mNavigationBar ) ) {
            return $this->mNavigationBar;
        }
 
        $linkTexts = [
            'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(),
            'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(),
            'first' => $this->msg( 'histlast' )->escaped(),
            'last' => $this->msg( 'histfirst' )->escaped()
        ];
 
        $pagingLinks = $this->getPagingLinks( $linkTexts );
        $limitLinks = $this->getLimitLinks();
        $limits = $this->getLanguage()->pipeList( $limitLinks );
        $firstLastLinks = $this->msg( 'parentheses' )->rawParams( "{$pagingLinks['first']}" .
            $this->msg( 'pipe-separator' )->escaped() .
            "{$pagingLinks['last']}" )->escaped();
 
        $this->mNavigationBar = $firstLastLinks . ' ' .
            $this->msg( 'viewprevnext' )->rawParams(
                $pagingLinks['prev'], $pagingLinks['next'], $limits )->escaped();
 
        return $this->mNavigationBar;
    }
 
    public function getDateCond( $year, $month, $day = -1 ) {
        $year = (int)$year;
        $month = (int)$month;
        $day = (int)$day;
 
        // Basic validity checks for year and month
        // If year and month are invalid, don't update the mOffset
        if ( $year <= 0 && ( $month <= 0 || $month >= 13 ) ) {
            return null;
        }
 
        $timestamp = self::getOffsetDate( $year, $month, $day );
 
        try {
            // The timestamp used for DB queries is at midnight of the *next* day after the selected date.
            $selectedDate = new DateTime( $timestamp->getTimestamp( TS_ISO_8601 ) );
            $selectedDate = $selectedDate->modify( '-1 day' );
 
            $this->mYear = (int)$selectedDate->format( 'Y' );
            $this->mMonth = (int)$selectedDate->format( 'm' );
            $this->mDay = (int)$selectedDate->format( 'd' );
            $this->mOffset = $this->mDb->timestamp( $timestamp->getTimestamp() );
        } catch ( TimestampException $e ) {
            // Invalid user provided timestamp (T149257)
            return null;
        }
 
        return $this->mOffset;
    }
 
    public static function getOffsetDate( $year, $month, $day = -1 ) {
        // Given an optional year, month, and day, we need to generate a timestamp
        // to use as "WHERE rev_timestamp <= result"
        // Examples: year = 2006      equals < 20070101 (+000000)
        // year=2005, month=1         equals < 20050201
        // year=2005, month=12        equals < 20060101
        // year=2005, month=12, day=5 equals < 20051206
        if ( $year <= 0 ) {
            // If no year given, assume the current one
            $timestamp = MWTimestamp::getInstance();
            $year = $timestamp->format( 'Y' );
            // If this month hasn't happened yet this year, go back to last year's month
            if ( $month > $timestamp->format( 'n' ) ) {
                $year--;
            }
        }
 
        if ( $month && $month > 0 && $month < 13 ) {
            // Day validity check after we have month and year checked
            $day = checkdate( $month, $day, $year ) ? $day : false;
 
            if ( $day && $day > 0 ) {
                // If we have a day, we want up to the day immediately afterward
                $day++;
 
                // Did we overflow the current month?
                if ( !checkdate( $month, $day, $year ) ) {
                    $day = 1;
                    $month++;
                }
            } else {
                // If no day, assume beginning of next month
                $day = 1;
                $month++;
            }
 
            // Did we overflow the current year?
            if ( $month > 12 ) {
                $month = 1;
                $year++;
            }
 
        } else {
            // No month implies we want up to the end of the year in question
            $month = 1;
            $day = 1;
            $year++;
        }
 
        // Y2K38 bug
        if ( $year > 2032 ) {
            $year = 2032;
        }
 
        $ymd = (int)sprintf( "%04d%02d%02d", $year, $month, $day );
 
        if ( $ymd > 20320101 ) {
            $ymd = 20320101;
        }
 
        return MWTimestamp::getInstance( "{$ymd}000000" );
    }
}