Inheritance diagram for League\Flysystem\Adapter\AbstractFtpAdapter:

Collaboration diagram for League\Flysystem\Adapter\AbstractFtpAdapter:

Public Member Functions

__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...

Public Member Functions inherited from League\Flysystem\ReadInterface

read ($path)

Read a file. More...

readStream ($path)

Read a file as a stream. More...

getMetadata ($path)

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

getMimetype ($path)

Get the mimetype of a file. More...

getTimestamp ($path)

Get the timestamp of a file. More...

Protected Member Functions
	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
	$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'
	VISIBILITY_PUBLIC public visibility More...

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

Detailed Description

Definition at line 12 of file AbstractFtpAdapter.php.

Constructor & Destructor Documentation

◆ __construct()

League\Flysystem\Adapter\AbstractFtpAdapter::__construct ( array $config )

Constructor.

Parameters

array $config

Definition at line 89 of file AbstractFtpAdapter.php.

References League\Flysystem\Adapter\AbstractFtpAdapter\setConfig().

     {
         $this->safeStorage = new SafeStorage();
         $this->setConfig($config);
     }

Here is the call graph for this function:

◆ __destruct()

League\Flysystem\Adapter\AbstractFtpAdapter::__destruct ( )

Disconnect on destruction.

Definition at line 609 of file AbstractFtpAdapter.php.

References League\Flysystem\Adapter\AbstractFtpAdapter\connect(), League\Flysystem\Adapter\AbstractFtpAdapter\disconnect(), and League\Flysystem\Adapter\AbstractFtpAdapter\isConnected().

     {
         $this->disconnect();
     }

Here is the call graph for this function:

Member Function Documentation

◆ connect()

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

abstract

Establish a connection.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\__destruct(), and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Here is the caller graph for this function:

◆ detectSystemType()

League\Flysystem\Adapter\AbstractFtpAdapter::detectSystemType ( $item )

protected

Get the system type from a listing item.

Parameters

string $item

Returns: string the system type

Definition at line 469 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\normalizeObject().

     {
         return preg_match('/^[0-9]{2,4}-[0-9]{2}-[0-9]{2}/', $item) ? 'windows' : 'unix';
     }

Here is the caller graph for this function:

◆ detectType()

League\Flysystem\Adapter\AbstractFtpAdapter::detectType ( $permissions )

protected

Get the file type from the permissions.

Parameters

string $permissions

Returns: string file type

Definition at line 481 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\normalizeUnixObject().

     {
         return substr($permissions, 0, 1) === 'd' ? 'dir' : 'file';
     }

Here is the caller graph for this function:

◆ disconnect()

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

abstract

Close the connection.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\__destruct(), and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Here is the caller graph for this function:

◆ ensureDirectory()

League\Flysystem\Adapter\AbstractFtpAdapter::ensureDirectory ( $dirname )

Ensure a directory exists.

Parameters

string $dirname

Definition at line 563 of file AbstractFtpAdapter.php.

