Page MenuHomePhorge
Diviner Tech Docs DiffusionBrowseResultSet

final class DiffusionBrowseResultSet
Phorge Technical Documentation (Diffusion)

This class is not documented.

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 setPaths($paths)

This method is not documented.
Parameters
array$paths
Return
wild

public function getPaths()

This method is not documented.
Return
wild

public function setIsValidResults($is_valid)

This method is not documented.
Parameters
$is_valid
Return
wild

public function isValidResults()

This method is not documented.
Return
wild

public function setReasonForEmptyResultSet($reason)

This method is not documented.
Parameters
$reason
Return
wild

public function getReasonForEmptyResultSet()

This method is not documented.
Return
wild

public function setExistedAtCommit($existed_at_commit)

This method is not documented.
Parameters
$existed_at_commit
Return
wild

public function getExistedAtCommit()

This method is not documented.
Return
wild

public function setDeletedAtCommit($deleted_at_commit)

This method is not documented.
Parameters
$deleted_at_commit
Return
wild

public function getDeletedAtCommit()

This method is not documented.
Return
wild

public function toDictionary()

This method is not documented.
Return
wild

public function getPathDicts()

This method is not documented.
Return
wild

public function getReadmePath()

Get the best README file in this result set, if one exists.

Callers should normally use diffusion.filecontentquery to pull README content.

Return
string|nullFull path to best README, or null if one does not exist.

public static function getReadmePriority($path)

Get the priority of a README file.

When a directory contains several README files, this function scores them so the caller can select a preferred file. See getReadmePath().

Parameters
string$pathLocal README path, like "README.txt".
Return
intPriority score, with higher being more preferred.

public static function newFromConduit($data)

This method is not documented.
Parameters
array$data
Return
wild