RangeChronologicalPager.php

Go to the documentation of this file.

<?php
use Wikimedia\Timestamp\TimestampException;

abstract class RangeChronologicalPager extends ReverseChronologicalPager {

    protected $rangeConds = [];

    public function getDateRangeCond( $startStamp, $endStamp ) {
        $this->rangeConds = [];

        try {
            if ( $startStamp !== '' ) {
                $startTimestamp = MWTimestamp::getInstance( $startStamp );
                $startOffset = $this->mDb->timestamp( $startTimestamp->getTimestamp() );
                $this->rangeConds[] = $this->mIndexField . '>=' . $this->mDb->addQuotes( $startOffset );
            }

            if ( $endStamp !== '' ) {
                $endTimestamp = MWTimestamp::getInstance( $endStamp );
                $endOffset = $this->mDb->timestamp( $endTimestamp->getTimestamp() );
                $this->rangeConds[] = $this->mIndexField . '<=' . $this->mDb->addQuotes( $endOffset );

                // populate existing variables for compatibility with parent
                $this->mYear = (int)$endTimestamp->format( 'Y' );
                $this->mMonth = (int)$endTimestamp->format( 'm' );
                $this->mDay = (int)$endTimestamp->format( 'd' );
                $this->mOffset = $endOffset;
            }
        } catch ( TimestampException $ex ) {
            return null;
        }

        return $this->rangeConds;
    }

    public function getDateCond( $year, $month, $day = -1 ) {
        // run through getDateRangeCond so rangeConds, mOffset, ... are set
        $legacyTimestamp = self::getOffsetDate( $year, $month, $day );
        // ReverseChronologicalPager uses strict inequality for the end date ('<'),
        // but this class uses '<=' and expects extending classes to handle modifying the end date.
        // Therefore, we need to subtract one second from the output of getOffsetDate to make it
        // work with the '<=' inequality used in this class.
        $legacyTimestamp->timestamp = $legacyTimestamp->timestamp->modify( '-1 second' );
        $this->getDateRangeCond( '', $legacyTimestamp->getTimestamp( TS_MW ) );
        return $this->mOffset;
    }

    protected function buildQueryInfo( $offset, $limit, $order ) {
        list( $tables, $fields, $conds, $fname, $options, $join_conds ) = parent::buildQueryInfo(
            $offset,
            $limit,
            $order
        );

        if ( $this->rangeConds ) {
            $conds = array_merge( $conds, $this->rangeConds );
        }

        return [ $tables, $fields, $conds, $fname, $options, $join_conds ];
    }
}