CI_FTP Class Reference

List of all members.

Public Member Functions
	CI_FTP ($config=array())
	Constructor - Sets Preferences.
	initialize ($config=array())
	Initialize preferences.
	connect ($config=array())
	FTP Connect.
	_login ()
	FTP Login.
	_is_conn ()
	Validates the connection ID.
	changedir ($path= '', $supress_debug=FALSE)
	Change direcotry.
	mkdir ($path= '', $permissions=NULL)
	Create a directory.
	upload ($locpath, $rempath, $mode= 'auto', $permissions=NULL)
	Upload a file to the server.
	rename ($old_file, $new_file, $move=FALSE)
	Rename (or move) a file.
	move ($old_file, $new_file)
	Move a file.
	delete_file ($filepath)
	Rename (or move) a file.
	delete_dir ($filepath)
	Delete a folder and recursively delete everything (including sub-folders) containted within it.
	chmod ($path, $perm)
	Set file permissions.
	list_files ($path= '.')
	FTP List files in the specified directory.
	mirror ($locpath, $rempath)
	Read a directory and recreate it remotely.
	_getext ($filename)
	Extract the file extension.
	_settype ($ext)
	Set the upload type.
	close ()
	Close the connection.
	_error ($line)
	Display error message.
Public Attributes
	$hostname = ''
	$username = ''
	$password = ''
	$port = 21
	$passive = TRUE
	$debug = FALSE
	$conn_id = FALSE

---

Detailed Description

Definition at line 27 of file Ftp.php.

---

Member Function Documentation

CI_FTP::_error

(

$

line

)

Display error message.

private

Parameters:

string

Returns:

bool

Definition at line 606 of file Ftp.php.

References $CI, get_instance(), and show_error().

