CacheTime.php

Go to the documentation of this file.

<?php
class CacheTime {

        var     $mVersion = Parser::VERSION,  # Compatibility check
                $mCacheTime = '',             # Time when this object was generated, or -1 for uncacheable. Used in ParserCache.
                $mCacheExpiry = null,         # Seconds after which the object should expire, use 0 for uncachable. Used in ParserCache.
                $mContainsOldMagic;           # Boolean variable indicating if the input contained variables like {{CURRENTDAY}}

        function getCacheTime()              { return $this->mCacheTime; }

        function containsOldMagic()          { return $this->mContainsOldMagic; }
        function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); }

        function setCacheTime( $t )          { return wfSetVar( $this->mCacheTime, $t ); }

        function updateCacheExpiry( $seconds ) {
                $seconds = (int)$seconds;

                if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds ) {
                        $this->mCacheExpiry = $seconds;
                }

                // hack: set old-style marker for uncacheable entries.
                if ( $this->mCacheExpiry !== null && $this->mCacheExpiry <= 0 ) {
                        $this->mCacheTime = -1;
                }
        }

        function getCacheExpiry() {
                global $wgParserCacheExpireTime;

                if ( $this->mCacheTime < 0 ) {
                        return 0;
                } // old-style marker for "not cachable"

                $expire = $this->mCacheExpiry;

                if ( $expire === null ) {
                        $expire = $wgParserCacheExpireTime;
                } else {
                        $expire = min( $expire, $wgParserCacheExpireTime );
                }

                if( $this->containsOldMagic() ) { //compatibility hack
                        $expire = min( $expire, 3600 ); # 1 hour
                }

                if ( $expire <= 0 ) {
                        return 0; // not cachable
                } else {
                        return $expire;
                }
        }

        function isCacheable() {
                return $this->getCacheExpiry() > 0;
        }

        public function expired( $touched ) {
                global $wgCacheEpoch;
                return !$this->isCacheable() || // parser says it's uncacheable
                        $this->getCacheTime() < $touched ||
                        $this->getCacheTime() <= $wgCacheEpoch ||
                        $this->getCacheTime() < wfTimestamp( TS_MW, time() - $this->getCacheExpiry() ) || // expiry period has passed
                        !isset( $this->mVersion ) ||
                        version_compare( $this->mVersion, Parser::VERSION, "lt" );
        }

}