Inheritance diagram for League\Flysystem\Adapter\Ftp:

Collaboration diagram for League\Flysystem\Adapter\Ftp:

Public Member Functions

setTransferMode ($mode)

Set the transfer mode. More...

setSsl ($ssl)

Set if Ssl is enabled. More...

setPassive ($passive=true)

Set if passive mode should be used. More...

setIgnorePassiveAddress ($ignorePassiveAddress)

setRecurseManually ($recurseManually)

setUtf8 ($utf8)

connect ()

Connect to the FTP server. More...

disconnect ()

Disconnect from the FTP server. More...

write ($path, $contents, Config $config)

Write a new file.

Parameters

string	$path
string	$contents
Config	$config	Config object

Returns: array|false false on failure file meta data on success

More...

writeStream ($path, $resource, Config $config)

Write a new file using a stream.

Parameters

string	$path
resource	$resource
Config	$config	Config object

Returns: array|false false on failure file meta data on success

More...

update ($path, $contents, Config $config)

Update a file.

Parameters

string	$path
string	$contents
Config	$config	Config object

Returns: array|false false on failure file meta data on success

More...

updateStream ($path, $resource, Config $config)

Update a file using a stream.

Parameters

string	$path
resource	$resource
Config	$config	Config object

Returns: array|false false on failure file meta data on success

More...

rename ($path, $newpath)

Rename a file.

Parameters

string	$path
string	$newpath

Returns: bool

More...

delete ($path)

Delete a file.

Parameters

string $path

Returns: bool

More...

deleteDir ($dirname)

Delete a directory.

Parameters

string $dirname

Returns: bool

More...

createDir ($dirname, Config $config)

Create a directory.

Parameters

string	$dirname	directory name
Config	$config

Returns: array|false

More...

getMetadata ($path)

Get all the meta data of a file or directory.

Parameters

string $path

Returns: array|false

More...

getMimetype ($path)

Get the mimetype of a file.

Parameters

string $path

Returns: array|false

More...

getTimestamp ($path)

Get the timestamp of a file.

Parameters

string $path

Returns: array|false

More...

read ($path)

Read a file.

Parameters

string $path

Returns: array|false

More...

readStream ($path)

Read a file as a stream.

Parameters

string $path

Returns: array|false

More...

setVisibility ($path, $visibility)

Set the visibility for a file.

Parameters

string	$path
string	$visibility

Returns: array|false file meta data

More...

isConnected ()

Check if the connection is open. More...

Public Member Functions inherited from League\Flysystem\Adapter\AbstractFtpAdapter

__construct (array $config)

Constructor. More...

setConfig (array $config)

Set the config. More...

getHost ()

Returns the host. More...

setHost ($host)

Set the host. More...

setPermPublic ($permPublic)

Set the public permission value. More...

setPermPrivate ($permPrivate)

Set the private permission value. More...

getPort ()

Returns the ftp port. More...

getRoot ()

Returns the root folder to work from. More...

setPort ($port)

Set the ftp port. More...

setRoot ($root)

Set the root folder to work from. More...

getUsername ()

Returns the ftp username. More...

setUsername ($username)

Set ftp username. More...

getPassword ()

Returns the password. More...

setPassword ($password)

Set the ftp password. More...

getTimeout ()

Returns the amount of seconds before the connection will timeout. More...

setTimeout ($timeout)

Set the amount of seconds before the connection should timeout. More...

getSystemType ()

Return the FTP system type. More...

setSystemType ($systemType)

Set the FTP system type (windows or unix). More...

listContents ($directory='', $recursive=false)

List contents of a directory.

Parameters

string	$directory
bool	$recursive

Returns: array

More...

removeDotDirectories (array $list)

Filter out dot-directories. More...

has ($path)

Check whether a file exists.

Parameters

string $path

Returns: array|bool|null

More...

getSize ($path)

Get the size of a file.

Parameters

string $path

Returns: array|false

More...

getVisibility ($path)

Get the visibility of a file.

Parameters

string $path

Returns: array|false

More...

ensureDirectory ($dirname)

Ensure a directory exists. More...

getConnection ()

getPermPublic ()

Get the public permission value. More...

getPermPrivate ()

Get the private permission value. More...

__destruct ()

