final class TempFile
libphutil Technical Documentation (Filesystem)

Simple wrapper to create a temporary file and guarantee it will be deleted on object destruction. Used like a string to path:

$temp = new TempFile();
Filesystem::writeFile($temp, 'Hello World');
echo "Wrote data to path: ".$temp;

Throws Filesystem exceptions for errors.

Tasks

public function __construct($filename, $root_directory) — Create a new temporary file.

public function setPreserveFile($preserve) — Normally, the file is deleted when this object passes out of scope. You can set it to be preserved instead.

public function __toString() — Get the path to the temporary file. Normally you can just use the object in a string context.
public function __destruct() — When the object is destroyed, it destroys the temporary file. You can change this behavior with @{method:setPreserveFile}.

Create a new temporary file.

Parameters

string?	$filename	Filename hint. This is useful if you intend to edit the file with an interactive editor, so the user's editor shows "commit-message" instead of "p3810hf-1z9b89bas".
string?	$root_directory	Root directory to hold the file. If omitted, the system temporary directory (often "/tmp") will be used by default.

Return

this	//Implicit.//

Normally, the file is deleted when this object passes out of scope. You can set it to be preserved instead.

Parameters

bool

$preserve

True to preserve the file after object destruction.

Return

this

Get the path to the temporary file. Normally you can just use the object in a string context.

Return

string

Absolute path to the temporary file.

When the object is destroyed, it destroys the temporary file. You can change this behavior with setPreserveFile().

Return

wild