RangeChronologicalPager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Pager;
 
use MediaWiki\Utils\MWTimestamp;
use Wikimedia\Timestamp\TimestampException;
 
abstract class RangeChronologicalPager extends ReverseChronologicalPager {
 
    protected $rangeConds;
 
    protected $startOffset;
 
    public function getDateRangeCond( $startTime, $endTime ) {
        // Construct the conds array for compatibility with callers and derived classes
        $this->rangeConds = [];
 
        try {
            if ( $startTime !== '' ) {
                $startTimestamp = MWTimestamp::getInstance( $startTime );
                $this->startOffset = $this->mDb->timestamp( $startTimestamp->getTimestamp() );
                $this->rangeConds[] = $this->mDb->buildComparison( '>=',
                    [ $this->getTimestampField() => $this->startOffset ] );
            }
 
            if ( $endTime !== '' ) {
                $endTimestamp = MWTimestamp::getInstance( $endTime );
                // Turned to use '<' for consistency with the parent class,
                // add one second for compatibility with existing use cases
                $endTimestamp->timestamp = $endTimestamp->timestamp->modify( '+1 second' );
                $this->endOffset = $this->mDb->timestamp( $endTimestamp->getTimestamp() );
                $this->rangeConds[] = $this->mDb->buildComparison( '<',
                    [ $this->getTimestampField() => $this->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' );
            }
        } catch ( TimestampException ) {
            return null;
        }
 
        return $this->rangeConds;
    }
 
    public function getRangeOffsets() {
        return [ $this->endOffset, $this->startOffset ];
    }
 
    protected function buildQueryInfo( $offset, $limit, $order ) {
        [ $tables, $fields, $conds, $fname, $options, $join_conds ] = parent::buildQueryInfo(
            $offset,
            $limit,
            $order
        );
        // End of the range has been added by ReverseChronologicalPager
        if ( $this->startOffset ) {
            $conds[] = $this->mDb->expr( $this->getTimestampField(), '>=', $this->startOffset );
        } elseif ( $this->rangeConds ) {
            // Keep compatibility with some derived classes, T325034
            $conds = array_merge( $conds, $this->rangeConds );
        }
 
        return [ $tables, $fields, $conds, $fname, $options, $join_conds ];
    }
}
 
class_alias( RangeChronologicalPager::class, 'RangeChronologicalPager' );