CodeIgniter v3.0.0 API
\

\CI_FTP

FTP Class

Summary

Methods
Properties
Constants
__construct()
initialize()
connect()
changedir()
mkdir()
upload()
download()
rename()
move()
delete_file()
delete_dir()
chmod()
list_files()
mirror()
close()
$hostname
$username
$password
$port
$passive
$debug
No constants found
_login()
_is_conn()
_getext()
_settype()
_error()
$conn_id
N/A
No private methods found
No private properties found
N/A

Properties

$hostname

$hostname : string

FTP Server hostname

Type

string

$username

$username : string

FTP Username

Type

string

$password

$password : string

FTP Password

Type

string

$port

$port : integer

FTP Server port

Type

integer

$passive

$passive : boolean

Passive mode flag

Type

boolean

$debug

$debug : boolean

Debug flag

Specifies whether to display error messages.

Type

boolean

$conn_id

$conn_id : resource

Connection ID

Type

resource

Methods

__construct()

__construct(array  $config = array()) : void

Constructor

Parameters

array $config

initialize()

initialize(array  $config = array()) : void

Initialize preferences

Parameters

array $config

connect()

connect(array  $config = array()) : boolean

FTP Connect

Parameters

array $config

Connection values

Returns

boolean

changedir()

changedir(string  $path, boolean  $suppress_debug = FALSE) : boolean

Change directory

The second parameter lets us momentarily turn off debugging so that this function can be used to test for the existence of a folder without throwing an error. There's no FTP equivalent to is_dir() so we do it by trying to change to a particular directory. Internally, this parameter is only used by the "mirror" function below.

Parameters

string $path
boolean $suppress_debug

Returns

boolean

mkdir()

mkdir(string  $path, integer  $permissions = NULL) : boolean

Create a directory

Parameters

string $path
integer $permissions

Returns

boolean

upload()

upload(string  $locpath, string  $rempath, string  $mode = 'auto', integer  $permissions = NULL) : boolean

Upload a file to the server

Parameters

string $locpath
string $rempath
string $mode
integer $permissions

Returns

boolean

download()

download(string  $rempath, string  $locpath, string  $mode = 'auto') : boolean

Download a file from a remote server to the local server

Parameters

string $rempath
string $locpath
string $mode

Returns

boolean

rename()

rename(string  $old_file, string  $new_file, boolean  $move = FALSE) : boolean

Rename (or move) a file

Parameters

string $old_file
string $new_file
boolean $move

Returns

boolean

move()

move(string  $old_file, string  $new_file) : boolean

Move a file

Parameters

string $old_file
string $new_file

Returns

boolean

delete_file()

delete_file(string  $filepath) : boolean

Rename (or move) a file

Parameters

string $filepath

Returns

boolean

delete_dir()

delete_dir(string  $filepath) : boolean

Delete a folder and recursively delete everything (including sub-folders) contained within it.

Parameters

string $filepath

Returns

boolean

chmod()

chmod(string  $path, integer  $perm) : boolean

Set file permissions

Parameters

string $path

File path
integer $perm

Permissions

Returns

boolean

list_files()

list_files(string  $path = '.') : array

FTP List files in the specified directory

Parameters

string $path

Returns

array

mirror()

mirror(string  $locpath, string  $rempath) : boolean

Read a directory and recreate it remotely

This function recursively reads a folder and everything it contains (including sub-folders) and creates a mirror via FTP based on it. Whatever the directory structure of the original file path will be recreated on the server.

Parameters

string $locpath

Path to source with trailing slash
string $rempath

Path to destination - include the base folder with trailing slash

Returns

boolean

close()

close() : boolean

Close the connection

Returns

boolean

_login()

_login() : boolean

FTP Login

Returns

boolean

_is_conn()

_is_conn() : boolean

Validates the connection ID

Returns

boolean

_getext()

_getext(string  $filename) : string

Extract the file extension

Parameters

string $filename

Returns

string

_settype()

_settype(string  $ext) : string

Set the upload type

Parameters

string $ext

Filename extension

Returns

string

_error()

_error(string  $line) : void

Display error message

Parameters

string $line