Page MenuHomePhorge
Diviner Arcanist Tech Docs PhutilHelpArgumentWorkflow

final class PhutilHelpArgumentWorkflow
Arcanist Technical Documentation ()

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 __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()

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 setWorkflow($workflow)

This method is not documented.
Parameters
$workflow
Return
wild

public function getWorkflow()

This method is not documented.
Return
wild