Diviner Arcanist Tech Docs PhutilReadableSerializer

final class PhutilReadableSerializer
Arcanist Technical Documentation ()

Serialize PHP values and objects into a human-readable format, useful for displaying errors.

Tasks

Printing PHP Values

public static function printableValue($value) — Given a value, makes the best attempt at returning a string representation of that value suitable for printing. This method returns a //complete// representation of the value; use @{method:printShort} or @{method:printShallow} to summarize values.
public static function printShort($value) — Print a concise, human readable representation of a value.
public static function printShallow($value, $max_depth, $max_members) — Dump some debug output about an object's members without the potential recursive explosion of verbosity that comes with `print_r()`.

Internals

private static function printShallowRecursive($value, $max_depth, $max_members, $depth, $indent) — Implementation for @{method:printShallow}.
private static function addIndentation($value, $indent, $first_line) — Adds indentation to the beginning of every line starting from `$first_line`.

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 printableValue($value)

Given a value, makes the best attempt at returning a string representation of that value suitable for printing. This method returns a complete representation of the value; use printShort() or printShallow() to summarize values.

Parameters

wild

$value

Any value.

Return

string

Human-readable representation of the value.

public static function printShort($value)

Print a concise, human readable representation of a value.

Parameters

wild

$value

Any value.

Return

string

Human-readable short representation of the value.

public static function printShallow($value, $max_depth, $max_members)

Dump some debug output about an object's members without the potential recursive explosion of verbosity that comes with print_r().

To print any number of member variables, pass null for $max_members.

Parameters

wild	$value	Any value.
int	$max_depth	Maximum depth to print for nested arrays and objects.
int	$max_members	Maximum number of values to print at each level.

Return

string

Human-readable shallow representation of the value.

private static function printShallowRecursive($value, $max_depth, $max_members, $depth, $indent)

Implementation for printShallow().

Parameters

wild	$value	Any value.
int	$max_depth	Maximum depth to print for nested arrays and objects.
int	$max_members	Maximum number of values to print at each level.
int	$depth	Current depth.
string	$indent	Indentation string.

Return

string

Human-readable shallow representation of the value.

private static function addIndentation($value, $indent, $first_line)

Adds indentation to the beginning of every line starting from $first_line.

Parameters

string	$value	Printed value.
string	$indent	String to indent with.
int	$first_line	Index of first line to indent.

Return

string

Defined: src/readableserializer/PhutilReadableSerializer.php:10
Extends: Phobject

final class PhutilReadableSerializerArcanist Technical Documentation ()

Tasks

Printing PHP Values

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 static function printableValue($value)

public static function printShort($value)

public static function printShallow($value, $max_depth, $max_members)

private static function printShallowRecursive($value, $max_depth, $max_members, $depth, $indent)

private static function addIndentation($value, $indent, $first_line)

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