Inheritance diagram for Ftp:

Public Member Functions
	open (array $args=[])

	close ()

	mkdir ($dir, $mode=0777, $recursive=true)

	rmdir ($dir, $recursive=false)

	pwd ()

	cd ($dir)

	read ($filename, $dest=null)

	write ($filename, $src, $mode=null)

	rm ($filename)

	mv ($src, $dest)

	chmod ($filename, $mode)

	ls ($grep=null)

Public Member Functions inherited from AbstractIo
	setAllowCreateFolders ($flag)

	open (array $args=[])

	dirsep ()

	getCleanPath ($path)

	allowedPath ($haystackPath, $needlePath)

Data Fields
const	ERROR_EMPTY_HOST = 1

const	ERROR_INVALID_CONNECTION = 2

const	ERROR_INVALID_LOGIN = 3

const	ERROR_INVALID_PATH = 4

const	ERROR_INVALID_MODE = 5

const	ERROR_INVALID_DESTINATION = 6

const	ERROR_INVALID_SOURCE = 7

Protected Member Functions
	_tmpFilename ($new=false)

Protected Attributes
	$_config

	$_conn

	$_error

	$_tmpFilename

Protected Attributes inherited from AbstractIo
	$_allowCreateFolders = false

Detailed Description

FTP client

Definition at line 15 of file Ftp.php.

Member Function Documentation

◆ _tmpFilename()

_tmpFilename ( $new = false )

protected

Parameters

bool $new

Returns: string

Definition at line 330 of file Ftp.php.

     {
         if ($new || !$this->_tmpFilename) {
             $this->_tmpFilename = tempnam(md5(uniqid(rand(), true)), '');
         }
         return $this->_tmpFilename;
     }

◆ cd()

cd ( $dir )

Change current working directory

Parameters

string $dir

Returns: bool @SuppressWarnings(PHPMD.ShortMethodName)

Implements IoInterface.

Definition at line 199 of file Ftp.php.

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

◆ chmod()

chmod	(	$filename,
		$mode
	)

Change mode of a directory or a file

Parameters

string	$filename
int	$mode

Returns: bool

Implements IoInterface.

Definition at line 303 of file Ftp.php.

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

◆ close()

close ( )

Close a connection

Returns: bool

Implements IoInterface.

Definition at line 149 of file Ftp.php.

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

◆ ls()

ls ( $grep = null )

Parameters

null $grep ignored parameter

Returns: array @SuppressWarnings(PHPMD.ShortMethodName) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements IoInterface.

Definition at line 314 of file Ftp.php.

     {
         $ls = @ftp_nlist($this->_conn, '.');
 
         $list = [];
         foreach ($ls as $file) {
             $list[] = ['text' => $file, 'id' => $this->pwd() . '/' . $file];
         }
 
         return $list;
     }

◆ mkdir()

mkdir	(	$dir,
		$mode = `0777`,
		$recursive = `true`
	)

Create a directory

Todo:: implement $mode and $recursive

Parameters

string	$dir
int	$mode
bool	$recursive

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements IoInterface.

Definition at line 164 of file Ftp.php.

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

◆ mv()

mv	(	$src,
		$dest
	)

Rename or move a directory or a file

Parameters

string	$src
string	$dest

Returns: bool @SuppressWarnings(PHPMD.ShortMethodName)

Implements IoInterface.

Definition at line 291 of file Ftp.php.

     {
         return @ftp_rename($this->_conn, $src, $dest);
     }

◆ open()

open ( array $args = [] )

Open a connection

Possible argument keys:

host required
port default 21
timeout default 90
user default anonymous
password default empty
ssl default false
passive default false
path default empty
file_mode default FTP_BINARY

Parameters

array $args

Returns: true

Exceptions

LocalizedException @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Implements IoInterface.

Definition at line 77 of file Ftp.php.

     {
         if (empty($args['host'])) {
             $this->_error = self::ERROR_EMPTY_HOST;
             throw new LocalizedException(new Phrase('The specified host is empty. Set the host and try again.'));
         }
 
         if (empty($args['port'])) {
             $args['port'] = 21;
         }
 
         if (empty($args['user'])) {
             $args['user'] = 'anonymous';
             $args['password'] = '[email protected]';
         }
 
         if (empty($args['password'])) {
             $args['password'] = '';
         }
 
         if (empty($args['timeout'])) {
             $args['timeout'] = 90;
         }
 
         if (empty($args['file_mode'])) {
             $args['file_mode'] = FTP_BINARY;
         }
 
         $this->_config = $args;
 
         if (empty($this->_config['ssl'])) {
             $this->_conn = @ftp_connect($this->_config['host'], $this->_config['port'], $this->_config['timeout']);
         } else {
             $this->_conn = @ftp_ssl_connect($this->_config['host'], $this->_config['port'], $this->_config['timeout']);
         }
         if (!$this->_conn) {
             $this->_error = self::ERROR_INVALID_CONNECTION;
             throw new LocalizedException(
                 new Phrase("The FTP connection couldn't be established because of an invalid host or port.")
             );
         }
 
         if (!@ftp_login($this->_conn, $this->_config['user'], $this->_config['password'])) {
             $this->_error = self::ERROR_INVALID_LOGIN;
             $this->close();
             throw new LocalizedException(new Phrase('The username or password is invalid. Verify both and try again.'));
         }
 
         if (!empty($this->_config['path'])) {
             if (!@ftp_chdir($this->_conn, $this->_config['path'])) {
                 $this->_error = self::ERROR_INVALID_PATH;
                 $this->close();
                 throw new LocalizedException(new Phrase('The path is invalid. Verify and try again.'));
             }
         }
 
         if (!empty($this->_config['passive'])) {
             if (!@ftp_pasv($this->_conn, true)) {
                 $this->_error = self::ERROR_INVALID_MODE;
                 $this->close();
                 throw new LocalizedException(new Phrase('The file transfer mode is invalid. Verify and try again.'));
             }
         }
 
         return true;
     }

