MWTimestamp.php

Go to the documentation of this file.

<?php
use Wikimedia\Timestamp\ConvertibleTimestamp;

class MWTimestamp extends ConvertibleTimestamp {
    public static function getInstance( $ts = false ) {
        return new static( $ts );
    }

    public function getHumanTimestamp(
        MWTimestamp $relativeTo = null, User $user = null, Language $lang = null
    ) {
        if ( $lang === null ) {
            $lang = RequestContext::getMain()->getLanguage();
        }

        return $lang->getHumanTimestamp( $this, $relativeTo, $user );
    }

    public function offsetForUser( User $user ) {
        global $wgLocalTZoffset;

        $option = $user->getOption( 'timecorrection' );
        $data = explode( '|', $option, 3 );

        // First handle the case of an actual timezone being specified.
        if ( $data[0] == 'ZoneInfo' ) {
            try {
                $tz = new DateTimeZone( $data[2] );
            } catch ( Exception $e ) {
                $tz = false;
            }

            if ( $tz ) {
                $this->timestamp->setTimezone( $tz );
                return new DateInterval( 'P0Y' );
            }

            $data[0] = 'Offset';
        }

        $diff = 0;
        // If $option is in fact a pipe-separated value, check the
        // first value.
        if ( $data[0] == 'System' ) {
            // First value is System, so use the system offset.
            if ( $wgLocalTZoffset !== null ) {
                $diff = $wgLocalTZoffset;
            }
        } elseif ( $data[0] == 'Offset' ) {
            // First value is Offset, so use the specified offset
            $diff = (int)$data[1];
        } else {
            // $option actually isn't a pipe separated value, but instead
            // a comma separated value. Isn't MediaWiki fun?
            $data = explode( ':', $option );
            if ( count( $data ) >= 2 ) {
                // Combination hours and minutes.
                $diff = abs( (int)$data[0] ) * 60 + (int)$data[1];
                if ( (int)$data[0] < 0 ) {
                    $diff *= -1;
                }
            } else {
                // Just hours.
                $diff = (int)$data[0] * 60;
            }
        }

        $interval = new DateInterval( 'PT' . abs( $diff ) . 'M' );
        if ( $diff < 1 ) {
            $interval->invert = 1;
        }

        $this->timestamp->add( $interval );
        return $interval;
    }

    public function getRelativeTimestamp(
        MWTimestamp $relativeTo = null,
        User $user = null,
        Language $lang = null,
        array $chosenIntervals = []
    ) {
        if ( $relativeTo === null ) {
            $relativeTo = new self;
        }
        if ( $user === null ) {
            $user = RequestContext::getMain()->getUser();
        }
        if ( $lang === null ) {
            $lang = RequestContext::getMain()->getLanguage();
        }

        $ts = '';
        $diff = $this->diff( $relativeTo );
        if ( Hooks::run(
            'GetRelativeTimestamp',
            [ &$ts, &$diff, $this, $relativeTo, $user, $lang ]
        ) ) {
            $seconds = ( ( ( $diff->days * 24 + $diff->h ) * 60 + $diff->i ) * 60 + $diff->s );
            $ts = wfMessage( 'ago', $lang->formatDuration( $seconds, $chosenIntervals ) )
                ->inLanguage( $lang )->text();
        }

        return $ts;
    }

    public function getTimezoneMessage() {
        $tzMsg = $this->format( 'T' );  // might vary on DST changeover!
        $key = 'timezone-' . strtolower( trim( $tzMsg ) );
        $msg = wfMessage( $key );
        if ( $msg->exists() ) {
            return $msg;
        }

        return new RawMessage( $tzMsg );
    }

    public static function getLocalInstance( $ts = false ) {
        global $wgLocaltimezone;
        $timestamp = new self( $ts );
        $timestamp->setTimezone( $wgLocaltimezone );
        return $timestamp;
    }
}