Ftp Class Reference

Public Member Functions
	mdkir ($name)
	mkdirRecursive ($path, $mode=0777)
	login ($login="anonymous", $password="[email protected]")
	validateConnectionString ($string)
	connect ($string, $timeout=900)
	fput ($remoteFile, $handle, $mode=FTP_BINARY, $startPos=0)
	put ($remoteFile, $localFile, $mode=FTP_BINARY, $startPos=0)
	getcwd ()
	raw ($cmd)
	upload ($remote, $local, $dirMode=0777, $ftpMode=FTP_BINARY)
	download ($remote, $local, $ftpMode=FTP_BINARY)
	pasv ($pasv)
	close ()
	chmod ($mode, $remoteFile)
	chdir ($dir)
	cdup ()
	get ($localFile, $remoteFile, $fileMode=FTP_BINARY, $resumeOffset=0)
	nlist ($dir="/")
	rawlist ($dir="/", $recursive=false)
	fileExists ($path, $excludeIfIsDir=true)
	ls ($dir="/", $recursive=false)
	correctFilePath ($str)
	delete ($file)

Static Public Member Functions
static	byteconvert ($bytes)
static	chmodnum ($chmod)

Protected Member Functions
	checkConnected ()

Protected Attributes
	$_conn = false

Detailed Description

Class to work with remote FTP server

Definition at line 12 of file Ftp.php.

Member Function Documentation

byteconvert()

static byteconvert (   $bytes )

static

Convert byte count to float KB/MB format

Parameters

int

$bytes

Returns

string

Definition at line 384 of file Ftp.php.

    {
        $symbol = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
        $exp = floor(log($bytes) / log(1024));
        return sprintf('%.2f ' . $symbol[$exp], $bytes / pow(1024, floor($exp)));
    }

cdup()

cdup

(

)

ftp_cdup wrapper

Returns

bool

Definition at line 328 of file Ftp.php.

    {
        $this->checkConnected();
        return @ftp_cdup($this->_conn);
    }

chdir()

chdir

(

$dir

)

ftp_chdir wrapper

Parameters

string

$dir

Returns

bool

Definition at line 317 of file Ftp.php.

    {
        $this->checkConnected();
        return @ftp_chdir($this->_conn, $dir);
    }

checkConnected()

checkConnected ( )

protected

Check connected, throw exception if not

Exceptions

Definition at line 27 of file Ftp.php.

    {
        if (!$this->_conn) {
            throw new \Exception(__CLASS__ . " - no connection established with server");
        }
    }

chmod()

chmod	(		$mode,
			$remoteFile
	)

ftp_chmod wrapper

Parameters

int	$mode
string	$remoteFile

Returns

int The new file permissions on success or FALSE on error.

Definition at line 305 of file Ftp.php.

    {
        $this->checkConnected();
        return @ftp_chmod($this->_conn, $mode, $remoteFile);
    }

chmodnum()

static chmodnum (   $chmod )

static

Chmod string "-rwxrwxrwx" to "777" converter

Parameters

string

$chmod

Returns

string

Definition at line 397 of file Ftp.php.

    {
        $trans = ['-' => '0', 'r' => '4', 'w' => '2', 'x' => '1'];
        $chmod = substr(strtr($chmod, $trans), 1);
        $array = str_split($chmod, 3);
        return array_sum(str_split($array[0])) . array_sum(str_split($array[1])) . array_sum(str_split($array[2]));
    }

close()

close

(

)

Close FTP connection

Returns

void

Definition at line 291 of file Ftp.php.

    {
        if ($this->_conn) {
            @ftp_close($this->_conn);
        }
    }

connect()

connect	(		$string,
			$timeout = 900
	)

Connect to server using connect string Connection string: ftp://user:pass@server:port/path user,pass,port,path are optional parts

Parameters

string	$string
int	$timeout

Returns

void

Exceptions

Definition at line 127 of file Ftp.php.

    {
        $params = $this->validateConnectionString($string);
        $port = isset($params['port']) ? intval($params['port']) : 21;

        $this->_conn = ftp_connect($params['host'], $port, $timeout);

        if (!$this->_conn) {
            throw new \Exception("Cannot connect to host: {$params['host']}");
        }
        if (isset($params['user']) && isset($params['pass'])) {
            $this->login($params['user'], $params['pass']);
        } else {
            $this->login();
        }
        if (isset($params['path'])) {
            if (!$this->chdir($params['path'])) {
                throw new \Exception("Cannot chdir after login to: {$params['path']}");
            }
        }
    }

correctFilePath()

correctFilePath

(

$str

)

Correct file path

Parameters

string

$str

Returns

string

Definition at line 478 of file Ftp.php.

    {
        $str = str_replace("\\", "/", $str);
        $str = preg_replace("/^.\//", "", $str);
        return $str;
    }

