Copy files to and from a remote host using scp.
Methods
Nested creator, creates a FileSet for this task
createFileSet() : \FileSet
Returns whether to autocreate remote directories
getAutocreate()
Returns the textual description of the task
getDescription() : string
Inherited
| inherited_from |
\Task::getDescription() |
Returns
stringThe text description of the task
Returns whether to send (default) or fetch files
getFetch()
Returns local filename
getFile()
Returns the remote host
getHost()
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
| inherited_from |
\Task::getLocation() |
Returns
\LocationThe location object describing the position of this
task within the buildfile.
Returns the mode value
getMode()
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
| inherited_from |
\Task::getOwningTarget() |
Returns
\TargetThe target object that owns this task
Returns the password
getPassword()
Returns the remote host port
getPort()
Returns the private keyfile
getPrivkeyfile()
Returns the private keyfile passphrase
getPrivkeyfilepassphrase($privkeyfilepassphrase)
Parameters
$privkeyfilepassphrase
Returns a reference to current project
getProject() : \Project
Inherited
| inherited_from |
\ProjectComponent::getProject() |
| inherited_from |
\Task::getProject() |
Returns
\ProjectReference to current porject object
Returns the pubkeyfile
getPubkeyfile()
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
| inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
| inherited_from |
\Task::getTaskName() |
Returns
stringName of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
Inherited
| inherited_from |
\Task::getTaskType() |
Returns
stringThe type of this task (XML Tag)
Returns the destination directory
getTodir()
Returns the username
getUsername()
Called by the parser to let the task initialize properly.
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exceptions
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
stringThe message to log
$level
integerThe priority of the message
Called by the project to let the task do it's work.
main()
This method may be
called more than once, if the task is invoked more than once. For
example, if target1 and target2 both depend on target3, then running
phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Sets whether to autocreate remote directories
setAutocreate($autocreate)
Sets a textual description of the task
setDescription(string $desc)
Inherited
| inherited_from |
\Task::setDescription() |
Parameters
$desc
stringThe text describing the task
Sets whether to send (default) or fetch files
setFetch($fetch)
Sets local filename
setFile($file)
Sets the remote host
setHost($h)
Set level of log messages generated (default = verbose)
setLevel(string $level)
Sets the location within the buildfile this task occurs.
setLocation(\Location $location)
Inherited
Called by
the parser to set location information.
| inherited_from |
\Task::setLocation() |
Parameters
$location
\LocationThe location object describing the position of this
task within the buildfile.
Sets the mode value
setMode($value)
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
| inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\TargetReference to owning target
Sets the password of the user to scp
setPassword($password)
Sets the remote host port
setPort($p)
Sets the private key file of the user to scp
setPrivkeyfile($privkeyfile)
Sets the private key file passphrase of the user to scp
setPrivkeyfilepassphrase($privkeyfilepassphrase)
Parameters
$privkeyfilepassphrase
References the project to the current component.
setProject(\Project $project)
Inherited
| inherited_from |
\ProjectComponent::setProject() |
| inherited_from |
\Task::setProject() |
Parameters
$project
\ProjectThe reference to the current project
Sets the public key file of the user to scp
setPubkeyfile($pubkeyfile)
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
| inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
| inherited_from |
\Task::setTaskName() |
Parameters
$name
string
Returns
stringA string representing the name of this task for log
Sets the type of the task.
setTaskType(string $name)
Inherited
Usually this is the name of the XML tag
| inherited_from |
\Task::setTaskType() |
Parameters
$name
stringThe type of this task (XML Tag)
Set destination directory
setTodir($todir)
Sets the username of the user to scp
setUsername($username)
copyFile()
copyFile($local, $remote)
Parameters
$local
$remote
Returns a name
getRegisterSlot(string $slotName)
Inherited
| inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
Properties
$description : string
Inherited
| inherited_from |
\Task::$$description |
$location : \Location
Inherited
| inherited_from |
\Task::$$location |
$project : \Project
Inherited
| inherited_from |
\ProjectComponent::$$project |
| inherited_from |
\Task::$$project |
$target : \Target
Inherited
| inherited_from |
\Task::$$target |
$taskName : string
Inherited
| inherited_from |
\Task::$$taskName |
$taskType : string
Inherited
| inherited_from |
\Task::$$taskType |