CacheTime.php

Go to the documentation of this file.

<?php
class CacheTime {
    public $mUsedOptions;
 
    public $mVersion = Parser::VERSION;
 
    public $mCacheTime = '';
 
    public $mCacheExpiry = null;
 
    public $mCacheRevisionId = null;
 
    public function getCacheTime() {
        // NOTE: keep support for undocumented used of -1 to mean "not cacheable".
        if ( $this->mCacheTime === '' ) {
            $this->mCacheTime = MWTimestamp::now();
        }
        return $this->mCacheTime;
    }
 
    public function setCacheTime( $t ) {
        // NOTE: keep support for undocumented used of -1 to mean "not cacheable".
        if ( is_string( $t ) && $t !== '-1' ) {
            $t = MWTimestamp::convert( TS_MW, $t );
        }
 
        return wfSetVar( $this->mCacheTime, $t );
    }
 
    public function getCacheRevisionId() {
        return $this->mCacheRevisionId;
    }
 
    public function setCacheRevisionId( $id ) {
        $this->mCacheRevisionId = $id;
    }
 
    public function updateCacheExpiry( $seconds ) {
        $seconds = (int)$seconds;
 
        if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds ) {
            $this->mCacheExpiry = $seconds;
        }
    }
 
    public function getCacheExpiry() {
        global $wgParserCacheExpireTime;
 
        // NOTE: keep support for undocumented used of -1 to mean "not cacheable".
        if ( $this->mCacheTime !== '' && $this->mCacheTime < 0 ) {
            return 0;
        }
 
        $expire = $this->mCacheExpiry;
 
        if ( $expire === null ) {
            $expire = $wgParserCacheExpireTime;
        } else {
            $expire = min( $expire, $wgParserCacheExpireTime );
        }
 
        if ( $expire <= 0 ) {
            return 0; // not cacheable
        } else {
            return $expire;
        }
    }
 
    public function isCacheable() {
        return $this->getCacheExpiry() > 0;
    }
 
    public function expired( $touched ) {
        global $wgCacheEpoch;
 
        $expiry = MWTimestamp::convert( TS_MW, MWTimestamp::time() - $this->getCacheExpiry() );
 
        return !$this->isCacheable() // parser says it's not cacheable
            || $this->getCacheTime() < $touched
            || $this->getCacheTime() <= $wgCacheEpoch
            || $this->getCacheTime() < $expiry // expiry period has passed
            || !isset( $this->mVersion )
            || version_compare( $this->mVersion, Parser::VERSION, "lt" );
    }
 
    public function isDifferentRevision( $id ) {
        $cached = $this->getCacheRevisionId();
        return $cached !== null && $id !== $cached;
    }
}