delete()

delete

(

$file

)

Delete file

Parameters

string

$file

Returns

bool

Definition at line 491 of file Ftp.php.

    {
        $this->checkConnected();
        $file = $this->correctFilePath($file);
        return @ftp_delete($this->_conn, $file);
    }

download()

download	(		$remote,
			$local,
			$ftpMode = FTP_BINARY
	)

Download remote file to local machine

Parameters

string	$remote
string	$local
int	$ftpMode	FTP_BINARY|FTP_ASCII

Returns

bool

Definition at line 268 of file Ftp.php.

    {
        $this->checkConnected();
        return $this->get($local, $remote, $ftpMode);
    }

fileExists()

fileExists	(		$path,
			$excludeIfIsDir = true
	)

Check whether file exists

Parameters

string	$path
bool	$excludeIfIsDir

Returns

bool

Definition at line 412 of file Ftp.php.

    {
        $path = $this->correctFilePath($path);
        $globalPathMode = substr($path, 0, 1) == "/";

        $file = basename($path);
        $dir = $globalPathMode ? dirname($path) : $this->getcwd() . "/" . $path;
        $data = $this->ls($dir);
        foreach ($data as $row) {
            if ($file == $row['name']) {
                if ($excludeIfIsDir && $row['dir']) {
                    continue;
                }
                return true;
            }
        }
        return false;
    }

fput()

fput	(		$remoteFile,
			$handle,
			$mode = FTP_BINARY,
			$startPos = 0
	)

ftp_fput wrapper

Parameters

string	$remoteFile
resource	$handle
int	$mode	FTP_BINARY | FTP_ASCII
int	$startPos

Returns

bool

Definition at line 158 of file Ftp.php.

    {
        $this->checkConnected();
        return @ftp_fput($this->_conn, $remoteFile, $handle, $mode, $startPos);
    }

get()

get	(		$localFile,
			$remoteFile,
			$fileMode = FTP_BINARY,
			$resumeOffset = 0
	)

ftp_get wrapper

Parameters

string	$localFile
string	$remoteFile
int	$fileMode	FTP_BINARY | FTP_ASCII
int	$resumeOffset

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 344 of file Ftp.php.

    {
        $remoteFile = $this->correctFilePath($remoteFile);
        $this->checkConnected();
        return @ftp_get($this->_conn, $localFile, $remoteFile, $fileMode, $resumeOffset);
    }

getcwd()

getcwd

(

)

Get current working directory

Returns

false|string

Definition at line 184 of file Ftp.php.

    {
        $d = $this->raw("pwd");
        $data = explode(" ", $d[0], 3);
        if (empty($data[1])) {
            return false;
        }
        if (intval($data[0]) != 257) {
            return false;
        }
        $out = trim($data[1], '"');
        if ($out !== "/") {
            $out = rtrim($out, "/");
        }
        return $out;
    }

login()

login	(		$login = "anonymous",
			$password = "[email protected]"
	)

Try to login to server

Parameters

string	$login
string	$password

Returns

bool

Exceptions

Definition at line 82 of file Ftp.php.

    {
        $this->checkConnected();
        $res = @ftp_login($this->_conn, $login, $password);
        if (!$res) {
            throw new \Exception("Invalid login credentials");
        }
        return $res;
    }

ls()

ls	(		$dir = "/",
			$recursive = false
	)

Get directory contents in PHP array

Parameters

string	$dir
bool	$recursive

Returns

array @SuppressWarnings(PHPMD.ShortMethodName)

Definition at line 439 of file Ftp.php.

    {
        $dir = $this->correctFilePath($dir);
        $rawfiles = (array)$this->rawlist($dir, $recursive);
        $structure = [];
        $arraypointer = & $structure;
        foreach ($rawfiles as $rawfile) {
            if ($rawfile[0] == '/') {
                $paths = array_slice(explode('/', str_replace(':', '', $rawfile)), 1);
                $arraypointer = & $structure;
                foreach ($paths as $path) {
                    foreach ($arraypointer as $i => $file) {
                        if ($file['name'] == $path) {
                            $arraypointer = & $arraypointer[$i]['children'];
                            break;
                        }
                    }
                }
            } elseif (!empty($rawfile)) {
                $info = preg_split("/[\s]+/", $rawfile, 9);
                $arraypointer[] = [
                    'name' => $info[8],
                    'dir' => $info[0][0] == 'd',
                    'size' => (int)$info[4],
                    'chmod' => self::chmodnum($info[0]),
                    'rawdata' => $info,
                    'raw' => $rawfile,
                ];
            }
        }
        return $structure;
    }

mdkir()

mdkir

(

$name

)

ftp_mkdir wrapper

Parameters

string

$name

Returns

string the newly created directory name on success or FALSE on error.

