Page MenuHomePhorge
Diviner Tech Docs DivinerStaticPublisher

final class DivinerStaticPublisher
Phorge Technical Documentation (Diviner)

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.

final public function setDropCaches($drop_caches)
Inherited

This method is not documented.
Parameters
$drop_caches
Return
wild

final public function setRenderer($renderer)
Inherited

This method is not documented.
Parameters
DivinerRenderer$renderer
Return
wild

final public function getRenderer()
Inherited

This method is not documented.
Return
wild

final public function setConfig($config)
Inherited

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

final public function getConfig($key, $default)
Inherited

This method is not documented.
Parameters
$key
$default
Return
wild

final public function getConfigurationData()
Inherited

This method is not documented.
Return
wild

final public function setAtomCache($cache)
Inherited

This method is not documented.
Parameters
DivinerAtomCache$cache
Return
wild

final protected function getAtomFromGraphHash($graph_hash)
Inherited

This method is not documented.
Parameters
$graph_hash
Return
wild

final protected function getAtomFromNodeHash($node_hash)
Inherited

This method is not documented.
Parameters
$node_hash
Return
wild

final protected function getSimilarAtoms($atom)
Inherited

This method is not documented.
Parameters
DivinerAtom$atom
Return
wild

final protected function getAtomSimilarIndex($atom)
Inherited

DivinerPublisher

If a book contains multiple definitions of some atom, like some function f(), we assign them an arbitrary (but fairly stable) order and publish them as function/f/1/, function/f/2/, etc., or similar.

Parameters
DivinerAtom$atom
Return
wild

protected function loadAllPublishedHashes()

This method is not documented.
Return
wild

protected function deleteDocumentsByHash($hashes)

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

protected function createDocumentsByHash($hashes)

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

public function findAtomByRef($ref)

This method is not documented.
Parameters
DivinerAtomRef$ref
Return
wild

final public function publishAtoms($hashes)
Inherited

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

final protected function shouldGenerateDocumentForAtom($atom)
Inherited

This method is not documented.
Parameters
DivinerAtom$atom
Return
wild

final public function getRepositoryPHID()
Inherited

This method is not documented.
Return
wild

final public function setRepositoryPHID($repository_phid)
Inherited

This method is not documented.
Parameters
$repository_phid
Return
wild

private function getPublishCache()

This method is not documented.
Return
wild

private function publishIndex()

This method is not documented.
Return
wild

private function addAtomToIndex($hash, $atom)

This method is not documented.
Parameters
$hash
DivinerAtom$atom
Return
wild

private function writeDocument($atom, $content)

This method is not documented.
Parameters
DivinerAtom$atom
$content
Return
wild

private function getAtomRelativePath($atom)

This method is not documented.
Parameters
DivinerAtom$atom
Return
wild