MWTimestamp.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Utils;
 
use DateInterval;
use MediaWiki\Context\RequestContext;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Language\Language;
use MediaWiki\Language\RawMessage;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\User\User;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserTimeCorrection;
use Wikimedia\Timestamp\ConvertibleTimestamp;
 
class MWTimestamp extends ConvertibleTimestamp {
    public static function getInstance( $ts = false ) {
        return new static( $ts );
    }
 
    public function offsetForUser( UserIdentity $user ) {
        $option = MediaWikiServices::getInstance()->getUserOptionsLookup()->getOption( $user, 'timecorrection' );
 
        $value = new UserTimeCorrection(
            $option,
            $this->timestamp,
            MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::LocalTZoffset )
        );
        $tz = $value->getTimeZone();
        if ( $tz ) {
            $this->timestamp->setTimezone( $tz );
            return new DateInterval( 'P0Y' );
        }
        $interval = $value->getTimeOffsetInterval();
        $this->timestamp->add( $interval );
        return $interval;
    }
 
    public function getRelativeTimestamp(
        ?MWTimestamp $relativeTo = null,
        ?UserIdentity $user = null,
        ?Language $lang = null,
        array $chosenIntervals = []
    ) {
        $relativeTo ??= new self();
        $user ??= RequestContext::getMain()->getUser();
        $lang ??= RequestContext::getMain()->getLanguage();
 
        $ts = '';
        $diff = $this->diff( $relativeTo );
 
        $user = User::newFromIdentity( $user ); // For compatibility with the hook signature
        if ( ( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )->onGetRelativeTimestamp(
            $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 ) {
        $localtimezone = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::Localtimezone );
        $timestamp = new self( $ts );
        $timestamp->setTimezone( $localtimezone );
        return $timestamp;
    }
}
 
class_alias( MWTimestamp::class, 'MWTimestamp' );