phing-tasks-ext

# Class: ScpSendTask Source Location: /tasks/ext/ScpSendTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --ScpSendTask
SCPs a File to a remote server #### Author(s): Andrew Eddie <andrew.eddie@jamboworks.com> #### Version: $Id: ScpSendTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods getHost getLocalFile getMode getPassword getPort getRemoteFile getUsername init main setHost setLocalFile setMode setPassword setPort setRemoteFile setUsername
### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: Task Task::getDescription() Returns the textual description of the task Task::getLocation() Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages. Task::getOwningTarget() Returns the owning target of this task. Task::getRegisterSlot() Returns a name Task::getRuntimeConfigurableWrapper() Returns the wrapper object for runtime configuration Task::getTaskName() Returns the name of task, used only for log messages Task::getTaskType() Returns the name of the task under which it was invoked, usually the XML tagname Task::init() Called by the parser to let the task initialize properly. Task::log() Provides a project level log event to the task. Task::main() 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 <em>phing target1 target2</em> will run all tasks in target3 twice. Task::maybeConfigure() Configure this task if it hasn't been done already. Task::perform() Perfrom this task Task::setDescription() Sets a textual description of the task Task::setLocation() Sets the location within the buildfile this task occurs. Called by the parser to set location information. Task::setOwningTarget() Sets the owning target this task belongs to. Task::setRuntimeConfigurableWrapper() Sets the wrapper object this task should use for runtime configurable elements. Task::setTaskName() Sets the name of this task for log messages Task::setTaskType() Sets the type of the task. Usually this is the name of the XML tag #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 32] SCPs a File to a remote server #### Tags:
author: | Andrew Eddie <andrew.eddie@jamboworks.com>
version: | $Id: ScpSendTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
since: | 2.3.0
[ Top ] ### Class Methods ### method getHost [line 61]
`void getHost( )`
Returns the remote host [ Top ] ### method getLocalFile [line 141]
`void getLocalFile( $lFile)`
Returns the local path to scp from #### Parameters:
| $lFile |
[ Top ] ### method getMode [line 93]
`void getMode( )`
Returns the mode value [ Top ] ### method getPassword [line 125]
`void getPassword( )`
Returns the password [ Top ] ### method getPort [line 77]
`void getPort( )`
Returns the remote host port [ Top ] ### method getRemoteFile [line 157]
`void getRemoteFile( $rFile)`
Returns the remote path to scp to #### Parameters:
| $rFile |
[ Top ] ### method getUsername [line 109]
`void getUsername( )`
Returns the username [ Top ] ### method init [line 165]
`void init( )`
The init method: Do init steps. #### Tags:
access: | public
Overrides Task::init() (Called by the parser to let the task initialize properly.) [ Top ] ### method main [line 178]
`void main( )`
The main entry point method. #### Tags:
access: | public
Overrides Task::main() (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 <em>phing target1 target2</em> will run all tasks in target3 twice.) [ Top ] ### method setHost [line 53]
`void setHost( $h)`
Sets the remote host #### Parameters:
| $h |
[ Top ] ### method setLocalFile [line 133]
`void setLocalFile( $lFile)`
Sets the local path to scp from #### Parameters:
| $lFile |
[ Top ] ### method setMode [line 85]
`void setMode( $value)`
Sets the mode value #### Parameters:
| $value |
[ Top ] ### method setPassword [line 117]
`void setPassword( $password)`
Sets the password of the user to scp #### Parameters:
| $password |
[ Top ] ### method setPort [line 69]
`void setPort( $p)`
Sets the remote host port #### Parameters:
| $p |
[ Top ] ### method setRemoteFile [line 149]
`void setRemoteFile( $rFile)`
Sets the remote path to scp to #### Parameters:
| $rFile |
[ Top ] ### method setUsername [line 101]
`void setUsername( $username)`
Sets the username of the user to scp #### Parameters:
| $username |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:57 +0200 by phpDocumentor 1.4.3