Tasks
in package
Components_Release_Tasks:: organizes the different tasks required for releasing a package.
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
- $_dependencies : Dependencies
- $_options : array<string|int, mixed>
- The options for the current release run.
- $_sequence : array<string|int, mixed>
- The sequence for the current release run.
- __construct() : mixed
- Constructor.
- getTask() : Base
- Return the named task.
- isTaskActive() : bool
- Is the specified task active for the current run?
- pretend() : bool
- Is the current run operating in "pretend" mode?
- run() : void
- Run a sequence of release tasks.
Properties
$_dependencies read-only
private
Dependencies
$_dependencies
$_options
The options for the current release run.
private
array<string|int, mixed>
$_options
= []
$_sequence
The sequence for the current release run.
private
array<string|int, mixed>
$_sequence
= []
Methods
__construct()
Constructor.
public
__construct(Dependencies $_dependencies) : mixed
Parameters
- $_dependencies : Dependencies
-
The task factory.
Return values
mixed —getTask()
Return the named task.
public
getTask(string $name, Component $component) : Base
Parameters
- $name : string
-
The name of the task.
- $component : Component
-
The component to be released.
Return values
Base —The task.
isTaskActive()
Is the specified task active for the current run?
public
isTaskActive(string $task) : bool
Parameters
- $task : string
-
The task name.
Return values
bool —True in case the task is active.
pretend()
Is the current run operating in "pretend" mode?
public
pretend() : bool
Return values
bool —True in case we should be pretending.
run()
Run a sequence of release tasks.
public
run(array<string|int, mixed> $sequence, Component $component[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $sequence : array<string|int, mixed>
-
The task sequence.
- $component : Component
-
The component to be released.
- $options : array<string|int, mixed> = []
-
Additional options.