StackBasedTask
abstract class StackBasedTask extends BaseTask (View source)
Extend StackBasedTask to create a Robo task that runs a sequence of commands.
This is particularly useful for wrapping an existing object-oriented API. Doing it this way requires less code than manually adding a method for each wrapped function in the delegate. Additionally, wrapping the external class in a StackBasedTask creates a loosely-coupled interface -- i.e. if a new method is added to the delegate class, it is not necessary to update your wrapper, as the new functionality will be inherited.
For example, you have:
$frobinator = new Frobinator($a, $b, $c) ->friz() ->fraz() ->frob();
We presume that the existing library throws an exception on error.
You want:
$result = $this->taskFrobinator($a, $b, $c) ->friz() ->fraz() ->frob() ->run();
Execution is deferred until run(), and a Robo\Result instance is returned. Additionally, using Robo will covert Exceptions into RoboResult objects.
To create a new Robo task:
- Make a new class that extends StackBasedTask
- Give it a constructor that creates a new Frobinator
- Override getDelegate(), and return the Frobinator instance
Finally, add your new class to Tasks.php as usual, and you are all done.
If you need to add any methods to your task that should run immediately (e.g. to set parameters used at run() time), just implement them in your derived class.
If you need additional methods that should run deferred, just define them as 'protected function _foo()'. Then, users may call $this->taskFrobinator()->foo() to get deferred execution of _foo().
Traits
Task input/output methods. TaskIO is 'used' in BaseTask, so any task that extends this class has access to all of the methods here.
Task input/output methods. TaskIO is 'used' in BaseTask, so any task that extends this class has access to all of the methods here.
Properties
| protected ConfigInterface | $config | from ConfigAwareTrait | |
| protected OutputAdapterInterface | $outputAdapter | from VerbosityThresholdTrait | |
| protected int | $verbosityThreshold | from VerbosityThresholdTrait | |
| protected OutputInterface | $output | from OutputAwareTrait | |
| protected TimeKeeper|null | $timer | from Timer | |
| protected null|ProgressIndicator | $progressIndicator | from ProgressIndicatorAwareTrait | |
| protected array | $stack | ||
| protected bool | $stopOnFail |
Methods
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
No description
No description
Required verbosity level before any TaskIO output will be produced.
Print a message if the selected verbosity level is over this task's verbosity threshold.
Print information about a task in progress.
Provide notification that some part of the task succeeded.
Provide notification that there is something wrong, but execution can continue.
Provide notification that some operation in the task failed, and the task cannot continue.
Provide debugging notification. These messages are only displayed if the log level is VERBOSITY_DEBUG.
Get the formatted task name for use in task output.
No description
Ask the provided parent class to inject all of the dependencies that it has and we need.
Take all dependencies availble to this task and inject any that are needed into the provided task. The general pattern is that, for every FooAwareInterface that this class implements, it should test to see if the child also implements the same interface, and if so, should call $child->setFoo($this->foo).
No description
Derived classes should override the getDelegate() method, and return an instance of the API class being wrapped. When this is done, any method of the delegate is available as a method of this class. Calling one of the delegate's methods will defer execution until the run() method is called.
Derived classes that have more than one delegate may override getCommandList to add as many delegate commands as desired to the list of potential functions that __call() tried to find.
Print progress about the commands being executed
Derived classes can override processResult to add more logic to result handling from functions. By default, it is assumed that if a function returns in int, then 0 == success, and any other value is the error code.
Record a function to call later.
Any API function provided by the delegate that executes immediately may be handled by __call automatically. These operations will all be deferred until this task's run() method is called.
Execute one task method
Details
$this
setConfig(ConfigInterface $config)
Set the config management object.
ConfigInterface
getConfig()
Get the config management object.
static protected string
configPrefix()
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
static protected
configClassIdentifier($classname)
No description
static protected
configPostfix()
No description
static
configure(string $key, mixed $value, ConfigInterface|null $config = null)
No description
protected mixed|null
getConfigValue(string $key, mixed|null $default = null)
No description
$this
setVerbosityThreshold(int $verbosityThreshold)
Required verbosity level before any TaskIO output will be produced.
e.g. OutputInterface::VERBOSITY_VERBOSE
int
verbosityThreshold()
No description
setOutputAdapter(OutputAdapterInterface $outputAdapter)
No description
OutputAdapterInterface
outputAdapter()
No description
bool
hasOutputAdapter()
No description
bool
verbosityMeetsThreshold()
No description
writeMessage(string $message)
Print a message if the selected verbosity level is over this task's verbosity threshold.
$this
setOutput(OutputInterface $output)
No description
protected OutputInterface
output()
No description
protected OutputInterface
stderr()
No description
protected OutputInterface
getOutput()
deprecated
deprecated
Backwards compatibility
in
TaskIO at line 49
null|LoggerInterface
logger()
deprecated
deprecated
No description
in
TaskIO at line 85
protected
printTaskInfo(string $text, null|array $context = null)
Print information about a task in progress.
With the Symfony Console logger, NOTICE is displayed at VERBOSITY_VERBOSE and INFO is displayed at VERBOSITY_VERY_VERBOSE.
Robo overrides the default such that NOTICE is displayed at VERBOSITY_NORMAL and INFO is displayed at VERBOSITY_VERBOSE.
n.b. We should probably have printTaskNotice for our ordinary output, and use printTaskInfo for less interesting messages.
protected
printTaskSuccess(string $text, null|array $context = null)
Provide notification that some part of the task succeeded.
With the Symfony Console logger, success messages are remapped to NOTICE, and displayed in VERBOSITY_VERBOSE. When used with the Robo logger, success messages are displayed at VERBOSITY_NORMAL.
protected
printTaskWarning(string $text, null|array $context = null)
Provide notification that there is something wrong, but execution can continue.
Warning messages are displayed at VERBOSITY_NORMAL.
protected
printTaskError(string $text, null|array $context = null)
Provide notification that some operation in the task failed, and the task cannot continue.
Error messages are displayed at VERBOSITY_NORMAL.
protected
printTaskDebug($text, null|array $context = null)
Provide debugging notification. These messages are only displayed if the log level is VERBOSITY_DEBUG.
protected
printTaskOutput(string $level, string $text, null|array $context)
deprecated
deprecated
No description
protected bool
hideTaskProgress()
No description
protected
showTaskProgress(bool $inProgress)
No description
protected string
formatBytes(int $size, int $precision = 2)
Format a quantity of bytes.
protected string
getPrintedTaskName(null|object $task = null)
Get the formatted task name for use in task output.
This is placed in the task context under 'name', and used as the log label by Robo\Common\RoboLogStyle, which is inserted at the head of log messages by Robo\Common\CustomLogStyle::formatMessage().
protected array
getTaskContext(null|array $context = null)
No description
in
Timer at line 12
protected
startTimer()
No description
in
Timer at line 20
protected
stopTimer()
No description
in
Timer at line 28
protected
resetTimer()
No description
in
Timer at line 36
protected float|null
getExecutionTime()
No description
int
progressIndicatorSteps()
No description
$this
setProgressIndicator(null|ProgressIndicator $progressIndicator)
No description
protected null|bool
hideProgressIndicator()
No description
protected
showProgressIndicator()
No description
protected
restoreProgressIndicator(bool $visible)
No description
protected int
getTotalExecutionTime()
No description
protected
startProgressIndicator()
No description
protected bool
inProgress()
No description
protected
stopProgressIndicator()
No description
protected
disableProgressIndicator()
No description
protected
detatchProgressIndicator()
No description
protected
advanceProgressIndicator(int $steps = 1)
No description
$this
inflect(InflectionInterface|mixed $parent)
Ask the provided parent class to inject all of the dependencies that it has and we need.
injectDependencies(mixed $child)
Take all dependencies availble to this task and inject any that are needed into the provided task. The general pattern is that, for every FooAwareInterface that this class implements, it should test to see if the child also implements the same interface, and if so, should call $child->setFoo($this->foo).
The benefits of this are pretty large. Any time an object that implements
InflectionInterface is created, just call $child->inflect($this), and
any available optional dependencies will be hooked up via setter injection.
The required dependencies of an object should be provided via constructor injection, not inflection.
$this
stopOnFail(bool $stop = true)
No description
protected null|object
getDelegate()
Derived classes should override the getDelegate() method, and return an instance of the API class being wrapped. When this is done, any method of the delegate is available as a method of this class. Calling one of the delegate's methods will defer execution until the run() method is called.
protected array
getDelegateCommandList(string $function)
Derived classes that have more than one delegate may override getCommandList to add as many delegate commands as desired to the list of potential functions that __call() tried to find.
protected
printTaskProgress(string $command, string $action)
Print progress about the commands being executed
protected Result
processResult(int|Result $function_result)
Derived classes can override processResult to add more logic to result handling from functions. By default, it is assumed that if a function returns in int, then 0 == success, and any other value is the error code.
protected $this
addToCommandStack(string $command, array $args)
Record a function to call later.
$this
__call(string $function, array $args)
Any API function provided by the delegate that executes immediately may be handled by __call automatically. These operations will all be deferred until this task's run() method is called.
Result
run()
Run all of the queued objects on the stack
protected Result
callTaskMethod(string $command, array $action)
Execute one task method