public function __get($name)Inherited
| $name |
| wild |
public function __set($name, $value)Inherited
| $name | ||
| $value |
| wild |
public function current()Inherited
| wild |
public function key()Inherited
| wild |
public function next()Inherited
| wild |
public function rewind()Inherited
| wild |
public function valid()Inherited
| wild |
private function throwOnAttemptedIteration()Inherited
| wild |
public function getPhobjectClassConstant($key, $byte_limit)Inherited
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.
| string | $key | Name of the constant. |
| int|null | $byte_limit | Maximum number of bytes permitted in the value. |
| string | Value of the constant. |
final public function __construct()Inherited
| this | //Implicit.// |
public function setName($name)Inherited
| $name |
| wild |
public function getName()Inherited
| wild |
final public function setExamples($examples)Inherited
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.
| $examples |
| wild |
final public function getExamples()Inherited
| wild |
final public function setSynopsis($synopsis)Inherited
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.
| $synopsis |
| wild |
final public function getSynopsis()Inherited
| wild |
final public function getHelp()Inherited
Provide a full explanation of the command. This text is shown only in detailed help.
| wild |
final public function setHelp($help)Inherited
| $help |
| wild |
final public function setArguments($specs)Inherited
| array | $specs |
| wild |
final public function getArguments()Inherited
| wild |
final public function setArgv($argv)Inherited
| PhutilArgumentParser | $argv |
| wild |
final public function getArgv()Inherited
| wild |
protected function didConstruct()
| wild |
public function isExecutable()
| wild |
public function execute($args)
| PhutilArgumentParser | $args |
| wild |
public function shouldParsePartial()Inherited
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.
| bool | True to partially parse workflow arguments (default false). |
public function setWorkflow($workflow)
| $workflow |
| wild |
public function getWorkflow()
| wild |