Referenced by _is_conn(), changedir(), chmod(), connect(), delete_dir(), delete_file(), mkdir(), rename(), and upload().

        {
                $CI =& get_instance();
                $CI->lang->load('ftp');
                show_error($CI->lang->line($line));             
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_FTP::_getext

(

$

filename

)

Extract the file extension.

private

Parameters:

string

Returns:

string

Definition at line 534 of file Ftp.php.

Referenced by mirror(), and upload().

        {
                if (FALSE === strpos($filename, '.'))
                {
                        return 'txt';
                }
        
                $x = explode('.', $filename);
                return end($x);
        }       

Here is the caller graph for this function:

CI_FTP::_is_conn

(

)

Validates the connection ID.

private

Returns:

bool

Definition at line 140 of file Ftp.php.

References _error().

Referenced by changedir(), chmod(), close(), delete_dir(), delete_file(), list_files(), mirror(), mkdir(), rename(), and upload().

        {
                if ( ! is_resource($this->conn_id))
                {
                        if ($this->debug == TRUE)
                        {
                                $this->_error('ftp_no_connection');
                        }               
                        return FALSE;
                }
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_FTP::_login

(

)

FTP Login.

private

Returns:

bool

Definition at line 127 of file Ftp.php.

Referenced by connect().

        {
                return @ftp_login($this->conn_id, $this->username, $this->password);
        }

Here is the caller graph for this function:

CI_FTP::_settype

(

$

ext

)

Set the upload type.

private

Parameters:

string

Returns:

string

Definition at line 555 of file Ftp.php.

Referenced by mirror(), and upload().

        {
                $text_types = array(
                                                        'txt',
                                                        'text',
                                                        'php',
                                                        'phps',
                                                        'php4',
                                                        'js',
                                                        'css',
                                                        'htm',
                                                        'html',
                                                        'phtml',
                                                        'shtml',
                                                        'log',
                                                        'xml'
                                                        );
        
        
                return (in_array($ext, $text_types)) ? 'ascii' : 'binary';
        }

Here is the caller graph for this function:

CI_FTP::changedir	(	$	path = '',
		$	supress_debug = FALSE
	)

Change direcotry.

The second parameter lets us momentarily turn off debugging so that this function can be used to test for the existance 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 paramter is only used by the "mirror" function below.

public

Parameters:

	string
	bool

Returns:

bool

Definition at line 170 of file Ftp.php.

References _error(), and _is_conn().

Referenced by mirror().

        {
                if ($path == '' OR ! $this->_is_conn())
                {
                        return FALSE;
                }
                
                $result = @ftp_chdir($this->conn_id, $path);
                
                if ($result === FALSE)
                {
                        if ($this->debug == TRUE AND $supress_debug == FALSE)
                        {
                                $this->_error('ftp_unable_to_changedir');
                        }               
                        return FALSE;           
                }
                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_FTP::chmod	(	$	path,
		$	perm
	)

Set file permissions.

public

Parameters:

	string	the file path
	string	the permissions

Returns:

bool

Definition at line 419 of file Ftp.php.

References _error(), and _is_conn().

Referenced by mkdir(), and upload().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                // Permissions can only be set when running PHP 5
                if ( ! function_exists('ftp_chmod'))
                {
                        if ($this->debug == TRUE)
                        {
                                $this->_error('ftp_unable_to_chmod');
                        }               
                        return FALSE;           
                }
        
                $result = @ftp_chmod($this->conn_id, $perm, $path);
                
                if ($result === FALSE)
                {
                        if ($this->debug == TRUE)
                        {
                                $this->_error('ftp_unable_to_chmod');
                        }               
                        return FALSE;           
                }
                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_FTP::CI_FTP

(

$

config = array()

)

Constructor - Sets Preferences.

The constructor can be passed an array of config values

Definition at line 43 of file Ftp.php.

References $config, initialize(), and log_message().

        {               
                if (count($config) > 0)
                {
                        $this->initialize($config);
                }       

                log_message('debug', "FTP Class Initialized");
        }

Here is the call graph for this function:

CI_FTP::close

(

)

Close the connection.

public

Parameters:

	string	path to source
	string	path to destination

Returns:

bool

Definition at line 587 of file Ftp.php.

References _is_conn().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                @ftp_close($this->conn_id);
        }

Here is the call graph for this function:

CI_FTP::connect

(

$

config = array()

)

FTP Connect.

public

Parameters:

array

the connection values

Returns:

bool

Definition at line 85 of file Ftp.php.

References $config, _error(), _login(), and initialize().

        {               
                if (count($config) > 0)
                {
                        $this->initialize($config);
                }       
        
                if (FALSE === ($this->conn_id = @ftp_connect($this->hostname, $this->port)))
                {
                        if ($this->debug == TRUE)
                        {
                                $this->_error('ftp_unable_to_connect');
                        }               
                        return FALSE;
                }
                
                if ( ! $this->_login())
                {
                        if ($this->debug == TRUE)
                        {
                                $this->_error('ftp_unable_to_login');
                        }               
                        return FALSE;
                }
                
                // Set passive mode if needed
                if ($this->passive == TRUE)
                {
                        ftp_pasv($this->conn_id, TRUE);
                }
                
                return TRUE;
        }

Here is the call graph for this function:

CI_FTP::delete_dir

(

$

filepath

)

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

public

Parameters:

string

Returns:

bool

Definition at line 370 of file Ftp.php.

References _error(), _is_conn(), and list_files().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                // Add a trailing slash to the file path if needed
                $filepath = preg_replace("/(.+?)\/*$/", "\\1/",  $filepath);
                
                $list = $this->list_files($filepath);
                
                if ($list !== FALSE AND count($list) > 0)
                {
                        foreach ($list as $item)
                        {                       
                                // If we can't delete the item it's probaly a folder so
                                // we'll recursively call delete_dir()
                                if ( ! @ftp_delete($this->conn_id, $item))
                                {
                                        $this->delete_dir($item);
                                }
                        }
                }
        
                $result = @ftp_rmdir($this->conn_id, $filepath);
                
                if ($result === FALSE)
                {
                        if ($this->debug == TRUE)
                        {                               
                                $this->_error('ftp_unable_to_delete');
                        }               
                        return FALSE;           
                }
                
                return TRUE;
        }

Here is the call graph for this function:

CI_FTP::delete_file

(

$

filepath

)

Rename (or move) a file.

public

Parameters:

string

Returns:

bool

Definition at line 339 of file Ftp.php.

References _error(), and _is_conn().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                $result = @ftp_delete($this->conn_id, $filepath);
                
                if ($result === FALSE)
                {
                        if ($this->debug == TRUE)
                        {                               
                                $this->_error('ftp_unable_to_delete');
                        }               
                        return FALSE;           
                }
                
                return TRUE;
        }

Here is the call graph for this function:

CI_FTP::initialize

(

$

config = array()

)

Initialize preferences.

public

Parameters:

array

Returns:

void

Definition at line 62 of file Ftp.php.

References $config.

Referenced by CI_FTP(), and connect().

        {
                foreach ($config as $key => $val)
                {
                        if (isset($this->$key))
                        {
                                $this->$key = $val;
                        }
                }
                
                // Prep the hostname
                $this->hostname = preg_replace('|.+?://|', '', $this->hostname);
        }

Here is the caller graph for this function:

CI_FTP::list_files

(

$

path = '.'

)

FTP List files in the specified directory.

public

Returns:

array

Definition at line 458 of file Ftp.php.

References _is_conn().

Referenced by delete_dir().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                return ftp_nlist($this->conn_id, $path);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_FTP::mirror	(	$	locpath,
		$	rempath
	)

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.

public

Parameters:

	string	path to source with trailing slash
	string	path to destination - include the base folder with trailing slash

Returns:

bool

Definition at line 482 of file Ftp.php.