Definition at line 40 of file Ftp.php.

    {
        $this->checkConnected();
        return @ftp_mkdir($this->_conn, $name);
    }

mkdirRecursive()

mkdirRecursive	(		$path,
			$mode = 0777
	)

Make dir recursive

Parameters

string	$path
int	$mode

Returns

bool

Definition at line 53 of file Ftp.php.

    {
        $this->checkConnected();
        $dir = explode("/", $path);
        $path = "";
        $ret = true;
        for ($i = 0; $i < count($dir); $i++) {
            $path .= "/" . $dir[$i];
            if (!@ftp_chdir($this->_conn, $path)) {
                @ftp_chdir($this->_conn, "/");
                if (!@ftp_mkdir($this->_conn, $path)) {
                    $ret = false;
                    break;
                } else {
                    @ftp_chmod($this->_conn, $mode, $path);
                }
            }
        }
        return $ret;
    }

nlist()

nlist

(

$dir = "/"

)

ftp_nlist wrapper

Parameters

string

$dir

Returns

bool

Definition at line 357 of file Ftp.php.

    {
        $this->checkConnected();
        $dir = $this->correctFilePath($dir);
        return @ftp_nlist($this->_conn, $dir);
    }

pasv()

pasv

(

$pasv

)

ftp_pasv wrapper

Parameters

bool

$pasv

Returns

bool

Definition at line 280 of file Ftp.php.

    {
        $this->checkConnected();
        return @ftp_pasv($this->_conn, (bool)$pasv);
    }

put()

put	(		$remoteFile,
			$localFile,
			$mode = FTP_BINARY,
			$startPos = 0
	)

ftp_put wrapper

Parameters

string	$remoteFile
string	$localFile
int	$mode	FTP_BINARY | FTP_ASCII
int	$startPos

Returns

bool

Definition at line 173 of file Ftp.php.

    {
        $this->checkConnected();
        return ftp_put($this->_conn, $remoteFile, $localFile, $mode, $startPos);
    }

raw()

raw

(

$cmd

)

ftp_raw wrapper

Parameters

string

$cmd

Returns

array The server's response as an array of strings.

Definition at line 207 of file Ftp.php.

    {
        $this->checkConnected();
        return @ftp_raw($this->_conn, $cmd);
    }

rawlist()

rawlist	(		$dir = "/",
			$recursive = false
	)

ftp_rawlist wrapper

Parameters

string	$dir
bool	$recursive

Returns

array an array where each element corresponds to one line of text.

Definition at line 371 of file Ftp.php.

    {
        $this->checkConnected();
        $dir = $this->correctFilePath($dir);
        return @ftp_rawlist($this->_conn, $dir, $recursive);
    }

upload()

upload	(		$remote,
			$local,
			$dirMode = 0777,
			$ftpMode = FTP_BINARY
	)

Upload local file to remote

Can be used for relative and absoulte remote paths Relative: use chdir before calling this

Parameters

string	$remote
string	$local
int	$dirMode
int	$ftpMode

Returns

bool

Exceptions

Definition at line 226 of file Ftp.php.

    {
        $this->checkConnected();

        if (!file_exists($local)) {
            throw new \Exception("Local file doesn't exist: {$local}");
        }
        if (!is_readable($local)) {
            throw new \Exception("Local file is not readable: {$local}");
        }
        if (is_dir($local)) {
            throw new \Exception("Directory given instead of file: {$local}");
        }

        $globalPathMode = substr($remote, 0, 1) == "/";
        $dirname = dirname($remote);
        $cwd = $this->getcwd();
        if (false === $cwd) {
            throw new \Exception("Server returns something awful on PWD command");
        }

        if (!$globalPathMode) {
            $dirname = $cwd . "/" . $dirname;
            $remote = $cwd . "/" . $remote;
        }
        $res = $this->mkdirRecursive($dirname, $dirMode);
        $this->chdir($cwd);

        if (!$res) {
            return false;
        }
        return $this->put($remote, $local, $ftpMode);
    }

validateConnectionString()

validateConnectionString

(

$string

)

Validate connection string

Parameters

string

$string

Exceptions

Definition at line 99 of file Ftp.php.

    {
        $data = parse_url($string);
        if (false === $data) {
            throw new \Exception("Connection string invalid: '{$string}'");
        }
        if ($data['scheme'] != 'ftp') {
            throw new \Exception("Support for scheme unsupported: '{$data['scheme']}'");
        }
        
        // Decode user & password strings from URL
        foreach (array_intersect(array_keys($data), ['user','pass']) as $key) {
            $data[$key] = urldecode($data[$key]);
        }
        
        return $data;
    }

Field Documentation

$_conn

$_conn = false

protected

Definition at line 19 of file Ftp.php.

---

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

• vendor/magento/framework/System/Ftp.php