Execute commands on a remote host using ssh.
Use \Project#createTask to register a new Task.
author |
Johan Van den Brande johan@vandenbrande.com |
---|---|
version |
$Id: fcc9b201c6ff1159698d67f5966f6dd39c7591c7 $ |
package |
phing.tasks.ext |
createSshconfig() : \Ssh2MethodParam
getCommand() : string
string
getDescription() : string
string
The text description of the task
getHost() : string
string
getLocation() : \Location
getOwningTarget() : \Target
getPassword() : string
string
getPort() : integer
integer
getPrivkeyfile()
getPrivkeyfilepassphrase( $privkeyfilepassphrase) : string
string
getProject() : \Project
getPty() : string
string
getPubkeyfile()
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
getUsername() : string
string
handleStream( $stream)
throws | |
---|---|
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
perform()
throws | |
---|---|
setCommand( $command)
setDescription(string $desc)
string
The text describing the task
setDisplay(boolean $display)
boolean
setHost( $host)
setLocation(\Location $location)
setOwningTarget(\Target $target)
setPassword( $password)
setPort( $port)
setPrivkeyfile( $privkeyfile)
setPrivkeyfilepassphrase( $privkeyfilepassphrase)
setProject(\Project $project) : void
setProperty(string $property)
string
setPty( $pty)
setPubkeyfile( $pubkeyfile)
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setupConnection()
setUsername( $username)
host :
port :
methods :
username :
password :
command :
pubkeyfile :
privkeyfile :
privkeyfilepassphrase :
pty :
failonerror :
property : string
var |
---|
string
display : boolean
var |
---|
boolean
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project