◆ pwd()

pwd ( )

Get current working directory

Returns: string

Implements IoInterface.

Definition at line 187 of file Ftp.php.

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

◆ read()

read	(	$filename,
		$dest = `null`
	)

Read a file to result, file or stream

Parameters

string	$filename
string \| resource \| null	$dest	destination file name, stream, or if null will return file contents

Returns: false|string

Implements IoInterface.

Definition at line 211 of file Ftp.php.

     {
         if (is_string($dest)) {
             $result = ftp_get($this->_conn, $dest, $filename, $this->_config['file_mode']);
         } else {
             if (is_resource($dest)) {
                 $stream = $dest;
             } elseif ($dest === null) {
                 $stream = tmpfile();
             } else {
                 $this->_error = self::ERROR_INVALID_DESTINATION;
                 return false;
             }
 
             $result = ftp_fget($this->_conn, $stream, $filename, $this->_config['file_mode']);
 
             if ($dest === null) {
                 fseek($stream, 0);
                 $result = '';
                 for ($result = ''; $s = fread($stream, 4096); $result .= $s) {
                 }
                 fclose($stream);
             }
         }
         return $result;
     }

◆ rm()

rm ( $filename )

Delete a file

Parameters

string $filename

Returns: bool @SuppressWarnings(PHPMD.ShortMethodName)

Implements IoInterface.

Definition at line 278 of file Ftp.php.

     {
         return @ftp_delete($this->_conn, $filename);
     }

◆ rmdir()

rmdir	(	$dir,
		$recursive = `false`
	)

Delete a directory

Parameters

string	$dir
bool	$recursive

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements IoInterface.

Definition at line 177 of file Ftp.php.

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

◆ write()

write	(	$filename,
		$src,
		$mode = `null`
	)

Write a file from string, file or stream

Parameters

string	$filename
string \| resource	$src	filename, string data or source stream
null	$mode

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements IoInterface.

Definition at line 247 of file Ftp.php.

     {
         if (is_string($src) && is_readable($src)) {
             return @ftp_put($this->_conn, $filename, $src, $this->_config['file_mode']);
         } else {
             if (is_string($src)) {
                 $stream = tmpfile();
                 fputs($stream, $src);
                 fseek($stream, 0);
             } elseif (is_resource($src)) {
                 $stream = $src;
             } else {
                 $this->_error = self::ERROR_INVALID_SOURCE;
                 return false;
             }
 
             $result = ftp_fput($this->_conn, $filename, $stream, $this->_config['file_mode']);
             if (is_string($src)) {
                 fclose($stream);
             }
             return $result;
         }
     }

Field Documentation

◆ $_config

$_config

protected

Definition at line 36 of file Ftp.php.

◆ $_conn

$_conn

protected

Definition at line 43 of file Ftp.php.

◆ $_error

$_error

protected

Definition at line 50 of file Ftp.php.

◆ $_tmpFilename

$_tmpFilename

protected

Definition at line 55 of file Ftp.php.

◆ ERROR_EMPTY_HOST

const ERROR_EMPTY_HOST = 1

Definition at line 17 of file Ftp.php.

◆ ERROR_INVALID_CONNECTION

const ERROR_INVALID_CONNECTION = 2

Definition at line 19 of file Ftp.php.

◆ ERROR_INVALID_DESTINATION

const ERROR_INVALID_DESTINATION = 6

Definition at line 27 of file Ftp.php.

◆ ERROR_INVALID_LOGIN

const ERROR_INVALID_LOGIN = 3

Definition at line 21 of file Ftp.php.

◆ ERROR_INVALID_MODE

const ERROR_INVALID_MODE = 5

Definition at line 25 of file Ftp.php.

◆ ERROR_INVALID_PATH

const ERROR_INVALID_PATH = 4

Definition at line 23 of file Ftp.php.

◆ ERROR_INVALID_SOURCE

const ERROR_INVALID_SOURCE = 7

Definition at line 29 of file Ftp.php.

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

vendor/magento/framework/Filesystem/Io/Ftp.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _tmpFilename()

◆ cd()

◆ chmod()

◆ close()

◆ ls()

◆ mkdir()

◆ mv()

◆ open()

◆ pwd()

◆ read()

◆ rm()

◆ rmdir()

◆ write()

Field Documentation

◆ $_config

◆ $_conn

◆ $_error

◆ $_tmpFilename

◆ ERROR_EMPTY_HOST

◆ ERROR_INVALID_CONNECTION

◆ ERROR_INVALID_DESTINATION

◆ ERROR_INVALID_LOGIN

◆ ERROR_INVALID_MODE

◆ ERROR_INVALID_PATH

◆ ERROR_INVALID_SOURCE