Docs For Class transfer

Description

Transfer class, wrapper for ftp/sftp/ssh

Located in /includes/functions_transfer.php (line 23)

Direct descendents

Class	Description
ftp	FTP transfer class
ftp_fsock	FTP fsock transfer class

Variable Summary

mixed $connection

mixed $dir_perms

mixed $file_perms

mixed $host

mixed $password

mixed $port

mixed $root_path

mixed $timeout

mixed $tmp_path

mixed $username

Method Summary

transfer transfer ()

void close_session ()

void copy_file ( $from_loc, $to_loc)

void delete_file ( $file)

void file_exists ( $directory, $filename)

void make_dir ( $dir)

void methods ()

void open_session ()

void overwrite_file ( $source_file, $destination_file)

void remove_dir ( $dir)

void rename ( $old_handle, $new_handle)

void write_file ([ $destination_file = ''], [ $contents = ''])

Variables

mixed $connection (line 25)

mixed $dir_perms (line 34)

mixed $file_perms (line 33)

mixed $host (line 26)

mixed $password (line 29)

mixed $port (line 27)

mixed $root_path (line 31)

mixed $timeout (line 30)

mixed $tmp_path (line 32)

mixed $username (line 28)

Methods

Constructor transfer (line 39)

Constructor - init some basic values

transfer transfer ()

close_session (line 230)

Close current session

void close_session ()

copy_file (line 145)

Copy file from source location to destination location

void copy_file ( $from_loc, $to_loc)

$from_loc
$to_loc

delete_file (line 165)

Remove file

void delete_file ( $file)

$file

file_exists (line 202)

Check if a specified file exist...

void file_exists ( $directory, $filename)

$directory
$filename

make_dir (line 105)

Create directory structure

void make_dir ( $dir)

$dir

methods (line 238)

Determine methods able to be used

void methods ()

open_session (line 222)

Open session

void open_session ()

overwrite_file (line 89)

Moving file into location. If the destination file already exists it gets overwritten

void overwrite_file ( $source_file, $destination_file)

$source_file
$destination_file

remove_dir (line 178)

Remove directory

todo: remove child directories?

void remove_dir ( $dir)

$dir

rename (line 190)

Rename a file or folder

void rename ( $old_handle, $new_handle)

$old_handle
$new_handle

write_file (line 53)

Write file to location

void write_file ([ $destination_file = ''], [ $contents = ''])

$destination_file
$contents