Diviner Arcanist Tech Docs TempFile

final class TempFile
Arcanist Technical Documentation ()

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

Creating a Temporary File

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

Configuration

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

Internals

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}.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function __construct($filename, $root_directory)

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.//

public function setPreserveFile($preserve)

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

public function __toString()

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.

public function __destruct()

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

Return

wild

Defined: src/filesystem/TempFile.php:17
Extends: Phobject

final class TempFileArcanist Technical Documentation ()

Tasks

Creating a Temporary File

Configuration

Internals

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function __construct($filename, $root_directory)

public function setPreserveFile($preserve)

public function __toString()

public function __destruct()

final class TempFile
Arcanist Technical Documentation ()

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited