FileDependency.php

Go to the documentation of this file.

<?php
use Wikimedia\AtEase\AtEase;
 
class FileDependency extends CacheDependency {
    private $filename;
    private $timestamp;
 
    public function __construct( $filename, $timestamp = null ) {
        $this->filename = $filename;
        $this->timestamp = $timestamp;
    }
 
    public function __sleep() {
        $this->loadDependencyValues();
 
        return [ 'filename', 'timestamp' ];
    }
 
    public function loadDependencyValues() {
        if ( $this->timestamp === null ) {
            AtEase::suppressWarnings();
            # Dependency on a non-existent file stores "false"
            # This is a valid concept!
            $this->timestamp = filemtime( $this->filename );
            AtEase::restoreWarnings();
        }
    }
 
    public function isExpired() {
        AtEase::suppressWarnings();
        $lastmod = filemtime( $this->filename );
        AtEase::restoreWarnings();
        if ( $lastmod === false ) {
            if ( $this->timestamp === false ) {
                # Still nonexistent
                return false;
            }
 
            # Deleted
            wfDebug( "Dependency triggered: {$this->filename} deleted." );
 
            return true;
        }
 
        if ( $lastmod > $this->timestamp ) {
            # Modified or created
            wfDebug( "Dependency triggered: {$this->filename} changed." );
 
            return true;
        }
 
        # Not modified
        return false;
    }
}