PHP Класс CI_FTP, TastyIgniter

См. ссылку: http://codeigniter.com/user_guide/libraries/ftp.html
Автор: EllisLab Dev Team
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$debug boolean Specifies whether to display error messages.
$hostname string FTP Server hostname
$passive boolean Passive mode flag
$password string FTP Password
$port integer FTP Server port
$username string FTP Username

Защищенные свойства (Protected)

Свойство Тип Описание
$conn_id resource Connection ID

Открытые методы

Метод Описание
__construct ( array $config = [] ) : void Constructor
changedir ( string $path, boolean $suppress_debug = FALSE ) : boolean Change directory
chmod ( string $path, integer $perm ) : boolean Set file permissions
close ( ) : boolean Close the connection
connect ( array $config = [] ) : boolean FTP Connect
delete_dir ( string $filepath ) : boolean Delete a folder and recursively delete everything (including sub-folders) contained within it.
delete_file ( string $filepath ) : boolean Rename (or move) a file
download ( string $rempath, string $locpath, string $mode = 'auto' ) : boolean Download a file from a remote server to the local server
initialize ( array $config = [] ) : void Initialize preferences
list_files ( string $path = '.' ) : array FTP List files in the specified directory
mirror ( string $locpath, string $rempath ) : boolean Read a directory and recreate it remotely
mkdir ( string $path, integer $permissions = NULL ) : boolean Create a directory
move ( string $old_file, string $new_file ) : boolean Move a file
rename ( string $old_file, string $new_file, boolean $move = FALSE ) : boolean Rename (or move) a file
upload ( string $locpath, string $rempath, string $mode = 'auto', integer $permissions = NULL ) : boolean Upload a file to the server

Защищенные методы

Метод Описание
_error ( string $line ) : void Display error message
_getext ( string $filename ) : string Extract the file extension
_is_conn ( ) : boolean Validates the connection ID
_login ( ) : boolean FTP Login
_settype ( string $ext ) : string Set the upload type

Описание методов

__construct() публичный Метод

Constructor
public __construct ( array $config = [] ) : void
$config array
Результат void

_error() защищенный Метод

Display error message
protected _error ( string $line ) : void
$line string
Результат void

_getext() защищенный Метод

Extract the file extension
protected _getext ( string $filename ) : string
$filename string
Результат string

_is_conn() защищенный Метод

Validates the connection ID
protected _is_conn ( ) : boolean
Результат boolean

_login() защищенный Метод

FTP Login
protected _login ( ) : boolean
Результат boolean

_settype() защищенный Метод

Set the upload type
protected _settype ( string $ext ) : string
$ext string Filename extension
Результат string

changedir() публичный Метод

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.
public changedir ( string $path, boolean $suppress_debug = FALSE ) : boolean
$path string
$suppress_debug boolean
Результат boolean

chmod() публичный Метод

Set file permissions
public chmod ( string $path, integer $perm ) : boolean
$path string File path
$perm integer Permissions
Результат boolean

close() публичный Метод

Close the connection
public close ( ) : boolean
Результат boolean

connect() публичный Метод

FTP Connect
public connect ( array $config = [] ) : boolean
$config array Connection values
Результат boolean

delete_dir() публичный Метод

Delete a folder and recursively delete everything (including sub-folders) contained within it.
public delete_dir ( string $filepath ) : boolean
$filepath string
Результат boolean

delete_file() публичный Метод

Rename (or move) a file
public delete_file ( string $filepath ) : boolean
$filepath string
Результат boolean

download() публичный Метод

Download a file from a remote server to the local server
public download ( string $rempath, string $locpath, string $mode = 'auto' ) : boolean
$rempath string
$locpath string
$mode string
Результат boolean

initialize() публичный Метод

Initialize preferences
public initialize ( array $config = [] ) : void
$config array
Результат void

list_files() публичный Метод

FTP List files in the specified directory
public list_files ( string $path = '.' ) : array
$path string
Результат array

mirror() публичный Метод

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 mirror ( string $locpath, string $rempath ) : boolean
$locpath string Path to source with trailing slash
$rempath string Path to destination - include the base folder with trailing slash
Результат boolean

mkdir() публичный Метод

Create a directory
public mkdir ( string $path, integer $permissions = NULL ) : boolean
$path string
$permissions integer
Результат boolean

move() публичный Метод

Move a file
public move ( string $old_file, string $new_file ) : boolean
$old_file string
$new_file string
Результат boolean

rename() публичный Метод

Rename (or move) a file
public rename ( string $old_file, string $new_file, boolean $move = FALSE ) : boolean
$old_file string
$new_file string
$move boolean
Результат boolean

upload() публичный Метод

Upload a file to the server
public upload ( string $locpath, string $rempath, string $mode = 'auto', integer $permissions = NULL ) : boolean
$locpath string
$rempath string
$mode string
$permissions integer
Результат boolean

Описание свойств

$conn_id защищенное свойство

Connection ID
protected resource $conn_id
Результат resource

$debug публичное свойство

Specifies whether to display error messages.
public bool $debug
Результат boolean

$hostname публичное свойство

FTP Server hostname
public string $hostname
Результат string

$passive публичное свойство

Passive mode flag
public bool $passive
Результат boolean

$password публичное свойство

FTP Password
public string $password
Результат string

$port публичное свойство

FTP Server port
public int $port
Результат integer

$username публичное свойство

FTP Username
public string $username
Результат string