TempFSFile.php

Go to the documentation of this file.

<?php
class TempFSFile extends FSFile {
    protected $canDelete = false; // bool; garbage collect the temp file

    protected static $instances = array();

    public static function factory( $prefix, $extension = '' ) {
        wfProfileIn( __METHOD__ );
        $base = wfTempDir() . '/' . $prefix . wfRandomString( 12 );
        $ext = ( $extension != '' ) ? ".{$extension}" : "";
        for ( $attempt = 1; true; $attempt++ ) {
            $path = "{$base}-{$attempt}{$ext}";
            wfSuppressWarnings();
            $newFileHandle = fopen( $path, 'x' );
            wfRestoreWarnings();
            if ( $newFileHandle ) {
                fclose( $newFileHandle );
                break; // got it
            }
            if ( $attempt >= 5 ) {
                wfProfileOut( __METHOD__ );
                return null; // give up
            }
        }
        $tmpFile = new self( $path );
        $tmpFile->canDelete = true; // safely instantiated
        wfProfileOut( __METHOD__ );
        return $tmpFile;
    }

    public function purge() {
        $this->canDelete = false; // done
        wfSuppressWarnings();
        $ok = unlink( $this->path );
        wfRestoreWarnings();
        return $ok;
    }

    public function bind( $object ) {
        if ( is_object( $object ) ) {
            if ( !isset( $object->tempFSFileReferences ) ) {
                // Init first since $object might use __get() and return only a copy variable
                $object->tempFSFileReferences = array();
            }
            $object->tempFSFileReferences[] = $this;
        }
        return $this;
    }

    public function preserve() {
        $this->canDelete = false;
        return $this;
    }

    public function autocollect() {
        $this->canDelete = true;
        return $this;
    }

    function __destruct() {
        if ( $this->canDelete ) {
            wfSuppressWarnings();
            unlink( $this->path );
            wfRestoreWarnings();
        }
    }
}