ftp.lib.php File Reference

Set of functions used for FTP. More...

Go to the source code of this file.

Functions
	dol_ftp_connect ($ftp_server, $ftp_port, $ftp_user, $ftp_password, $section, $ftp_passive=0)
	Connect to FTP server.
	ftp_isdir ($connect_id, $dir)
	Tell if an entry is a FTP directory.
	dol_ftp_close ($connect_id)
	Tell if an entry is a FTP directory.
	dol_ftp_delete ($connect_id, $file, $newsection)
	Delete a FTP file.
	dol_ftp_get ($connect_id, $localfile, $file, $newsection)
	Download a FTP file.
	dol_ftp_put ($connect_id, $file, $localfile, $newsection)
	Upload a FTP file.
	dol_ftp_rmdir ($connect_id, $file, $newsection)
	Remove FTP directory.
	dol_ftp_mkdir ($connect_id, $newdir, $newsection)
	Remove FTP directory.

Detailed Description

Set of functions used for FTP.

Definition in file ftp.lib.php.

Function Documentation

dol_ftp_close()

dol_ftp_close

(

$connect_id

)

Tell if an entry is a FTP directory.

Parameters

resource

$connect_id

Connection handler

Returns

boolean Result of closing

Definition at line 145 of file ftp.lib.php.

References $conf, and getDolGlobalString().

dol_ftp_connect()

dol_ftp_connect	(		$ftp_server,
			$ftp_port,
			$ftp_user,
			$ftp_password,
			$section,
			$ftp_passive = 0 )

Connect to FTP server.

Parameters

string	$ftp_server	Server name
string	$ftp_port	Server port
string	$ftp_user	FTP user
string	$ftp_password	FTP password
string	$section	Directory
integer	$ftp_passive	Use a passive mode

Returns

array{conn_id:false|null|resource,ok:int<0,1>,mesg:string,curdir:string,curdiriso:string} Result of connect

Definition at line 39 of file ftp.lib.php.

References $conf, dol_syslog(), and getDolGlobalString().

dol_ftp_delete()

dol_ftp_delete	(		$connect_id,
			$file,
			$newsection )

Delete a FTP file.

Parameters

resource	$connect_id	Connection handler
string	$file	File
string	$newsection	$newsection

Returns

bool

Definition at line 166 of file ftp.lib.php.

References $conf, dol_syslog(), and getDolGlobalString().

dol_ftp_get()

dol_ftp_get	(		$connect_id,
			$localfile,
			$file,
			$newsection )

Download a FTP file.

Parameters

resource	$connect_id	Connection handler
string	$localfile	The local file path
string	$file	The remote file path
string	$newsection	$newsection

Returns

bool|resource

Definition at line 197 of file ftp.lib.php.

References $conf, and getDolGlobalString().

dol_ftp_mkdir()

dol_ftp_mkdir	(		$connect_id,
			$newdir,
			$newsection )

Remove FTP directory.

Parameters

resource	$connect_id	Connection handler
string	$newdir	Dir create
string	$newsection	$newsection

Returns

bool|string

Definition at line 283 of file ftp.lib.php.

References $conf, and getDolGlobalString().

dol_ftp_put()

dol_ftp_put	(		$connect_id,
			$file,
			$localfile,
			$newsection )

Upload a FTP file.

Parameters

resource	$connect_id	Connection handler
string	$file	File name
string	$localfile	The path to the local file
string	$newsection	$newsection

Returns

bool

Definition at line 226 of file ftp.lib.php.

References $conf, and getDolGlobalString().

dol_ftp_rmdir()

dol_ftp_rmdir	(		$connect_id,
			$file,
			$newsection )

Remove FTP directory.

Parameters

resource	$connect_id	Connection handler
string	$file	File
string	$newsection	$newsection

Returns

bool

Definition at line 254 of file ftp.lib.php.

References $conf, and getDolGlobalString().

ftp_isdir()

ftp_isdir	(		$connect_id,
			$dir )

Tell if an entry is a FTP directory.

Parameters

resource	$connect_id	Connection handler
string	$dir	Directory

Returns

int 1=directory, 0=not a directory

Definition at line 129 of file ftp.lib.php.