tasks/ext/ScpTask.php
Copy files to and from a remote host using scp.
- Author
- Michiel Rook
- Author
- Johan Van den Brande
- Package
- phing.tasks.ext
- Version
- $Id: 300efdab5b721c6312491450bc2ba93ffc8124b4 $
\ScpTask
Copy files to and from a remote host using scp.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Michiel Rook
- Author
- Johan Van den Brande
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 300efdab5b721c6312491450bc2ba93ffc8124b4 $
Properties


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


createFileSet(
)
:
\FileSet
Nested creator, creates a FileSet for this task
Type | Description |
---|---|
\FileSet | The created fileset object |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getPrivkeyfilepassphrase(
$privkeyfilepassphrase
)
:
void
Returns the private keyfile passphrase
Name | Type | Description |
---|---|---|
$privkeyfilepassphrase |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Called by the parser to let the task initialize properly.
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Called by the project to let the task do it's work. 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.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setAutocreate(
$autocreate
)
:
void
Sets whether to autocreate remote directories
Name | Type | Description |
---|---|---|
$autocreate |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setFetch(
$fetch
)
:
void
Sets whether to send (default) or fetch files
Name | Type | Description |
---|---|---|
$fetch |


setLevel(
string $level
)
:
void
Set level of log messages generated (default = verbose)
Name | Type | Description |
---|---|---|
$level | string |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPassword(
$password
)
:
void
Sets the password of the user to scp
Name | Type | Description |
---|---|---|
$password |


setPrivkeyfile(
$privkeyfile
)
:
void
Sets the private key file of the user to scp
Name | Type | Description |
---|---|---|
$privkeyfile |


setPrivkeyfilepassphrase(
$privkeyfilepassphrase
)
:
void
Sets the private key file passphrase of the user to scp
Name | Type | Description |
---|---|---|
$privkeyfilepassphrase |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setPubkeyfile(
$pubkeyfile
)
:
void
Sets the public key file of the user to scp
Name | Type | Description |
---|---|---|
$pubkeyfile |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |