tasks/ext/ScpTask.php

Show: inherited
Table of Contents

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

Package: phing\tasks\ext

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

Propertyprotected  $autocreate= 'true'
Default valuetrueDetails
Type
n/a
Propertyprotected  $connection= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $count= '0'
Default value0Details
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprotected  $fetch= 'false'
Default valuefalseDetails
Type
n/a
Propertyprotected  $file= '""'
Default value""Details
Type
n/a
Propertyprotected  $filesets= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $host= '""'
Default value""Details
Type
n/a
Propertyprotected  $localEndpoint= '""'
Default value""Details
Type
n/a
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprotected  $logLevel= 'Project::MSG_VERBOSE'
Default valueProject::MSG_VERBOSEDetails
Type
n/a
Propertyprotected  $mode= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $password= '""'
Default value""Details
Type
n/a
Propertyprotected  $port= '22'
Default value22Details
Type
n/a
Propertyprotected  $privkeyfile= ''''
Default value''Details
Type
n/a
Propertyprotected  $privkeyfilepassphrase= ''''
Default value''Details
Type
n/a
Propertyprotected\Project  $project= 'null'
inherited

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::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprotected  $pubkeyfile= ''''
Default value''Details
Type
n/a
Propertyprotected  $remoteEndpoint= '""'
Default value""Details
Type
n/a
Propertyprotected  $sftp= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprotected  $todir= '""'
Default value""Details
Type
n/a
Propertyprotected  $username= '""'
Default value""Details
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

Methods

methodprotectedcopyFile(  $local,  $remote ) : void

Parameters
Name Type Description
$local
$remote
methodpubliccreateFileSet( ) : \FileSet

Nested creator, creates a FileSet for this task

Returns
Type Description
\FileSet The created fileset object
methodpublicgetAutocreate( ) : void

Returns whether to autocreate remote directories

methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetFetch( ) : void

Returns whether to send (default) or fetch files

methodpublicgetFile( ) : void

Returns local filename

methodpublicgetHost( ) : void

Returns the remote host

methodpublicgetLocation( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetMode( ) : void

Returns the mode value

methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetPassword( ) : void

Returns the password

methodpublicgetPort( ) : void

Returns the remote host port

methodpublicgetPrivkeyfile( ) : void

Returns the private keyfile

methodpublicgetPrivkeyfilepassphrase(  $privkeyfilepassphrase ) : void

Returns the private keyfile passphrase

Parameters
Name Type Description
$privkeyfilepassphrase
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpublicgetPubkeyfile( ) : void

Returns the pubkeyfile

methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicgetTodir( ) : void

Returns the destination directory

methodpublicgetUsername( ) : void

Returns the username

methodpublicinit( ) : 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.

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : 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.

methodpublicmaybeConfigure( ) : void
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodpublicsetAutocreate(  $autocreate ) : void

Sets whether to autocreate remote directories

Parameters
Name Type Description
$autocreate
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetFetch(  $fetch ) : void

Sets whether to send (default) or fetch files

Parameters
Name Type Description
$fetch
methodpublicsetFile(  $file ) : void

Sets local filename

Parameters
Name Type Description
$file
methodpublicsetHost(  $h ) : void

Sets the remote host

Parameters
Name Type Description
$h
methodpublicsetLevel( string $level ) : void

Set level of log messages generated (default = verbose)

Parameters
Name Type Description
$level string
methodpublicsetLocation( \Location $location ) : void
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetMode(  $value ) : void

Sets the mode value

Parameters
Name Type Description
$value
methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetPassword(  $password ) : void

Sets the password of the user to scp

Parameters
Name Type Description
$password
methodpublicsetPort(  $p ) : void

Sets the remote host port

Parameters
Name Type Description
$p
methodpublicsetPrivkeyfile(  $privkeyfile ) : void

Sets the private key file of the user to scp

Parameters
Name Type Description
$privkeyfile
methodpublicsetPrivkeyfilepassphrase(  $privkeyfilepassphrase ) : void

Sets the private key file passphrase of the user to scp

Parameters
Name Type Description
$privkeyfilepassphrase
methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetPubkeyfile(  $pubkeyfile ) : void

Sets the public key file of the user to scp

Parameters
Name Type Description
$pubkeyfile
methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetTodir(  $todir ) : void

Set destination directory

Parameters
Name Type Description
$todir
methodpublicsetUsername(  $username ) : void

Sets the username of the user to scp

Parameters
Name Type Description
$username
Documentation was generated by DocBlox 0.18.1.