Sftp Class Reference

Inheritance diagram for Sftp:

Public Member Functions
	open (array $args=[])
	close ()
	mkdir ($dir, $mode=0777, $recursive=true)
	rmdir ($dir, $recursive=false)
	pwd ()
	cd ($dir)
	read ($filename, $destination=null)
	write ($filename, $source, $mode=null)
	rm ($filename)
	mv ($source, $destination)
	chmod ($filename, $mode)
	ls ($grep=null)
	rawls ()
Public Member Functions inherited from AbstractIo
	setAllowCreateFolders ($flag)
	open (array $args=[])
	dirsep ()
	getCleanPath ($path)
	allowedPath ($haystackPath, $needlePath)

Data Fields
const	REMOTE_TIMEOUT = 10
const	SSH2_PORT = 22

Protected Attributes
	$_connection = null
Protected Attributes inherited from AbstractIo
	$_allowCreateFolders = false

Detailed Description

Sftp client interface

http://www.php.net/manual/en/function.ssh2-connect.php

Definition at line 14 of file Sftp.php.

Member Function Documentation

cd()

cd

(

$dir

)

Change current working directory

Parameters

string

$dir

Returns

bool @SuppressWarnings(PHPMD.ShortMethodName)

Implements IoInterface.

Definition at line 156 of file Sftp.php.

    {
        return $this->_connection->chdir($dir);
    }

chmod()

chmod	(		$filename,
			$mode
	)

Change mode of a directory or a file

Parameters

string	$filename
int	$mode

Returns

mixed

Implements IoInterface.

Definition at line 222 of file Sftp.php.

    {
        return $this->_connection->chmod($mode, $filename);
    }

close()

close

(

)

Close a connection

Returns

void

Implements IoInterface.

Definition at line 59 of file Sftp.php.

    {
        $this->_connection->disconnect();
    }

ls()

ls

(

$grep = null

)

Get list of cwd subdirectories and files

Parameters

null

$grep

ignored parameter

Returns

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

Implements IoInterface.

Definition at line 235 of file Sftp.php.

    {
        $list = $this->_connection->nlist();
        $currentWorkingDir = $this->pwd();
        $result = [];
        foreach ($list as $name) {
            $result[] = ['text' => $name, 'id' => "{$currentWorkingDir}/{$name}"];
        }
        return $result;
    }

mkdir()

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

Create a directory

Parameters

string	$dir
int	$mode	ignored here; uses logged-in user's umask
bool	$recursive	analogous to mkdir -p

Note: if $recursive is true and an error occurs mid-execution, false is returned and some part of the hierarchy might be created. No rollback is performed.

Returns

bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements IoInterface.

Definition at line 78 of file Sftp.php.

    {
        if ($recursive) {
            $no_errors = true;
            $dirList = explode('/', $dir);
            reset($dirList);
            $currentWorkingDir = $this->_connection->pwd();
            while ($no_errors && ($dir_item = next($dirList))) {
                $no_errors = $this->_connection->mkdir($dir_item) && $this->_connection->chdir($dir_item);
            }
            $this->_connection->chdir($currentWorkingDir);
            return $no_errors;
        } else {
            return $this->_connection->mkdir($dir);
        }
    }

mv()

mv	(		$source,
			$destination
	)

Rename or move a directory or a file

Parameters

string	$source
string	$destination

Returns

bool @SuppressWarnings(PHPMD.ShortMethodName)

Implements IoInterface.

Definition at line 210 of file Sftp.php.

    {
        return $this->_connection->rename($source, $destination);
    }

open()

open

(

array

$args = []

)

Open a SFTP connection to a remote site.

Parameters

array

$args

Connection arguments string $args[host] Remote hostname string $args[username] Remote username string $args[password] Connection password int $args[timeout] Connection timeout [=10]

Returns

void

Exceptions

Implements IoInterface.

Definition at line 35 of file Sftp.php.

    {
        if (!isset($args['timeout'])) {
            $args['timeout'] = self::REMOTE_TIMEOUT;
        }
        if (strpos($args['host'], ':') !== false) {
            list($host, $port) = explode(':', $args['host'], 2);
        } else {
            $host = $args['host'];
            $port = self::SSH2_PORT;
        }
        $this->_connection = new \phpseclib\Net\SFTP($host, $port, $args['timeout']);
        if (!$this->_connection->login($args['username'], $args['password'])) {
            throw new \Exception(
                sprintf("Unable to open SFTP connection as %s@%s", $args['username'], $args['host'])
            );
        }
    }

pwd()

pwd

(

)

Get current working directory

Returns

mixed

Implements IoInterface.

Definition at line 144 of file Sftp.php.

    {
        return $this->_connection->pwd();
    }

rawls()

rawls

(

)

Returns a list of files in the current directory

Returns

mixed

Definition at line 251 of file Sftp.php.

    {
        $list = $this->_connection->rawlist();
        return $list;
    }

read()

read	(		$filename,
			$destination = null
	)

Read a file

Parameters

string	$filename	remote file name
string | null	$destination	local file name (optional)

Returns

mixed

Implements IoInterface.

Definition at line 168 of file Sftp.php.

    {
        if ($destination === null) {
            $destination = false;
        }
        return $this->_connection->get($filename, $destination);
    }

rm()

rm

(

$filename

)

Delete a file

Parameters

string

$filename

Returns

bool @SuppressWarnings(PHPMD.ShortMethodName)

Implements IoInterface.

Definition at line 197 of file Sftp.php.

    {
        return $this->_connection->delete($filename);
    }

rmdir()

rmdir	(		$dir,
			$recursive = false
	)

Delete a directory

Parameters

string	$dir
bool	$recursive

Returns

bool

Exceptions

Implements IoInterface.

Definition at line 104 of file Sftp.php.

    {
        if ($recursive) {
            $no_errors = true;
            $currentWorkingDir = $this->pwd();
            if (!$this->_connection->chdir($dir)) {
                throw new \Exception("chdir(): {$dir}: Not a directory");
            }
            $list = $this->_connection->nlist();
            if (!count($list)) {
                // Go back
                $this->_connection->chdir($currentWorkingDir);
                return $this->rmdir($dir, false);
            } else {
                foreach ($list as $filename) {
                    if ($this->_connection->chdir($filename)) {
                        // This is a directory
                        $this->_connection->chdir('..');
                        $no_errors = $no_errors && $this->rmdir($filename, $recursive);
                    } else {
                        $no_errors = $no_errors && $this->rm($filename);
                    }
                }
            }
            $no_errors = $no_errors && ($this->_connection->chdir(
                $currentWorkingDir
            ) && $this->_connection->rmdir(
                $dir
            ));
            return $no_errors;
        } else {
            return $this->_connection->rmdir($dir);
        }
    }

write()

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

Write a file

Parameters

string	$filename
string	$source	string data or local file name
int	$mode	ignored parameter

Returns

bool

Implements IoInterface.

Definition at line 184 of file Sftp.php.

    {
        $mode = is_readable($source) ? \phpseclib\Net\SFTP::SOURCE_LOCAL_FILE : \phpseclib\Net\SFTP::SOURCE_STRING;
        return $this->_connection->put($filename, $source, $mode);
    }

Field Documentation

$_connection

phpseclib Net SFTP $_connection = null

protected

Definition at line 22 of file Sftp.php.

REMOTE_TIMEOUT

const REMOTE_TIMEOUT = 10

Definition at line 16 of file Sftp.php.

SSH2_PORT

const SSH2_PORT = 22

Definition at line 17 of file Sftp.php.

---

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

• vendor/magento/framework/Filesystem/Io/Sftp.php