TaskInterface
in
Common interface for tasks used in Release, Qc and Pipeline
Copyright 2011-2020 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- getName() : string
- Get the name of this task.
- postValidate() : array<string|int, mixed>
- Validate the postconditions required for this release task to have succeeded.
- preValidate() : array<string|int, mixed>
- Validate the preconditions required for this release task.
- run() : mixed
- Run the task.
- setComponent() : void
- Change the component this task should act upon.
- skip() : bool
- Can the task be skipped?
Methods
getName()
Get the name of this task.
public
getName() : string
Return values
string —The task name.
postValidate()
Validate the postconditions required for this release task to have succeeded.
public
postValidate(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
-
Additional options.
Return values
array<string|int, mixed> —An empty array if all postconditions are met and a list of error messages otherwise.
preValidate()
Validate the preconditions required for this release task.
public
preValidate(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
-
Additional options.
Return values
array<string|int, mixed> —An empty array if all preconditions are met and a list of error messages otherwise.
run()
Run the task.
public
run(array<string|int, mixed> &$options) : mixed
Parameters
- $options : array<string|int, mixed>
-
Additional options.
Return values
mixed —setComponent()
Change the component this task should act upon.
public
setComponent(Source $component) : void
This might be needed if the component is not present before the task runs
Parameters
- $component : Source
-
The component to be released.
Return values
void —skip()
Can the task be skipped?
public
skip(array<string|int, mixed> $options) : bool
Parameters
- $options : array<string|int, mixed>
-
Additional options.
Return values
bool —True if it can be skipped.