References League\Flysystem\AdapterInterface\createDir(), and League\Flysystem\Adapter\AbstractFtpAdapter\has().

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

     {
         if ( ! empty($dirname) && ! $this->has($dirname)) {
             $this->createDir($dirname, new Config());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConnection()

League\Flysystem\Adapter\AbstractFtpAdapter::getConnection ( )

Returns: mixed

Definition at line 573 of file AbstractFtpAdapter.php.

References League\Flysystem\Adapter\AbstractFtpAdapter\$connection, League\Flysystem\Adapter\AbstractFtpAdapter\connect(), League\Flysystem\Adapter\AbstractFtpAdapter\disconnect(), and League\Flysystem\Adapter\AbstractFtpAdapter\isConnected().

     {
         $tries = 0;
 
         while ( ! $this->isConnected() && $tries < 3) {
             $tries++;
             $this->disconnect();
             $this->connect();
         }
 
         return $this->connection;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHost()

League\Flysystem\Adapter\AbstractFtpAdapter::getHost ( )

Returns the host.

Returns: string

Definition at line 124 of file AbstractFtpAdapter.php.

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

Referenced by League\Flysystem\Adapter\Ftp\connect(), League\Flysystem\Adapter\Ftp\login(), League\Flysystem\Adapter\Ftp\setConnectionPassiveMode(), and League\Flysystem\Adapter\Ftp\setUtf8Mode().

     {
         return $this->host;
     }

Here is the caller graph for this function:

◆ getPassword()

League\Flysystem\Adapter\AbstractFtpAdapter::getPassword ( )

Returns the password.

Returns: string password

Definition at line 250 of file AbstractFtpAdapter.php.

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

     {
         return $this->safeStorage->retrieveSafely('password');
     }

Here is the caller graph for this function:

◆ getPermPrivate()

League\Flysystem\Adapter\AbstractFtpAdapter::getPermPrivate ( )

Get the private permission value.

Returns: int

Definition at line 601 of file AbstractFtpAdapter.php.

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

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

     {
         return $this->permPrivate;
     }

Here is the caller graph for this function:

◆ getPermPublic()

League\Flysystem\Adapter\AbstractFtpAdapter::getPermPublic ( )

Get the public permission value.

Returns: int

Definition at line 591 of file AbstractFtpAdapter.php.

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

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

     {
         return $this->permPublic;
     }

Here is the caller graph for this function:

◆ getPort()

League\Flysystem\Adapter\AbstractFtpAdapter::getPort ( )

Returns the ftp port.

Returns: int

Definition at line 176 of file AbstractFtpAdapter.php.

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

Referenced by League\Flysystem\Adapter\Ftp\connect(), League\Flysystem\Adapter\Ftp\login(), League\Flysystem\Adapter\Ftp\setConnectionPassiveMode(), and League\Flysystem\Adapter\Ftp\setUtf8Mode().

     {
         return $this->port;
     }

Here is the caller graph for this function:

◆ getRoot()

League\Flysystem\Adapter\AbstractFtpAdapter::getRoot ( )

Returns the root folder to work from.

Returns: string

Definition at line 186 of file AbstractFtpAdapter.php.

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

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

     {
         return $this->root;
     }

Here is the caller graph for this function:

◆ getSize()

League\Flysystem\Adapter\AbstractFtpAdapter::getSize ( $path )

Get the size of a file.

Parameters

string $path

Returns: array|false

Implements League\Flysystem\ReadInterface.

Definition at line 545 of file AbstractFtpAdapter.php.

References $path, and League\Flysystem\ReadInterface\getMetadata().

     {
         return $this->getMetadata($path);
     }

Here is the call graph for this function:

◆ getSystemType()

League\Flysystem\Adapter\AbstractFtpAdapter::getSystemType ( )

Return the FTP system type.

Returns: string

Definition at line 298 of file AbstractFtpAdapter.php.

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

     {
         return $this->systemType;
     }

◆ getTimeout()

League\Flysystem\Adapter\AbstractFtpAdapter::getTimeout ( )

Returns the amount of seconds before the connection will timeout.

Returns: int

Definition at line 274 of file AbstractFtpAdapter.php.

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

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

     {
         return $this->timeout;
     }

Here is the caller graph for this function:

◆ getUsername()

League\Flysystem\Adapter\AbstractFtpAdapter::getUsername ( )

Returns the ftp username.

Returns: string username

Definition at line 224 of file AbstractFtpAdapter.php.

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

     {
         $username = $this->safeStorage->retrieveSafely('username');
 
         return $username !== null ? $username : 'anonymous';
     }

Here is the caller graph for this function:

◆ getVisibility()

League\Flysystem\Adapter\AbstractFtpAdapter::getVisibility ( $path )

Get the visibility of a file.

Parameters

string $path

Returns: array|false

Implements League\Flysystem\ReadInterface.

Definition at line 553 of file AbstractFtpAdapter.php.

References $path, and League\Flysystem\ReadInterface\getMetadata().

     {
         return $this->getMetadata($path);
     }

Here is the call graph for this function:

◆ has()

League\Flysystem\Adapter\AbstractFtpAdapter::has ( $path )

Check whether a file exists.

Parameters

string $path

Returns: array|bool|null

Implements League\Flysystem\ReadInterface.

Definition at line 537 of file AbstractFtpAdapter.php.

References $path, and League\Flysystem\ReadInterface\getMetadata().

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\ensureDirectory().

     {
         return $this->getMetadata($path);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isConnected()

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

abstract

Check if a connection is active.

Returns: bool

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\__destruct(), and League\Flysystem\Adapter\AbstractFtpAdapter\getConnection().

Here is the caller graph for this function:

◆ listContents()

League\Flysystem\Adapter\AbstractFtpAdapter::listContents	(	$directory = `''`,
		$recursive = `false`
	)

List contents of a directory.

Parameters

string	$directory
bool	$recursive

Returns: array

Implements League\Flysystem\ReadInterface.

Definition at line 320 of file AbstractFtpAdapter.php.

References League\Flysystem\Adapter\AbstractFtpAdapter\listDirectoryContents().

     {
         return $this->listDirectoryContents($directory, $recursive);
     }

Here is the call graph for this function:

◆ listDirectoryContents()

League\Flysystem\Adapter\AbstractFtpAdapter::listDirectoryContents	(	$directory,
		$recursive = `false`
	)

abstractprotected

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\listContents().

Here is the caller graph for this function:

◆ normalizeListing()

League\Flysystem\Adapter\AbstractFtpAdapter::normalizeListing	(	array	$listing,
			$prefix = `''`
	)

protected

Normalize a directory listing.

Parameters

array	$listing
string	$prefix

Returns: array directory listing

Definition at line 335 of file AbstractFtpAdapter.php.

References $base, $result, League\Flysystem\Adapter\AbstractFtpAdapter\normalizeObject(), League\Flysystem\Adapter\AbstractFtpAdapter\removeDotDirectories(), and League\Flysystem\Adapter\AbstractFtpAdapter\sortListing().

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

     {
         $base = $prefix;
         $result = [];
         $listing = $this->removeDotDirectories($listing);
 
         while ($item = array_shift($listing)) {
             if (preg_match('#^.*:$#', $item)) {
                 $base = trim($item, ':');
                 continue;
             }
 
             $result[] = $this->normalizeObject($item, $base);
         }
 
         return $this->sortListing($result);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalizeObject()

League\Flysystem\Adapter\AbstractFtpAdapter::normalizeObject	(	$item,
		$base
	)

protected

Normalize a file entry.

Parameters

string	$item
string	$base

Returns: array normalized file array

Exceptions

NotSupportedException

Definition at line 381 of file AbstractFtpAdapter.php.

References $base, League\Flysystem\Adapter\AbstractFtpAdapter\$systemType, League\Flysystem\Adapter\AbstractFtpAdapter\detectSystemType(), League\Flysystem\NotSupportedException\forFtpSystemType(), League\Flysystem\Adapter\AbstractFtpAdapter\normalizeUnixObject(), and League\Flysystem\Adapter\AbstractFtpAdapter\normalizeWindowsObject().

Referenced by League\Flysystem\Adapter\Ftpd\getMetadata(), League\Flysystem\Adapter\Ftp\getMetadata(), and League\Flysystem\Adapter\AbstractFtpAdapter\normalizeListing().

     {
         $systemType = $this->systemType ?: $this->detectSystemType($item);
 
         if ($systemType === 'unix') {
             return $this->normalizeUnixObject($item, $base);
         } elseif ($systemType === 'windows') {
             return $this->normalizeWindowsObject($item, $base);
         }
 
         throw NotSupportedException::forFtpSystemType($systemType);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalizePermissions()

League\Flysystem\Adapter\AbstractFtpAdapter::normalizePermissions ( $permissions )

protected

Normalize a permissions string.

Parameters

string $permissions

Returns: int

Definition at line 493 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\normalizeUnixObject().

     {
         // remove the type identifier
         $permissions = substr($permissions, 1);
 
         // map the string rights to the numeric counterparts
         $map = ['-' => '0', 'r' => '4', 'w' => '2', 'x' => '1'];
         $permissions = strtr($permissions, $map);
 
         // split up the permission groups
         $parts = str_split($permissions, 3);
 
         // convert the groups
         $mapper = function ($part) {
             return array_sum(str_split($part));
         };
 
         // get the sum of the groups
         return array_sum(array_map($mapper, $parts));
     }

Here is the caller graph for this function:

◆ normalizeUnixObject()

League\Flysystem\Adapter\AbstractFtpAdapter::normalizeUnixObject	(	$item,
		$base
	)

protected

Normalize a Unix file entry.

Parameters

string	$item
string	$base

Returns: array normalized file array

Definition at line 402 of file AbstractFtpAdapter.php.

References $base, $name, $path, $size, $type, League\Flysystem\Adapter\AbstractFtpAdapter\detectType(), League\Flysystem\Adapter\AbstractFtpAdapter\normalizePermissions(), League\Flysystem\AdapterInterface\VISIBILITY_PRIVATE, and League\Flysystem\AdapterInterface\VISIBILITY_PUBLIC.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\normalizeObject().

     {
         $item = preg_replace('#\s+#', ' ', trim($item), 7);
 
         if (count(explode(' ', $item, 9)) !== 9) {
             throw new RuntimeException("Metadata can't be parsed from item '$item' , not enough parts.");
         }
 
         list($permissions, /* $number */, /* $owner */, /* $group */, $size, /* $month */, /* $day */, /* $time*/, $name) = explode(' ', $item, 9);
         $type = $this->detectType($permissions);
         $path = empty($base) ? $name : $base . $this->separator . $name;
 
         if ($type === 'dir') {
             return compact('type', 'path');
         }
 
         $permissions = $this->normalizePermissions($permissions);
         $visibility = $permissions & 0044 ? AdapterInterface::VISIBILITY_PUBLIC : AdapterInterface::VISIBILITY_PRIVATE;
         $size = (int) $size;
 
         return compact('type', 'path', 'visibility', 'size');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalizeWindowsObject()

League\Flysystem\Adapter\AbstractFtpAdapter::normalizeWindowsObject	(	$item,
		$base
	)

protected

Normalize a Windows/DOS file entry.

Parameters

string	$item
string	$base

Returns: array normalized file array

Definition at line 433 of file AbstractFtpAdapter.php.

References $base, $format, $name, $path, $size, $time, $timestamp, $type, and League\Flysystem\AdapterInterface\VISIBILITY_PUBLIC.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\normalizeObject().

     {
         $item = preg_replace('#\s+#', ' ', trim($item), 3);
 
         if (count(explode(' ', $item, 4)) !== 4) {
             throw new RuntimeException("Metadata can't be parsed from item '$item' , not enough parts.");
         }
 
         list($date, $time, $size, $name) = explode(' ', $item, 4);
         $path = empty($base) ? $name : $base . $this->separator . $name;
 
         // Check for the correct date/time format
         $format = strlen($date) === 8 ? 'm-d-yH:iA' : 'Y-m-dH:i';
         $dt = DateTime::createFromFormat($format, $date . $time);
         $timestamp = $dt ? $dt->getTimestamp() : (int) strtotime("$date $time");
 
         if ($size === '<DIR>') {
             $type = 'dir';
 
             return compact('type', 'path', 'timestamp');
         }
 
         $type = 'file';
         $visibility = AdapterInterface::VISIBILITY_PUBLIC;
         $size = (int) $size;
 
         return compact('type', 'path', 'visibility', 'size', 'timestamp');
     }

Here is the caller graph for this function:

◆ removeDotDirectories()

League\Flysystem\Adapter\AbstractFtpAdapter::removeDotDirectories ( array $list )

Filter out dot-directories.

Parameters

array $list

Returns: array

Definition at line 521 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\normalizeListing().

     {
         $filter = function ($line) {
             if ( ! empty($line) && ! preg_match('#.* \.(\.)?$|^total#', $line)) {
                 return true;
             }
 
             return false;
         };
 
         return array_filter($list, $filter);
     }

Here is the caller graph for this function:

◆ setConfig()

League\Flysystem\Adapter\AbstractFtpAdapter::setConfig ( array $config )

Set the config.

Parameters

array $config

Returns: $this

Definition at line 102 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\__construct().

     {
         foreach ($this->configurable as $setting) {
             if ( ! isset($config[$setting])) {
                 continue;
             }
 
             $method = 'set' . ucfirst($setting);
 
             if (method_exists($this, $method)) {
                 $this->$method($config[$setting]);
             }
         }
 
         return $this;
     }

Here is the caller graph for this function:

◆ setHost()

League\Flysystem\Adapter\AbstractFtpAdapter::setHost ( $host )

Set the host.

Parameters

string $host

Returns: $this

Definition at line 136 of file AbstractFtpAdapter.php.

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

     {
         $this->host = $host;
 
         return $this;
     }

◆ setPassword()

League\Flysystem\Adapter\AbstractFtpAdapter::setPassword ( $password )

Set the ftp password.

Parameters

string $password

Returns: $this

Definition at line 262 of file AbstractFtpAdapter.php.

References $password.

     {
         $this->safeStorage->storeSafely('password', $password);
 
         return $this;
     }

◆ setPermPrivate()

League\Flysystem\Adapter\AbstractFtpAdapter::setPermPrivate ( $permPrivate )

Set the private permission value.

Parameters

int $permPrivate

Returns: $this

Definition at line 164 of file AbstractFtpAdapter.php.

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

     {
         $this->permPrivate = $permPrivate;
 
         return $this;
     }

◆ setPermPublic()

League\Flysystem\Adapter\AbstractFtpAdapter::setPermPublic ( $permPublic )

Set the public permission value.

Parameters

int $permPublic

Returns: $this

Definition at line 150 of file AbstractFtpAdapter.php.

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

     {
         $this->permPublic = $permPublic;
 
         return $this;
     }

◆ setPort()

League\Flysystem\Adapter\AbstractFtpAdapter::setPort ( $port )

Set the ftp port.

Parameters

int | string $port

Returns: $this

Definition at line 198 of file AbstractFtpAdapter.php.

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

     {
         $this->port = (int) $port;
 
         return $this;
     }

◆ setRoot()

League\Flysystem\Adapter\AbstractFtpAdapter::setRoot ( $root )

Set the root folder to work from.

Parameters

string $root

Returns: $this

Definition at line 212 of file AbstractFtpAdapter.php.

References League\Flysystem\Adapter\AbstractFtpAdapter\$root, and League\Flysystem\Adapter\AbstractFtpAdapter\$separator.

     {
         $this->root = rtrim($root, '\\/') . $this->separator;
 
         return $this;
     }

◆ setSystemType()

League\Flysystem\Adapter\AbstractFtpAdapter::setSystemType ( $systemType )

Set the FTP system type (windows or unix).

Parameters

string $systemType

Returns: $this

Definition at line 310 of file AbstractFtpAdapter.php.

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

     {
         $this->systemType = strtolower($systemType);
 
         return $this;
     }

◆ setTimeout()

League\Flysystem\Adapter\AbstractFtpAdapter::setTimeout ( $timeout )

Set the amount of seconds before the connection should timeout.

Parameters

int $timeout

Returns: $this

Definition at line 286 of file AbstractFtpAdapter.php.

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

     {
         $this->timeout = (int) $timeout;
 
         return $this;
     }

◆ setUsername()

League\Flysystem\Adapter\AbstractFtpAdapter::setUsername ( $username )

Set ftp username.

Parameters

string $username

Returns: $this

Definition at line 238 of file AbstractFtpAdapter.php.

     {
         $this->safeStorage->storeSafely('username', $username);
 
         return $this;
     }

◆ sortListing()

League\Flysystem\Adapter\AbstractFtpAdapter::sortListing ( array $result )

protected

Sort a directory listing.

Parameters

array $result

Returns: array sorted listing

Definition at line 360 of file AbstractFtpAdapter.php.

References $result.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\normalizeListing().

     {
         $compare = function ($one, $two) {
             return strnatcmp($one['path'], $two['path']);
         };
 
         usort($result, $compare);
 
         return $result;
     }

Here is the caller graph for this function:

Field Documentation

◆ $alternativeRecursion

League\Flysystem\Adapter\AbstractFtpAdapter::$alternativeRecursion = false

protected

Definition at line 77 of file AbstractFtpAdapter.php.

◆ $configurable

League\Flysystem\Adapter\AbstractFtpAdapter::$configurable = []

protected

Definition at line 67 of file AbstractFtpAdapter.php.

◆ $connection

League\Flysystem\Adapter\AbstractFtpAdapter::$connection

protected

Definition at line 17 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\Ftp\createActualDirectory(), League\Flysystem\Adapter\Ftp\createDir(), League\Flysystem\Adapter\Ftp\deleteDir(), League\Flysystem\Adapter\Ftp\ftpRawlist(), League\Flysystem\Adapter\AbstractFtpAdapter\getConnection(), League\Flysystem\Adapter\Ftp\getMetadata(), and League\Flysystem\Adapter\Ftp\setConnectionRoot().

◆ $host

League\Flysystem\Adapter\AbstractFtpAdapter::$host

protected

Definition at line 22 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\getHost(), and League\Flysystem\Adapter\AbstractFtpAdapter\setHost().

◆ $passive

League\Flysystem\Adapter\AbstractFtpAdapter::$passive = true

protected

Definition at line 42 of file AbstractFtpAdapter.php.

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

◆ $permPrivate

League\Flysystem\Adapter\AbstractFtpAdapter::$permPrivate = 0700

protected

Definition at line 62 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\getPermPrivate(), and League\Flysystem\Adapter\AbstractFtpAdapter\setPermPrivate().

◆ $permPublic

League\Flysystem\Adapter\AbstractFtpAdapter::$permPublic = 0744

protected

Definition at line 57 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\getPermPublic(), and League\Flysystem\Adapter\AbstractFtpAdapter\setPermPublic().

◆ $port

League\Flysystem\Adapter\AbstractFtpAdapter::$port = 21

protected

Definition at line 27 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\getPort(), and League\Flysystem\Adapter\AbstractFtpAdapter\setPort().

◆ $root

League\Flysystem\Adapter\AbstractFtpAdapter::$root

protected

Definition at line 52 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\getRoot(), League\Flysystem\Adapter\Ftp\setConnectionRoot(), and League\Flysystem\Adapter\AbstractFtpAdapter\setRoot().

◆ $safeStorage

League\Flysystem\Adapter\AbstractFtpAdapter::$safeStorage

protected

Definition at line 82 of file AbstractFtpAdapter.php.

◆ $separator

League\Flysystem\Adapter\AbstractFtpAdapter::$separator = '/'

protected

Definition at line 47 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\setRoot().

◆ $ssl

League\Flysystem\Adapter\AbstractFtpAdapter::$ssl = false

protected

Definition at line 32 of file AbstractFtpAdapter.php.

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

◆ $systemType

League\Flysystem\Adapter\AbstractFtpAdapter::$systemType

protected

Definition at line 72 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\getSystemType(), League\Flysystem\Adapter\AbstractFtpAdapter\normalizeObject(), and League\Flysystem\Adapter\AbstractFtpAdapter\setSystemType().

◆ $timeout

League\Flysystem\Adapter\AbstractFtpAdapter::$timeout = 90

protected

Definition at line 37 of file AbstractFtpAdapter.php.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\getTimeout(), and League\Flysystem\Adapter\AbstractFtpAdapter\setTimeout().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ connect()

◆ detectSystemType()

◆ detectType()

◆ disconnect()

◆ ensureDirectory()

◆ getConnection()

◆ getHost()

◆ getPassword()

◆ getPermPrivate()

◆ getPermPublic()

◆ getPort()

◆ getRoot()

◆ getSize()

◆ getSystemType()

◆ getTimeout()

◆ getUsername()

◆ getVisibility()

◆ has()

◆ isConnected()

◆ listContents()

◆ listDirectoryContents()

◆ normalizeListing()

◆ normalizeObject()

◆ normalizePermissions()

◆ normalizeUnixObject()

◆ normalizeWindowsObject()

◆ removeDotDirectories()

◆ setConfig()

◆ setHost()

◆ setPassword()

◆ setPermPrivate()

◆ setPermPublic()

◆ setPort()

◆ setRoot()

◆ setSystemType()

◆ setTimeout()

◆ setUsername()

◆ sortListing()

Field Documentation

◆ $alternativeRecursion

◆ $configurable

◆ $connection

◆ $host

◆ $passive

◆ $permPrivate

◆ $permPublic

◆ $port

◆ $root

◆ $safeStorage

◆ $separator

◆ $ssl

◆ $systemType

◆ $timeout