PhutilArgumentWorkflow.php
View Options

	<?php

	/**
	* Used with @{class:PhutilArgumentParser} to build command line tools which
	* operate in several modes, called "workflows", like `git`, `svn`, `arc`,
	* `apt-get`. For example, you might build a simple calculator like this:
	*
	* name=scripts/example/calculator.php
	* $args = new PhutilArgumentParser($argv);
	* $args->setTagline('simple calculator example');
	* $args->setSynopsis(<<<EOHELP
	* calculator.php __op__ __n__ ...
	* Perform a calculation.
	* EOHELP
	* );
	*
	* $add_workflow = id(new PhutilArgumentWorkflow())
	* ->setName('add')
	* ->setExamples('add __n__ ...')
	* ->setSynopsis('Compute the sum of a list of numbers.')
	* ->setArguments(
	* array(
	* array(
	* 'name' => 'numbers',
	* 'wildcard' => true,
	* ),
	* ));
	*
	* $mul_workflow = id(new PhutilArgumentWorkflow())
	* ->setName('mul')
	* ->setExamples('mul __n__ ...')
	* ->setSynopsis('Compute the product of a list of numbers.')
	* ->setArguments(
	* array(
	* array(
	* 'name' => 'numbers',
	* 'wildcard' => true,
	* ),
	* ));
	*
	* $flow = $args->parseWorkflows(
	* array(
	* $add_workflow,
	* $mul_workflow,
	* new PhutilHelpArgumentWorkflow(),
	* ));
	*
	* $nums = $args->getArg('numbers');
	* if (empty($nums)) {
	* echo "You must provide one or more numbers!\n";
	* exit(1);
	* }
	*
	* foreach ($nums as $num) {
	* if (!is_numeric($num)) {
	* echo "Number '{$num}' is not numeric!\n";
	* exit(1);
	* }
	* }
	*
	* switch ($flow->getName()) {
	* case 'add':
	* echo array_sum($nums)."\n";
	* break;
	* case 'mul':
	* echo array_product($nums)."\n";
	* break;
	* }
	*
	* You can also subclass this class and return `true` from
	* @{method:isExecutable}. In this case, the parser will automatically select
	* your workflow when the user invokes it.
	*
	* @concrete-extensible
	*/
	class PhutilArgumentWorkflow extends Phobject {

	private $name;
	private $synopsis;
	private $specs = array();
	private $examples;
	private $help;
	private $argv;

	final public function __construct() {
	$this->didConstruct();
	}

	public function setName($name) {
	$this->name = $name;
	return $this;
	}

	public function getName() {
	return $this->name;
	}

	/**
	* 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.
	*/
	final public function setExamples($examples) {
	$this->examples = $examples;
	return $this;
	}

	final public function getExamples() {
	if (!$this->examples) {
	return ''.$this->name.'';
	}
	return $this->examples;
	}

	/**
	* 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.
	*/
	final public function setSynopsis($synopsis) {
	$this->synopsis = $synopsis;
	return $this;
	}

	final public function getSynopsis() {
	return $this->synopsis;
	}


	/**
	* Provide a full explanation of the command. This text is shown only in
	* detailed help.
	*/
	final public function getHelp() {
	return $this->help;
	}

	final public function setHelp($help) {
	$this->help = $help;
	return $this;
	}

	final public function setArguments(array $specs) {
	$specs = PhutilArgumentSpecification::newSpecsFromList($specs);
	$this->specs = $specs;
	return $this;
	}

	final public function getArguments() {
	return $this->specs;
	}

	final public function setArgv(PhutilArgumentParser $argv) {
	$this->argv = $argv;
	return $this;
	}

	final public function getArgv() {
	return $this->argv;
	}

	protected function didConstruct() {
	return null;
	}

	public function isExecutable() {
	return false;
	}

	public function execute(PhutilArgumentParser $args) {
	throw new Exception(pht("This workflow isn't executable!"));
	}

	/**
	* 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 bool True to partially parse workflow arguments (default false).
	*/
	public function shouldParsePartial() {
	return false;
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Jan 19 2025, 11:15 (5 w, 23 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1124167
Default Alt Text: PhutilArgumentWorkflow.php (4 KB)

PhutilArgumentWorkflow.php
No OneTemporary
Actions

PhutilArgumentWorkflow.php
View Options

File Metadata

Event Timeline

PhutilArgumentWorkflow.phpNo OneTemporaryActions

PhutilArgumentWorkflow.phpView Options

File Metadata

Event Timeline

PhutilArgumentWorkflow.php
No OneTemporary
Actions

PhutilArgumentWorkflow.php
View Options