Page MenuHomePhorge

final class PhutilRope
Arcanist Technical Documentation ()

String-like object which reduces the cost of managing large strings. This is particularly useful for buffering large amounts of data that is being passed to fwrite().

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$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

public function append($string)

Append a string to the rope.

Parameters
string$stringString to append.
Return
this

public function getByteLength()

Get the length of the rope.

Return
intLength of the rope in bytes.

public function getAnyPrefix()

Get an arbitrary, nonempty prefix of the rope.

Return
stringSome rope prefix.

public function getPrefixBytes($length)

Get prefix bytes of the rope, up to some maximum size.

Parameters
int$lengthMaximum number of bytes to read.
Return
stringBytes.

public function getAsString()

Return the entire rope as a normal string.

Return
stringNormal string.

public function removeBytesFromHead($remove)

Remove a specified number of bytes from the head of the rope.

Parameters
int$removeBytes to remove.
Return
this