References _getext(), _is_conn(), _settype(), changedir(), mkdir(), and upload().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                // Open the local file path
                if ($fp = @opendir($locpath))
                {
                        // Attempt to open the remote file path.
                        if ( ! $this->changedir($rempath, TRUE))
                        {
                                // If it doesn't exist we'll attempt to create the direcotory
                                if ( ! $this->mkdir($rempath) OR ! $this->changedir($rempath))
                                {
                                        return FALSE;
                                }
                        }
                
                        // Recursively read the local directory
                        while (FALSE !== ($file = readdir($fp)))
                        {
                                if (@is_dir($locpath.$file) && substr($file, 0, 1) != '.')
                                {                                       
                                        $this->mirror($locpath.$file."/", $rempath.$file."/");
                                }
                                elseif (substr($file, 0, 1) != ".")
                                {
                                        // Get the file extension so we can se the upload type
                                        $ext = $this->_getext($file);
                                        $mode = $this->_settype($ext);
                                        
                                        $this->upload($locpath.$file, $rempath.$file, $mode);
                                }
                        }
                        return TRUE;
                }
                
                return FALSE;
        }

Here is the call graph for this function:

CI_FTP::mkdir	(	$	path = '',
		$	permissions = NULL
	)

Create a directory.

public

Parameters:

string

Returns:

bool

Definition at line 200 of file Ftp.php.

References _error(), _is_conn(), and chmod().

Referenced by mirror().

        {
                if ($path == '' OR ! $this->_is_conn())
                {
                        return FALSE;
                }
        
                $result = @ftp_mkdir($this->conn_id, $path);
                
                if ($result === FALSE)
                {
                        if ($this->debug == TRUE)
                        {
                                $this->_error('ftp_unable_to_makdir');
                        }               
                        return FALSE;           
                }

                // Set file permissions if needed
                if ( ! is_null($permissions))
                {
                        $this->chmod($path, (int)$permissions);
                }
                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_FTP::move	(	$	old_file,
		$	new_file
	)

Move a file.

public

Parameters:

	string
	string

Returns:

bool

Definition at line 325 of file Ftp.php.

References rename().

        {
                return $this->rename($old_file, $new_file, TRUE);
        }

Here is the call graph for this function:

CI_FTP::rename	(	$	old_file,
		$	new_file,
		$	move = FALSE
	)

Rename (or move) a file.

public

Parameters:

	string
	string
	bool

Returns:

bool

Definition at line 292 of file Ftp.php.

References _error(), and _is_conn().

Referenced by move().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                $result = @ftp_rename($this->conn_id, $old_file, $new_file);
                
                if ($result === FALSE)
                {
                        if ($this->debug == TRUE)
                        {
                                $msg = ($move == FALSE) ? 'ftp_unable_to_rename' : 'ftp_unable_to_move';
                                
                                $this->_error($msg);
                        }               
                        return FALSE;           
                }
                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_FTP::upload	(	$	locpath,
		$	rempath,
		$	mode = 'auto',
		$	permissions = NULL
	)

Upload a file to the server.

public

Parameters:

	string
	string
	string

Returns:

bool

Definition at line 238 of file Ftp.php.

References _error(), _getext(), _is_conn(), _settype(), and chmod().

Referenced by mirror().

        {
                if ( ! $this->_is_conn())
                {
                        return FALSE;
                }

                if ( ! file_exists($locpath))
                {
                        $this->_error('ftp_no_source_file');
                        return FALSE;
                }
        
                // Set the mode if not specified
                if ($mode == 'auto')
                {
                        // Get the file extension so we can set the upload type
                        $ext = $this->_getext($locpath);
                        $mode = $this->_settype($ext);
                }
                
                $mode = ($mode == 'ascii') ? FTP_ASCII : FTP_BINARY;
                
                $result = @ftp_put($this->conn_id, $rempath, $locpath, $mode);
                
                if ($result === FALSE)
                {
                        if ($this->debug == TRUE)
                        {
                                $this->_error('ftp_unable_to_upload');
                        }               
                        return FALSE;           
                }
                
                // Set file permissions if needed
                if ( ! is_null($permissions))
                {
                        $this->chmod($rempath, (int)$permissions);
                }
                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

CI_FTP::$conn_id = FALSE

Definition at line 35 of file Ftp.php.

CI_FTP::$debug = FALSE

Definition at line 34 of file Ftp.php.

CI_FTP::$hostname = ''

Definition at line 29 of file Ftp.php.

CI_FTP::$passive = TRUE

Definition at line 33 of file Ftp.php.

CI_FTP::$password = ''

Definition at line 31 of file Ftp.php.

CI_FTP::$port = 21

Definition at line 32 of file Ftp.php.

CI_FTP::$username = ''

Definition at line 30 of file Ftp.php.

---

The documentation for this class was generated from the following file:

• Ftp.php