Disconnect on destruction. More...

connect ()

Establish a connection. More...

disconnect ()

Close the connection. More...

isConnected ()

Check if a connection is active. More...

Public Member Functions inherited from League\Flysystem\Adapter\AbstractAdapter

setPathPrefix ($prefix)

Set the path prefix. More...

getPathPrefix ()

Get the path prefix. More...

applyPathPrefix ($path)

Prefix a path. More...

removePathPrefix ($path)

Remove a path prefix. More...

Public Member Functions inherited from League\Flysystem\AdapterInterface

write ($path, $contents, Config $config)

Write a new file. More...

writeStream ($path, $resource, Config $config)

Write a new file using a stream. More...

update ($path, $contents, Config $config)

Update a file. More...

updateStream ($path, $resource, Config $config)

Update a file using a stream. More...

rename ($path, $newpath)

Rename a file. More...

copy ($path, $newpath)

Copy a file. More...

delete ($path)

Delete a file. More...

deleteDir ($dirname)

Delete a directory. More...

createDir ($dirname, Config $config)

Create a directory. More...

setVisibility ($path, $visibility)

Set the visibility for a file. More...

has ($path)

Check whether a file exists. More...

read ($path)

Read a file. More...

readStream ($path)

Read a file as a stream. More...

listContents ($directory='', $recursive=false)

List contents of a directory. More...

getMetadata ($path)

Get all the meta data of a file or directory. More...

getSize ($path)

Get the size of a file. More...

getMimetype ($path)

Get the mimetype of a file. More...

getTimestamp ($path)

Get the timestamp of a file. More...

getVisibility ($path)

Get the visibility of a file. More...

Protected Member Functions
	setUtf8Mode ()
	Set the connection to UTF-8 mode. More...

	setConnectionPassiveMode ()
	Set the connections to passive mode. More...

	setConnectionRoot ()
	Set the connection root. More...

	login ()
	Login. More...

	createActualDirectory ($directory, $connection)
	Create a directory. More...

	listDirectoryContents ($directory, $recursive=true)

	listDirectoryContentsRecursive ($directory)

	isPureFtpdServer ()

	ftpRawlist ($options, $path)
	The ftp_rawlist function with optional escaping. More...

Protected Member Functions inherited from League\Flysystem\Adapter\AbstractFtpAdapter
	listDirectoryContents ($directory, $recursive=false)

	normalizeListing (array $listing, $prefix='')
	Normalize a directory listing. More...

	sortListing (array $result)
	Sort a directory listing. More...

	normalizeObject ($item, $base)
	Normalize a file entry. More...

	normalizeUnixObject ($item, $base)
	Normalize a Unix file entry. More...

	normalizeWindowsObject ($item, $base)
	Normalize a Windows/DOS file entry. More...

	detectSystemType ($item)
	Get the system type from a listing item. More...

	detectType ($permissions)
	Get the file type from the permissions. More...

	normalizePermissions ($permissions)
	Normalize a permissions string. More...

Protected Attributes
	$transferMode = FTP_BINARY

	$ignorePassiveAddress = null

	$recurseManually = false

	$utf8 = false

	$configurable

	$isPureFtpd

Protected Attributes inherited from League\Flysystem\Adapter\AbstractFtpAdapter
	$connection

	$host

	$port = 21

	$ssl = false

	$timeout = 90

	$passive = true

	$separator = '/'

	$root

	$permPublic = 0744

	$permPrivate = 0700

	$configurable = []

	$systemType

	$alternativeRecursion = false

	$safeStorage

Protected Attributes inherited from League\Flysystem\Adapter\AbstractAdapter
	$pathPrefix

	$pathSeparator = '/'

Additional Inherited Members
Data Fields inherited from League\Flysystem\AdapterInterface
const	VISIBILITY_PUBLIC = 'public'
	@const VISIBILITY_PUBLIC public visibility More...

const	VISIBILITY_PRIVATE = 'private'
	@const VISIBILITY_PRIVATE private visibility More...

Detailed Description

Definition at line 13 of file Ftp.php.

Member Function Documentation

◆ connect()

League\Flysystem\Adapter\Ftp::connect ( )

Connect to the FTP server.

Reimplemented from League\Flysystem\Adapter\AbstractFtpAdapter.

