Page MenuHomePhabricator
Diviner Phabricator Tech Docs DivinerGenerateWorkflow

final class DivinerGenerateWorkflow
Phabricator Technical Documentation (Diviner)

This class is not documented.

Methods

final public function __construct()
Inherited

This method is not documented.
Return
this//Implicit.//

public function setName($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function getName()
Inherited

This method is not documented.
Return
wild

final public function setExamples($examples)
Inherited

PhutilArgumentWorkflow

Provide brief usage examples of common calling conventions, like:

$workflow->setExamples("**delete** __file__ [__options__]");

This text is shown in both brief and detailed help, and should give the user a quick reference for common uses. You can separate several common uses with newlines, but usually should not provide more than 2-3 examples.

Parameters
$examples
Return
wild

final public function getExamples()
Inherited

This method is not documented.
Return
wild

final public function setSynopsis($synopsis)
Inherited

PhutilArgumentWorkflow

Provide a brief description of the command, like "Delete a file.".

This text is shown in both brief and detailed help, and should give the user a general idea of what the workflow does.

Parameters
$synopsis
Return
wild

final public function getSynopsis()
Inherited

This method is not documented.
Return
wild

final public function getHelp()
Inherited

PhutilArgumentWorkflow

Provide a full explanation of the command. This text is shown only in detailed help.

Return
wild

final public function setHelp($help)
Inherited

This method is not documented.
Parameters
$help
Return
wild

final public function setArguments($specs)
Inherited

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

final public function getArguments()
Inherited

This method is not documented.
Return
wild

final public function setArgv($argv)
Inherited

This method is not documented.
Parameters
PhutilArgumentParser$argv
Return
wild

final public function getArgv()
Inherited

This method is not documented.
Return
wild

protected function didConstruct()

This method is not documented.
Return
wild

public function isExecutable()
Inherited

This method is not documented.
Return
wild

public function execute($args)

This method is not documented.
Parameters
PhutilArgumentParser$args
Return
wild

public function shouldParsePartial()
Inherited

PhutilArgumentWorkflow

Normally, workflow arguments are parsed fully, so unexpected arguments will raise an error. You can return true from this method to parse workflow arguments only partially. This will allow you to manually parse remaining arguments or delegate to a second level of workflows.

Return
boolTrue to partially parse workflow arguments (default false).

public function getViewer()
Inherited

This method is not documented.
Return
wild

protected function parseTimeArgument($time)
Inherited

This method is not documented.
Parameters
$time
Return
wild

protected function newContentSource()
Inherited

This method is not documented.
Return
wild

protected function logInfo($label, $message)
Inherited

This method is not documented.
Parameters
$label
$message
Return
wild

protected function logOkay($label, $message)
Inherited

This method is not documented.
Parameters
$label
$message
Return
wild

protected function logWarn($label, $message)
Inherited

This method is not documented.
Parameters
$label
$message
Return
wild

protected function logFail($label, $message)
Inherited

This method is not documented.
Parameters
$label
$message
Return
wild

private function logRaw($message)
Inherited

This method is not documented.
Parameters
$message
Return
wild

final protected function loadUsersFromArguments($identifiers)
Inherited

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

public function getBookConfigPath()
Inherited

This method is not documented.
Return
wild

protected function getConfig($key, $default)
Inherited

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

protected function getAllConfig()
Inherited

This method is not documented.
Return
wild

protected function readBookConfiguration($book_path)
Inherited

This method is not documented.
Parameters
$book_path
Return
wild

protected function getAtomCache()

This method is not documented.
Return
wild

protected function log($message)

This method is not documented.
Parameters
$message
Return
wild

private function generateBook($book, $args)

This method is not documented.
Parameters
$book
PhutilArgumentParser$args
Return
wild

private function buildAtomCache()

This method is not documented.
Return
wild

private function getAtomizersForFiles($files)

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

private function getRules()

This method is not documented.
Return
wild

private function getExclude()

This method is not documented.
Return
wild

private function findFilesInProject()

This method is not documented.
Return
wild

private function deleteDeadAtoms($file_hashes)

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

private function getFilesToAtomize($file_hashes)

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

private function buildAtomizerFutures($file_atomizers)

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

private function resolveAtomizerFutures($futures, $file_hashes)

This method is not documented.
Parameters
array$futures
array$file_hashes
Return
wild

private function getDivinerAtomWorldVersion()

Get a global version number, which changes whenever any atom or atomizer implementation changes in a way which is not backward-compatible.

Return
wild

private function buildGraphCache()

This method is not documented.
Return
wild

private function computeSymbolHash($node_hash)

This method is not documented.
Parameters
$node_hash
Return
wild

private function getEdges($node_hash)

This method is not documented.
Parameters
$node_hash
Return
wild

private function computeGraphHash($node_hash)

This method is not documented.
Parameters
$node_hash
Return
wild

private function publishDocumentation($clean, $publisher)

This method is not documented.
Parameters
$clean
DivinerPublisher$publisher
Return
wild