# tasks/ext/SshTask.php

Execute commands on a remote host using ssh.

Author
  Johan Van den Brande
Package
  phing.tasks.ext
Version
  $Id: SshTask.php 1205 2011-07-02 10:34:13Z mrook $

## \SshTask
jump to top

Package: phing\tasks\ext

Execute commands on a remote host using ssh.

Use {@link Project#createTask} to register a new Task.

Parent(s)
  \Task < \ProjectComponent
Author
  Johan Van den Brande
Copyright
  2001,2002 THYRELL. All rights reserved
Version
  $Id: SshTask.php 1205 2011-07-02 10:34:13Z mrook $

### Properties

`$command= '""'`
Default value`""`Details

Type

`string $description= ''`
inherited

description of the taskInherited from: \Task::$description
Details

Type
  string
Inherited_from
  \Task::$description

`boolean $display= 'true'`

Whether to display the output of the command

Default value `true` Details

Type
  boolean

`$host= '""'`
Default value`""`Details

Type

`\Location $location= ''`
inherited

stored buildfile locationInherited from: \Task::$location
Details

Type
  \Location
Inherited_from
  \Task::$location

`$password= '""'`
Default value`""`Details

Type

`$port= '22'`
Default value `22` Details

Type

`$privkeyfile= ''''`
Default value`''`Details

Type

`$privkeyfilepassphrase= ''''`
Default value`''`Details

Type

`\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
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

`string $property= '""'`

The name of the property to capture (any) output of the command

Default value`""`Details

Type
  string

`$pubkeyfile= ''''`
Default value`''`Details

Type

`\Target $target= ''`
inherited

owning Target objectInherited from: \Task::$target
Details

Type
  \Target
Inherited_from
  \Task::$target

`string $taskName= ''`
inherited

Taskname for loggerInherited from: \Task::$taskName
Details

Type
  string
Inherited_from
  \Task::$taskName

`string $taskType= ''`
inherited

internal taskname (req)Inherited from: \Task::$taskType
Details

Type
  string
Inherited_from
  \Task::$taskType

`$username= '""'`
Default value`""`Details

Type

`\RuntimeConfigurable $wrapper= ''`
inherited

wrapper of the taskInherited from: \Task::$wrapper
Details

Type
  \RuntimeConfigurable
Inherited_from
  \Task::$wrapper

### Methods

`getCommand( ) : void`

`getDescription( ) : string`
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns

Type | Description
--- | ---
string | The text description of the task

`getHost( ) : void`

`getLocation( ) : \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.

`getOwningTarget( ) : \Target`
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns

Type | Description
--- | ---
\Target | The target object that owns this task

`getPassword( ) : void`

`getPort( ) : void`

`getPrivkeyfile( ) : void`

Returns the private keyfile

`getPrivkeyfilepassphrase( $privkeyfilepassphrase ) : void`

Returns the private keyfile passphrase

Parameters

Name | Type | Description
--- | --- | ---
$privkeyfilepassphrase |  |

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getPubkeyfile( ) : void`

Returns the pubkeyfile

`getRegisterSlot( $slotName ) : void`
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters

Name | Type | Description
--- | --- | ---
$slotName |  |

`getRuntimeConfigurableWrapper( ) : \RuntimeConfigurable`
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns

Type | Description
--- | ---
\RuntimeConfigurable | The wrapper object used by this task

`getTaskName( ) : string`
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns

Type | Description
--- | ---
string | Name of this task

`getTaskType( ) : 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)

`getUsername( ) : void`

`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.

Throws

Exception | Description
--- | ---
\BuildException |

`log( string $msg, integer $level = Project::MSG_INFO ) : void`
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg | string | The message to log
$level | integer | The priority of the message

Details

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`
inherited

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

Inherited from: \Task::maybeConfigure()
`perform( ) : void`
inherited

Perfrom this task

Inherited from: \Task::perform()
`setCommand( $command ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$command |  |

`setDescription( 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

`setDisplay( boolean $display ) : void`

Sets whether to display the output of the command

Parameters

Name | Type | Description
--- | --- | ---
$display | boolean |

`setHost( $host ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$host |  |

`setLocation( \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.

`setOwningTarget( \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

`setPassword( $password ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$password |  |

`setPort( $port ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$port |  |

`setPrivkeyfile( $privkeyfile ) : void`

Sets the private key file of the user to scp

Parameters

Name | Type | Description
--- | --- | ---
$privkeyfile |  |

`setPrivkeyfilepassphrase( $privkeyfilepassphrase ) : void`

Sets the private key file passphrase of the user to scp

Parameters

Name | Type | Description
--- | --- | ---
$privkeyfilepassphrase |  |

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

`setProperty( string $property ) : void`

Sets the name of the property to capture (any) output of the command

Parameters

Name | Type | Description
--- | --- | ---
$property | string |

`setPubkeyfile( $pubkeyfile ) : void`

Sets the public key file of the user to scp

Parameters

Name | Type | Description
--- | --- | ---
$pubkeyfile |  |

`setRuntimeConfigurableWrapper( \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

`setTaskName( $name ) : string`
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

Returns

Type | Description
--- | ---
string | A string representing the name of this task for log

`setTaskType( 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)

`setUsername( $username ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$username |  |

Documentation was generated by DocBlox 0.15.1.