Definition at line 128 of file Ftp.php.

    {
        if ($this->ssl) {
            $this->connection = ftp_ssl_connect($this->getHost(), $this->getPort(), $this->getTimeout());
        } else {
            $this->connection = ftp_connect($this->getHost(), $this->getPort(), $this->getTimeout());
        }
 
        if ( ! $this->connection) {
            throw new RuntimeException('Could not connect to host: ' . $this->getHost() . ', port:' . $this->getPort());
        }
 
        $this->login();
        $this->setUtf8Mode();
        $this->setConnectionPassiveMode();
        $this->setConnectionRoot();
        $this->isPureFtpd = $this->isPureFtpdServer();
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\getHost(), League\Flysystem\Adapter\AbstractFtpAdapter\getPort(), League\Flysystem\Adapter\AbstractFtpAdapter\getTimeout(), League\Flysystem\Adapter\Ftp\isPureFtpdServer(), League\Flysystem\Adapter\Ftp\login(), League\Flysystem\Adapter\Ftp\setConnectionPassiveMode(), League\Flysystem\Adapter\Ftp\setConnectionRoot(), and League\Flysystem\Adapter\Ftp\setUtf8Mode().

Here is the call graph for this function:

◆ createActualDirectory()

League\Flysystem\Adapter\Ftp::createActualDirectory	(	$directory,
		$connection
	)

protected

Create a directory.

Parameters

string	$directory
resource	$connection

Returns: bool

Definition at line 360 of file Ftp.php.

    {
        // List the current directory
        $listing = ftp_nlist($connection, '.') ?: [];
 
        foreach ($listing as $key => $item) {
            if (preg_match('~^\./.*~', $item)) {
                $listing[$key] = substr($item, 2);
            }
        }
 
        if (in_array($directory, $listing, true)) {
            return true;
        }
 
        return (boolean) ftp_mkdir($connection, $directory);
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$connection, and $key.

Referenced by League\Flysystem\Adapter\Ftp\createDir().

Here is the caller graph for this function:

◆ createDir()

League\Flysystem\Adapter\Ftp::createDir	(		$dirname,
		Config	$config
	)

Create a directory.

Parameters

string	$dirname	directory name
Config	$config

Returns: array|false

Implements League\Flysystem\AdapterInterface.

Definition at line 332 of file Ftp.php.

    {
        $connection = $this->getConnection();
        $directories = explode('/', $dirname);
 
        foreach ($directories as $directory) {
            if (false === $this->createActualDirectory($directory, $connection)) {
                $this->setConnectionRoot();
 
                return false;
            }
 
            ftp_chdir($connection, $directory);
        }
 
        $this->setConnectionRoot();
 
        return ['type' => 'dir', 'path' => $dirname];
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$connection, League\Flysystem\Adapter\Ftp\createActualDirectory(), League\Flysystem\Adapter\AbstractFtpAdapter\getConnection(), and League\Flysystem\Adapter\Ftp\setConnectionRoot().

Here is the call graph for this function:

◆ delete()

League\Flysystem\Adapter\Ftp::delete ( $path )

Delete a file.

Parameters

string $path

Returns: bool

Implements League\Flysystem\AdapterInterface.

Definition at line 303 of file Ftp.php.

    {
        return ftp_delete($this->getConnection(), $path);
    }

References $path, and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Here is the call graph for this function:

◆ deleteDir()

League\Flysystem\Adapter\Ftp::deleteDir ( $dirname )

Delete a directory.

Parameters

string $dirname

Returns: bool

Implements League\Flysystem\AdapterInterface.

Definition at line 311 of file Ftp.php.

    {
        $connection = $this->getConnection();
        $contents = array_reverse($this->listDirectoryContents($dirname));
 
        foreach ($contents as $object) {
            if ($object['type'] === 'file') {
                if ( ! ftp_delete($connection, $object['path'])) {
                    return false;
                }
            } elseif ( ! ftp_rmdir($connection, $object['path'])) {
                return false;
            }
        }
 
        return ftp_rmdir($connection, $dirname);
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$connection, $contents, League\Flysystem\Adapter\AbstractFtpAdapter\getConnection(), and League\Flysystem\Adapter\Ftp\listDirectoryContents().

Here is the call graph for this function:

◆ disconnect()

League\Flysystem\Adapter\Ftp::disconnect ( )

Disconnect from the FTP server.

Reimplemented from League\Flysystem\Adapter\AbstractFtpAdapter.

Definition at line 226 of file Ftp.php.

    {
        if (is_resource($this->connection)) {
            ftp_close($this->connection);
        }
 
        $this->connection = null;
    }

Referenced by League\Flysystem\Adapter\Ftp\login().

Here is the caller graph for this function:

◆ ftpRawlist()

League\Flysystem\Adapter\Ftp::ftpRawlist	(	$options,
		$path
	)

protected

The ftp_rawlist function with optional escaping.

Parameters

string	$options
string	$path

Returns: array

Definition at line 560 of file Ftp.php.

    {
        $connection = $this->getConnection();
        
        if ($this->isPureFtpd) {
            $path = str_replace(' ', '\ ', $path);
        }
        return ftp_rawlist($connection, $options . ' ' . $path);
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$connection, $options, $path, and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Referenced by League\Flysystem\Adapter\Ftp\getMetadata(), League\Flysystem\Adapter\Ftp\listDirectoryContents(), and League\Flysystem\Adapter\Ftp\listDirectoryContentsRecursive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMetadata()

League\Flysystem\Adapter\Ftp::getMetadata ( $path )

Get all the meta data of a file or directory.

Parameters

string $path

Returns: array|false

Implements League\Flysystem\ReadInterface.

Reimplemented in League\Flysystem\Adapter\Ftpd.

Definition at line 381 of file Ftp.php.

    {
        $connection = $this->getConnection();
 
        if ($path === '') {
            return ['type' => 'dir', 'path' => ''];
        }
 
        if (@ftp_chdir($connection, $path) === true) {
            $this->setConnectionRoot();
 
            return ['type' => 'dir', 'path' => $path];
        }
 
        $listing = $this->ftpRawlist('-A', str_replace('*', '\\*', $path));
 
        if (empty($listing) || in_array('total 0', $listing, true)) {
            return false;
        }
 
        if (preg_match('/.* not found/', $listing[0])) {
            return false;
        }
 
        if (preg_match('/^total [0-9]*$/', $listing[0])) {
            array_shift($listing);
        }
 
        return $this->normalizeObject($listing[0], '');
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$connection, $path, League\Flysystem\Adapter\Ftp\ftpRawlist(), League\Flysystem\Adapter\AbstractFtpAdapter\getConnection(), League\Flysystem\Adapter\AbstractFtpAdapter\normalizeObject(), and League\Flysystem\Adapter\Ftp\setConnectionRoot().

Referenced by League\Flysystem\Adapter\Ftp\getMimetype().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMimetype()

League\Flysystem\Adapter\Ftp::getMimetype ( $path )

Get the mimetype of a file.

Parameters

string $path

Returns: array|false

Implements League\Flysystem\ReadInterface.

Definition at line 415 of file Ftp.php.

    {
        if ( ! $metadata = $this->getMetadata($path)) {
            return false;
        }
 
        $metadata['mimetype'] = MimeType::detectByFilename($path);
 
        return $metadata;
    }

References $metadata, $path, League\Flysystem\Util\MimeType\detectByFilename(), and League\Flysystem\Adapter\Ftp\getMetadata().

Here is the call graph for this function:

◆ getTimestamp()

League\Flysystem\Adapter\Ftp::getTimestamp ( $path )

Get the timestamp of a file.

Parameters

string $path

Returns: array|false

Implements League\Flysystem\ReadInterface.

Definition at line 429 of file Ftp.php.

    {
        $timestamp = ftp_mdtm($this->getConnection(), $path);
 
        return ($timestamp !== -1) ? ['path' => $path, 'timestamp' => $timestamp] : false;
    }

References $path, $timestamp, and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Here is the call graph for this function:

◆ isConnected()

League\Flysystem\Adapter\Ftp::isConnected ( )

Check if the connection is open.

Returns: bool

Exceptions

ErrorException

Reimplemented from League\Flysystem\Adapter\AbstractFtpAdapter.

Definition at line 529 of file Ftp.php.

    {
        try {
            return is_resource($this->connection) && ftp_rawlist($this->connection, '/') !== false;
        } catch (ErrorException $e) {
            if (strpos($e->getMessage(), 'ftp_rawlist') === false) {
                throw $e;
            }
 
            return false;
        }
    }

◆ isPureFtpdServer()

League\Flysystem\Adapter\Ftp::isPureFtpdServer ( )

protected

Returns: null|string

Definition at line 545 of file Ftp.php.

    {
        $response = ftp_raw($this->connection, 'HELP');
 
        return stripos(implode(' ', $response), 'Pure-FTPd') !== false;
    }

References $response.

Referenced by League\Flysystem\Adapter\Ftp\connect().

Here is the caller graph for this function:

◆ listDirectoryContents()

League\Flysystem\Adapter\Ftp::listDirectoryContents	(	$directory,
		$recursive = `true`
	)

protected

Parameters

string $directory

Reimplemented from League\Flysystem\Adapter\AbstractFtpAdapter.

Reimplemented in League\Flysystem\Adapter\Ftpd.

Definition at line 489 of file Ftp.php.

    {
        $directory = str_replace('*', '\\*', $directory);
 
        if ($recursive && $this->recurseManually) {
            return $this->listDirectoryContentsRecursive($directory);
        }
 
        $options = $recursive ? '-alnR' : '-aln';
        $listing = $this->ftpRawlist($options, $directory);
 
        return $listing ? $this->normalizeListing($listing, $directory) : [];
    }

References $options, League\Flysystem\Adapter\Ftp\ftpRawlist(), League\Flysystem\Adapter\Ftp\listDirectoryContentsRecursive(), and League\Flysystem\Adapter\AbstractFtpAdapter\normalizeListing().

Referenced by League\Flysystem\Adapter\Ftp\deleteDir().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listDirectoryContentsRecursive()

League\Flysystem\Adapter\Ftp::listDirectoryContentsRecursive ( $directory )

protected

Parameters

string $directory

Definition at line 508 of file Ftp.php.

    {
        $listing = $this->normalizeListing($this->ftpRawlist('-aln', $directory) ?: []);
        $output = [];
 
        foreach ($listing as $directory) {
            $output[] = $directory;
            if ($directory['type'] !== 'dir') continue;
 
            $output = array_merge($output, $this->listDirectoryContentsRecursive($directory['path']));
        }
 
        return $output;
    }

References $output, League\Flysystem\Adapter\Ftp\ftpRawlist(), League\Flysystem\Adapter\Ftp\listDirectoryContentsRecursive(), and League\Flysystem\Adapter\AbstractFtpAdapter\normalizeListing().

Referenced by League\Flysystem\Adapter\Ftp\listDirectoryContents(), and League\Flysystem\Adapter\Ftp\listDirectoryContentsRecursive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ login()

League\Flysystem\Adapter\Ftp::login ( )

protected

Login.

Exceptions

RuntimeException

Definition at line 204 of file Ftp.php.

    {
        set_error_handler(function () {});
        $isLoggedIn = ftp_login(
            $this->connection,
            $this->getUsername(),
            $this->getPassword()
        );
        restore_error_handler();
 
        if ( ! $isLoggedIn) {
            $this->disconnect();
            throw new RuntimeException(
                'Could not login with connection: ' . $this->getHost() . '::' . $this->getPort(
                ) . ', username: ' . $this->getUsername()
            );
        }
    }

References League\Flysystem\Adapter\Ftp\disconnect(), League\Flysystem\Adapter\AbstractFtpAdapter\getHost(), League\Flysystem\Adapter\AbstractFtpAdapter\getPassword(), League\Flysystem\Adapter\AbstractFtpAdapter\getPort(), and League\Flysystem\Adapter\AbstractFtpAdapter\getUsername().

Referenced by League\Flysystem\Adapter\Ftp\connect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

League\Flysystem\Adapter\Ftp::read ( $path )

Read a file.

Parameters

string $path

Returns: array|false

Implements League\Flysystem\ReadInterface.

Definition at line 439 of file Ftp.php.

    {
        if ( ! $object = $this->readStream($path)) {
            return false;
        }
 
        $object['contents'] = stream_get_contents($object['stream']);
        fclose($object['stream']);
        unset($object['stream']);
 
        return $object;
    }

References $path, and League\Flysystem\Adapter\Ftp\readStream().

Here is the call graph for this function:

◆ readStream()

League\Flysystem\Adapter\Ftp::readStream ( $path )

Read a file as a stream.

Parameters

string $path

Returns: array|false

Implements League\Flysystem\ReadInterface.

Definition at line 455 of file Ftp.php.

    {
        $stream = fopen('php://temp', 'w+b');
        $result = ftp_fget($this->getConnection(), $stream, $path, $this->transferMode);
        rewind($stream);
 
        if ( ! $result) {
            fclose($stream);
 
            return false;
        }
 
        return ['type' => 'file', 'path' => $path, 'stream' => $stream];
    }

References $path, $result, GuzzleHttp\Psr7\$stream, and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Referenced by League\Flysystem\Adapter\Ftp\read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rename()

League\Flysystem\Adapter\Ftp::rename	(	$path,
		$newpath
	)

Rename a file.

Parameters

string	$path
string	$newpath

Returns: bool

Implements League\Flysystem\AdapterInterface.

Definition at line 295 of file Ftp.php.

    {
        return ftp_rename($this->getConnection(), $path, $newpath);
    }

References $path, and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Here is the call graph for this function:

◆ setConnectionPassiveMode()

League\Flysystem\Adapter\Ftp::setConnectionPassiveMode ( )

protected

Set the connections to passive mode.

Exceptions

RuntimeException

Definition at line 167 of file Ftp.php.

    {
        if (is_bool($this->ignorePassiveAddress) && defined('FTP_USEPASVADDRESS')) {
            ftp_set_option($this->connection, FTP_USEPASVADDRESS, ! $this->ignorePassiveAddress);
        }
 
        if ( ! ftp_pasv($this->connection, $this->passive)) {
            throw new RuntimeException(
                'Could not set passive mode for connection: ' . $this->getHost() . '::' . $this->getPort()
            );
        }
    }

References defined, League\Flysystem\Adapter\AbstractFtpAdapter\getHost(), and League\Flysystem\Adapter\AbstractFtpAdapter\getPort().

Referenced by League\Flysystem\Adapter\Ftp\connect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConnectionRoot()

League\Flysystem\Adapter\Ftp::setConnectionRoot ( )

protected

Set the connection root.

Definition at line 183 of file Ftp.php.

    {
        $root = $this->getRoot();
        $connection = $this->connection;
 
        if (empty($root) === false && ! ftp_chdir($connection, $root)) {
            throw new RuntimeException('Root is invalid or does not exist: ' . $this->getRoot());
        }
 
        // Store absolute path for further reference.
        // This is needed when creating directories and
        // initial root was a relative path, else the root
        // would be relative to the chdir'd path.
        $this->root = ftp_pwd($connection);
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$connection, League\Flysystem\Adapter\AbstractFtpAdapter\$root, and League\Flysystem\Adapter\AbstractFtpAdapter\getRoot().

Referenced by League\Flysystem\Adapter\Ftp\connect(), League\Flysystem\Adapter\Ftp\createDir(), and League\Flysystem\Adapter\Ftp\getMetadata().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIgnorePassiveAddress()

League\Flysystem\Adapter\Ftp::setIgnorePassiveAddress ( $ignorePassiveAddress )

Parameters

bool $ignorePassiveAddress

Definition at line 104 of file Ftp.php.

    {
        $this->ignorePassiveAddress = $ignorePassiveAddress;
    }

References League\Flysystem\Adapter\Ftp\$ignorePassiveAddress.

◆ setPassive()

League\Flysystem\Adapter\Ftp::setPassive ( $passive = true )

Set if passive mode should be used.

Parameters

bool $passive

Definition at line 96 of file Ftp.php.

    {
        $this->passive = $passive;
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$passive.

◆ setRecurseManually()

League\Flysystem\Adapter\Ftp::setRecurseManually ( $recurseManually )

Parameters

bool $recurseManually

Definition at line 112 of file Ftp.php.

    {
        $this->recurseManually = $recurseManually;
    }

References League\Flysystem\Adapter\Ftp\$recurseManually.

◆ setSsl()

League\Flysystem\Adapter\Ftp::setSsl ( $ssl )

Set if Ssl is enabled.

Parameters

bool $ssl

Returns: $this

Definition at line 84 of file Ftp.php.

    {
        $this->ssl = (bool) $ssl;
 
        return $this;
    }

References League\Flysystem\Adapter\AbstractFtpAdapter\$ssl.

◆ setTransferMode()

League\Flysystem\Adapter\Ftp::setTransferMode ( $mode )

Set the transfer mode.

Parameters

int $mode

Returns: $this

Definition at line 70 of file Ftp.php.

    {
        $this->transferMode = $mode;
 
        return $this;
    }

◆ setUtf8()

League\Flysystem\Adapter\Ftp::setUtf8 ( $utf8 )

Parameters

bool $utf8

Definition at line 120 of file Ftp.php.

    {
        $this->utf8 = (bool) $utf8;
    }

References League\Flysystem\Adapter\Ftp\$utf8.

◆ setUtf8Mode()

League\Flysystem\Adapter\Ftp::setUtf8Mode ( )

protected

Set the connection to UTF-8 mode.

Definition at line 150 of file Ftp.php.

    {
        if ($this->utf8) {
            $response = ftp_raw($this->connection, "OPTS UTF8 ON");
            if (substr($response[0], 0, 3) !== '200') {
                throw new RuntimeException(
                    'Could not set UTF-8 mode for connection: ' . $this->getHost() . '::' . $this->getPort()
                );
            }
        }
    }

References $response, League\Flysystem\Adapter\AbstractFtpAdapter\getHost(), and League\Flysystem\Adapter\AbstractFtpAdapter\getPort().

Referenced by League\Flysystem\Adapter\Ftp\connect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVisibility()

League\Flysystem\Adapter\Ftp::setVisibility	(	$path,
		$visibility
	)

Set the visibility for a file.

Parameters

string	$path
string	$visibility

Returns: array|false file meta data

Implements League\Flysystem\AdapterInterface.

Definition at line 473 of file Ftp.php.

    {
        $mode = $visibility === AdapterInterface::VISIBILITY_PUBLIC ? $this->getPermPublic() : $this->getPermPrivate();
 
        if ( ! ftp_chmod($this->getConnection(), $mode, $path)) {
            return false;
        }
 
        return compact('path', 'visibility');
    }

References $path, League\Flysystem\Adapter\AbstractFtpAdapter\getConnection(), League\Flysystem\Adapter\AbstractFtpAdapter\getPermPrivate(), League\Flysystem\Adapter\AbstractFtpAdapter\getPermPublic(), and League\Flysystem\AdapterInterface\VISIBILITY_PUBLIC.

Referenced by League\Flysystem\Adapter\Ftp\writeStream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

League\Flysystem\Adapter\Ftp::update	(		$path,
			$contents,
		Config	$config
	)

Update a file.

Parameters

string	$path
string	$contents
Config	$config	Config object

Returns: array|false false on failure file meta data on success

Implements League\Flysystem\AdapterInterface.

Definition at line 279 of file Ftp.php.

    {
        return $this->write($path, $contents, $config);
    }

References $contents, $path, and League\Flysystem\Adapter\Ftp\write().

Here is the call graph for this function:

◆ updateStream()

League\Flysystem\Adapter\Ftp::updateStream	(		$path,
			$resource,
		Config	$config
	)

Update a file using a stream.

Parameters

string	$path
resource	$resource
Config	$config	Config object

Returns: array|false false on failure file meta data on success

Implements League\Flysystem\AdapterInterface.

Definition at line 287 of file Ftp.php.

    {
        return $this->writeStream($path, $resource, $config);
    }

References $config, $path, and League\Flysystem\Adapter\Ftp\writeStream().

Here is the call graph for this function:

◆ write()

League\Flysystem\Adapter\Ftp::write	(		$path,
			$contents,
		Config	$config
	)

Write a new file.

Parameters

string	$path
string	$contents
Config	$config	Config object

Returns: array|false false on failure file meta data on success

Implements League\Flysystem\AdapterInterface.

Definition at line 238 of file Ftp.php.

    {
        $stream = fopen('php://temp', 'w+b');
        fwrite($stream, $contents);
        rewind($stream);
        $result = $this->writeStream($path, $stream, $config);
        fclose($stream);
 
        if ($result === false) {
            return false;
        }
 
        $result['contents'] = $contents;
        $result['mimetype'] = Util::guessMimeType($path, $contents);
 
        return $result;
    }

References $contents, $path, $result, GuzzleHttp\Psr7\$stream, League\Flysystem\Util\guessMimeType(), and League\Flysystem\Adapter\Ftp\writeStream().

Referenced by League\Flysystem\Adapter\Ftp\update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeStream()

League\Flysystem\Adapter\Ftp::writeStream	(		$path,
			$resource,
		Config	$config
	)

Write a new file using a stream.

Parameters

string	$path
resource	$resource
Config	$config	Config object

Returns: array|false false on failure file meta data on success

Implements League\Flysystem\AdapterInterface.

Definition at line 259 of file Ftp.php.

    {
        $this->ensureDirectory(Util::dirname($path));
 
        if ( ! ftp_fput($this->getConnection(), $path, $resource, $this->transferMode)) {
            return false;
        }
 
        if ($visibility = $config->get('visibility')) {
            $this->setVisibility($path, $visibility);
        }
 
        $type = 'file';
 
        return compact('type', 'path', 'visibility');
    }

References $config, $path, $type, League\Flysystem\Util\dirname(), League\Flysystem\Adapter\AbstractFtpAdapter\ensureDirectory(), League\Flysystem\Adapter\AbstractFtpAdapter\getConnection(), and League\Flysystem\Adapter\Ftp\setVisibility().

Referenced by League\Flysystem\Adapter\Ftp\updateStream(), and League\Flysystem\Adapter\Ftp\write().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $configurable

League\Flysystem\Adapter\Ftp::$configurable

protected

Initial value:

= [
        'host',
        'port',
        'username',
        'password',
        'ssl',
        'timeout',
        'root',
        'permPrivate',
        'permPublic',
        'passive',
        'transferMode',
        'systemType',
        'ignorePassiveAddress',
        'recurseManually',
        'utf8',
    ]

Definition at line 40 of file Ftp.php.

◆ $ignorePassiveAddress

League\Flysystem\Adapter\Ftp::$ignorePassiveAddress = null

protected

Definition at line 25 of file Ftp.php.

Referenced by League\Flysystem\Adapter\Ftp\setIgnorePassiveAddress().

◆ $isPureFtpd

League\Flysystem\Adapter\Ftp::$isPureFtpd

protected

Definition at line 61 of file Ftp.php.

◆ $recurseManually

League\Flysystem\Adapter\Ftp::$recurseManually = false

protected

Definition at line 30 of file Ftp.php.

Referenced by League\Flysystem\Adapter\Ftp\setRecurseManually().

◆ $transferMode

League\Flysystem\Adapter\Ftp::$transferMode = FTP_BINARY

protected

Definition at line 20 of file Ftp.php.

◆ $utf8

League\Flysystem\Adapter\Ftp::$utf8 = false

protected

Definition at line 35 of file Ftp.php.

Referenced by League\Flysystem\Adapter\Ftp\setUtf8().

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

libs/composer/vendor/league/flysystem/src/Adapter/Ftp.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ connect()

◆ createActualDirectory()

◆ createDir()

◆ delete()

◆ deleteDir()

◆ disconnect()

◆ ftpRawlist()

◆ getMetadata()

◆ getMimetype()

◆ getTimestamp()

◆ isConnected()

◆ isPureFtpdServer()

◆ listDirectoryContents()

◆ listDirectoryContentsRecursive()

◆ login()

◆ read()

◆ readStream()

◆ rename()

◆ setConnectionPassiveMode()

◆ setConnectionRoot()

◆ setIgnorePassiveAddress()

◆ setPassive()

◆ setRecurseManually()

◆ setSsl()

◆ setTransferMode()

◆ setUtf8()

◆ setUtf8Mode()

◆ setVisibility()

◆ update()

◆ updateStream()

◆ write()

◆ writeStream()

Field Documentation

◆ $configurable

◆ $ignorePassiveAddress

◆ $isPureFtpd

◆ $recurseManually

◆ $transferMode

◆ $utf8