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()Inherited
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 setErrorChannel($error_channel)Inherited
PhutilChannel | $error_channel |
wild |
public function getErrorChannel()Inherited
wild |
public function setSSHUser($ssh_user)Inherited
PhabricatorUser | $ssh_user |
wild |
public function getSSHUser()Inherited
wild |
public function setIOChannel($channel)Inherited
PhutilChannel | $channel |
wild |
public function getIOChannel()Inherited
wild |
public function readAllInput()Inherited
wild |
public function writeIO($data)Inherited
$data |
wild |
public function writeErrorIO($data)Inherited
$data |
wild |
protected function newPassthruCommand()Inherited
wild |
public function setIsClusterRequest($is_cluster_request)Inherited
$is_cluster_request |
wild |
public function getIsClusterRequest()Inherited
wild |
public function setOriginalArguments($original_arguments)Inherited
array | $original_arguments |
wild |
public function getOriginalArguments()Inherited
wild |
public function setRequestIdentifier($request_identifier)Inherited
$request_identifier |
wild |
public function getRequestIdentifier()Inherited
wild |
public function getSSHRemoteAddress()Inherited
wild |