Diviner Arcanist Tech Docs PhutilSystem

final class PhutilSystem
Arcanist Technical Documentation ()

Interact with the operating system.

Tasks

Interacting with Standard I/O

public static function getStdinHandle()
public static function getStdoutHandle()
public static function getStderrHandle()
public static function writeStderr($message)
private static function getStdioHandle($ref)

Interacting with System Memory

public static function getSystemMemoryInformation() — Get information about total and free memory on the system.
public static function parseMemInfo($data) — Parse the output of `/proc/meminfo`.
public static function parseVMStat($data) — Parse the output of `vm_stat`.

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 static function getStdinHandle()

This method is not documented.

Return

wild

public static function getStdoutHandle()

This method is not documented.

Return

wild

public static function getStderrHandle()

This method is not documented.

Return

wild

public static function writeStderr($message)

This method is not documented.

Parameters

$message

Return

wild

private static function getStdioHandle($ref)

This method is not documented.

Parameters

$ref

Return

wild

public static function getSystemMemoryInformation()

Get information about total and free memory on the system.

Because "free memory" is a murky concept, the interpretation of the values returned from this method will vary from system to system and the numbers themselves may be only roughly accurate.

Return

map<string, wild>

Dictionary of memory information.

public static function parseMemInfo($data)

Parse the output of /proc/meminfo.

See getSystemMemoryInformation(). This method is used to get memory information on Linux.

Parameters

string

$data

Raw `/proc/meminfo`.

Return

map<string, wild>

Parsed memory information.

public static function parseVMStat($data)

Parse the output of vm_stat.

See getSystemMemoryInformation(). This method is used to get memory information on Mac OS X.

Parameters

string

$data

Raw `vm_stat` output.

Return

map<string, wild>

Parsed memory information.

Defined: src/utils/PhutilSystem.php:9
Extends: Phobject

final class PhutilSystemArcanist Technical Documentation ()

Tasks

Interacting with Standard I/O

Interacting with System Memory

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 static function getStdinHandle()

public static function getStdoutHandle()

public static function getStderrHandle()

public static function writeStderr($message)

private static function getStdioHandle($ref)

public static function getSystemMemoryInformation()

public static function parseMemInfo($data)

public static function parseVMStat($data)

final class PhutilSystem
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