PHP Class Deployer\Task\Task

Afficher le fichier Open project: elfet/deployer Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( string $name, callable $callback = null )
addAfter ( string $task )
addBefore ( string $task )
desc ( string $description ) : Task Set task description.
getAfter ( ) : string[] Get after tasks names.
getBefore ( ) : string[] Get before tasks names.
getDescription ( ) : string
getName ( ) : string
getOnlyForStage ( ) : array
getOnlyOn ( ) : array
isForStages ( $stages ) : boolean Decide to run or not to run for these stages.
isOnServer ( string $serverName ) : boolean Decide to run or not to run on this server.
isOnce ( ) : boolean
isPrivate ( ) : boolean
once ( ) : Task Set this task local and run only once.
onlyForStage ( array | string $stages = [] ) : Task Indicate for which stages this task should be run.
onlyOn ( array | string $servers = [] ) : Task
run ( Deployer\Task\Context $context ) Run task.
setPrivate ( ) : Task Mark task as private.

Method Details

__construct() public méthode

public __construct ( string $name, callable $callback = null )
$name string Tasks name
$callback callable Task code.

addAfter() public méthode

public addAfter ( string $task )
$task string

addBefore() public méthode

public addBefore ( string $task )
$task string

desc() public méthode

Set task description.
public desc ( string $description ) : Task
$description string
Résultat Task

getAfter() public méthode

Get after tasks names.
public getAfter ( ) : string[]
Résultat string[]

getBefore() public méthode

Get before tasks names.
public getBefore ( ) : string[]
Résultat string[]

getDescription() public méthode

public getDescription ( ) : string
Résultat string

getName() public méthode

public getName ( ) : string
Résultat string

getOnlyForStage() public méthode

public getOnlyForStage ( ) : array
Résultat array

getOnlyOn() public méthode

public getOnlyOn ( ) : array
Résultat array

isForStages() public méthode

Decide to run or not to run for these stages.
public isForStages ( $stages ) : boolean
$stages
Résultat boolean

isOnServer() public méthode

Decide to run or not to run on this server.
public isOnServer ( string $serverName ) : boolean
$serverName string
Résultat boolean

isOnce() public méthode

public isOnce ( ) : boolean
Résultat boolean

isPrivate() public méthode

public isPrivate ( ) : boolean
Résultat boolean

once() public méthode

Set this task local and run only once.
public once ( ) : Task
Résultat Task

onlyForStage() public méthode

Indicate for which stages this task should be run.
public onlyForStage ( array | string $stages = [] ) : Task
$stages array | string
Résultat Task

onlyOn() public méthode

public onlyOn ( array | string $servers = [] ) : Task
$servers array | string
Résultat Task

run() public méthode

Run task.
public run ( Deployer\Task\Context $context )
$context Deployer\Task\Context

setPrivate() public méthode

Mark task as private.
public setPrivate ( ) : Task
Résultat Task