# tasks/ext/FtpDeployTask.php

$Id: FtpDeployTask.php 967 2010-11-04 21:22:16Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

## \FtpDeployTask
jump to top

Package: phing\tasks\ext

FtpDeployTask

Deploys a set of files to a remote FTP server.

Example usage:

Parent(s)
  \Task < \ProjectComponent
Author
  Jorrit Schippers
Since
  2.3.1
Version
  $Id: FtpDeployTask.php 967 2010-11-04 21:22:16Z mrook $

### Properties

`$clearFirst= 'false'`
Default value `false` Details

Type
  n/a

`$completeDirMap= ''`
Details

Type
  n/a

`$dir= 'null'`
Default value `null` Details

Type
  n/a

`$filesets= ''`
Details

Type
  n/a

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

Type
  n/a

`$logLevel= 'Project::MSG_VERBOSE'`
Default value `Project::MSG_VERBOSE` Details

Type
  n/a

`$mode= 'FTP_BINARY'`
Default value `FTP_BINARY` Details

Type
  n/a

`$passive= 'false'`
Default value `false` Details

Type
  n/a

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

Type
  n/a

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

Type
  n/a

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

Type
  n/a

### Methods

`__construct( ) : void`

`createFileSet( ) : void`

`getDescription( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`init( ) : void`

The init method: check if Net_FTP is available

`log( ) : void`

`main( ) : void`

The main entry point method.

`maybeConfigure( ) : void`

`perform( ) : void`

`setClearFirst( $clearFirst ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$clearFirst |  |

`setDescription( ) : void`

`setDir( $dir ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$dir |  |

`setHost( $host ) : void`

Parameters

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

`setLevel( string $level ) : void`

Set level of log messages generated (default = info)

Parameters

Name | Type | Description
--- | --- | ---
$level | string |

`setLocation( ) : void`

`setMode( $mode ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$mode |  |

`setOwningTarget( ) : void`

`setPassive( $passive ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$passive |  |

`setPassword( $password ) : void`

Parameters

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

`setPort( $port ) : void`

Parameters

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

`setProject( ) : void`

`setRuntimeConfigurableWrapper( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

`setUsername( $username ) : void`

Parameters

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

Documentation was generated by DocBlox 0.17.1.