• Home
  • Components_Qc_Task_Base

PHP Class Components_Qc_Task_Base, horde

Copyright 2011-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://pear.horde.org/index.php?package=Components
Author: Gunnar Wrobel ([email protected])
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_config Components_Config The configuration for the current job.

Public Methods

Method Description
__construct ( Components_Config $config, Components_Qc_Tasks $tasks, Components_Output $output ) Constructor.
getName ( ) : string Get the name of this task.
run ( &$options ) : integer Run the task.
setComponent ( Components_Component $component ) : null Set the component this task should act upon.
setName ( string $name ) : null Set the name of this task.
validate ( array $options ) : array Validate the preconditions required for this release task.

Protected Methods

Method Description
getComponent ( ) : Components_Component Get the component this task should act upon.
getOutput ( ) : Components_Output Get the output handler.
getTasks ( ) : Components_Release_Tasks Get the tasks handler.
system ( string $call ) : string Run a system call.
systemInDirectory ( string $call, string $target_dir ) : string Run a system call.

Method Details

__construct() public method

Constructor.
public __construct ( Components_Config $config, Components_Qc_Tasks $tasks, Components_Output $output )
$config Components_Config The configuration for the current job.
$tasks Components_Qc_Tasks The task handler.
$output Components_Output Accepts output.

getComponent() protected method

Get the component this task should act upon.
protected getComponent ( ) : Components_Component
return Components_Component The component to be checked.

getName() public method

Get the name of this task.
public getName ( ) : string
return string The task name.

getOutput() protected method

Get the output handler.
protected getOutput ( ) : Components_Output
return Components_Output The output handler.

getTasks() protected method

Get the tasks handler.
protected getTasks ( ) : Components_Release_Tasks
return Components_Release_Tasks The release tasks handler.

run() public method

Run the task.
public run ( &$options ) : integer
return integer Number of errors.

setComponent() public method

Set the component this task should act upon.
public setComponent ( Components_Component $component ) : null
$component Components_Component The component to be checked.
return null

setName() public method

Set the name of this task.
public setName ( string $name ) : null
$name string The task name.
return null

system() protected method

Run a system call.
protected system ( string $call ) : string
$call string The system call to execute.
return string The command output.

systemInDirectory() protected method

Run a system call.
protected systemInDirectory ( string $call, string $target_dir ) : string
$call string The system call to execute.
$target_dir string Run the command in the provided target path.
return string The command output.

validate() public method

Validate the preconditions required for this release task.
public validate ( array $options ) : array
$options array Additional options.
return array An empty array if all preconditions are met and a list of error messages otherwise.

Property Details

$_config protected property

The configuration for the current job.
protected Components_Config $_config
return Components_Config