\League\Flysystem\AdapterFtp

copy()

copy(string  $path, string  $newpath) : boolean

Copy a file.

Parameters

Returns

readStream()

readStream(  $path) 

Parameters

writeStream()

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

Parameters

__construct()

__construct(array  $config) 

Constructor.

Parameters

setConfig()

setConfig(array  $config) : $this

Set the config.

Parameters

Returns

getHost()

getHost() : string

Returns the host.

Returns

setHost()

setHost(string  $host) : $this

Set the host.

Parameters

Returns

setPermPublic()

setPermPublic(integer  $permPublic) : $this

Set the public permission value.

Parameters

Returns

setPermPrivate()

setPermPrivate(integer  $permPrivate) : $this

Set the private permission value.

Parameters

Returns

getPort()

getPort() : integer

Returns the ftp port.

Returns

getRoot()

getRoot() : string

Returns the root folder to work from.

Returns

setPort()

setPort(integer|string  $port) : $this

Set the ftp port.

Parameters

Returns

setRoot()

setRoot(string  $root) : $this

Set the root folder to work from.

Parameters

Returns

getUsername()

getUsername() : string

Returns the ftp username.

Returns

username

setUsername()

setUsername(string  $username) : $this

Set ftp username.

Parameters

Returns

getPassword()

getPassword() : string

Returns the password.

Returns

password

setPassword()

setPassword(string  $password) : $this

Set the ftp password.

Parameters

Returns

getTimeout()

getTimeout() : integer

Returns the amount of seconds before the connection will timeout.

Returns

setTimeout()

setTimeout(integer  $timeout) : $this

Set the amount of seconds before the connection should timeout.

Parameters

Returns

getSystemType()

getSystemType() : string

Return the FTP system type.

Returns

setSystemType()

setSystemType(string  $systemType) : $this

Set the FTP system type (windows or unix).

Parameters

Returns

setEnableTimestampsOnUnixListings()

setEnableTimestampsOnUnixListings(boolean  $bool = false) : $this

True to enable timestamps for FTP servers that return unix-style listings.

Parameters

Returns

listContents()

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

Parameters

removeDotDirectories()

removeDotDirectories(array  $list) : array

Filter out dot-directories.

Parameters

Returns

has()

has(  $path) 

Parameters

getSize()

getSize(  $path) 

Parameters

getVisibility()

getVisibility(  $path) 

Parameters

ensureDirectory()

ensureDirectory(string  $dirname) 

Ensure a directory exists.

Parameters

getConnection()

getConnection() : mixed

Returns

getPermPublic()

getPermPublic() : integer

Get the public permission value.

Returns

getPermPrivate()

getPermPrivate() : integer

Get the private permission value.

Returns

__destruct()

__destruct() 

Disconnect on destruction.

connect()

connect() 

Connect to the FTP server.

disconnect()

disconnect() 

Disconnect from the FTP server.

isConnected()

isConnected() : boolean

Check if the connection is open.

Throws

\League\Flysystem\ConnectionErrorException

Returns

setPathPrefix()

setPathPrefix(string  $prefix) : void

Set the path prefix.

Parameters

getPathPrefix()

getPathPrefix() : string|null

Get the path prefix.

Returns

path prefix or null if pathPrefix is empty

applyPathPrefix()

applyPathPrefix(string  $path) : string

Prefix a path.

Parameters

Returns

prefixed path

removePathPrefix()

removePathPrefix(string  $path) : string

Remove a path prefix.

Parameters

Returns

path without the prefix

setTransferMode()

setTransferMode(integer  $mode) : $this

Set the transfer mode.

Parameters

Returns

setSsl()

setSsl(boolean  $ssl) : $this

Set if Ssl is enabled.

Parameters

Returns

setPassive()

setPassive(boolean  $passive = true) 

Set if passive mode should be used.

Parameters

setIgnorePassiveAddress()

setIgnorePassiveAddress(boolean  $ignorePassiveAddress) 

Parameters

setRecurseManually()

setRecurseManually(boolean  $recurseManually) 

Parameters

setUtf8()

setUtf8(boolean  $utf8) 

Parameters

write()

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

Parameters

update()

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

Parameters

updateStream()

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

Parameters

rename()

rename(  $path,   $newpath) 

Parameters

delete()

delete(  $path) 

Parameters

deleteDir()

deleteDir(  $dirname) 

Parameters

createDir()

createDir(  $dirname, \League\Flysystem\Config  $config) 

Parameters

getMetadata()

getMetadata(  $path) 

Parameters

getMimetype()

getMimetype(  $path) 

Parameters

getTimestamp()

getTimestamp(  $path) 

Parameters

read()

read(  $path) 

Parameters

setVisibility()

setVisibility(  $path,   $visibility) 

Parameters

listDirectoryContents()

listDirectoryContents(string  $directory,   $recursive = true) 

Parameters

normalizeListing()

normalizeListing(array  $listing, string  $prefix = '') : array

Normalize a directory listing.

Parameters

Returns

directory listing

sortListing()

sortListing(array  $result) : array

Sort a directory listing.

Parameters

Returns

sorted listing

normalizeObject()

normalizeObject(string  $item, string  $base) : array

Normalize a file entry.

Parameters

Throws

\League\Flysystem\NotSupportedException

Returns

normalized file array

normalizeUnixObject()

normalizeUnixObject(string  $item, string  $base) : array

Normalize a Unix file entry.

Given $item contains: '-rw-r--r-- 1 ftp ftp 409 Aug 19 09:01 file1.txt'

This function will return: [ 'type' => 'file', 'path' => 'file1.txt', 'visibility' => 'public', 'size' => 409, 'timestamp' => 1566205260 ]

Parameters

Returns

normalized file array

normalizeUnixTimestamp()

normalizeUnixTimestamp(string  $month, string  $day, string  $timeOrYear) : integer

Only accurate to the minute (current year), or to the day.

Inadequacies in timestamp accuracy are due to limitations of the FTP 'LIST' command

Note: The 'MLSD' command is a machine-readable replacement for 'LIST' but many FTP servers do not support it :(

Parameters

Returns

normalizeWindowsObject()

normalizeWindowsObject(string  $item, string  $base) : array

Normalize a Windows/DOS file entry.

Parameters

Returns

normalized file array

detectSystemType()

detectSystemType(string  $item) : string

Get the system type from a listing item.

Parameters

Returns

the system type

detectType()

detectType(string  $permissions) : string

Get the file type from the permissions.

Parameters

Returns

file type

normalizePermissions()

normalizePermissions(string  $permissions) : integer

Normalize a permissions string.

Parameters

Returns

setUtf8Mode()

setUtf8Mode() 

Set the connection to UTF-8 mode.

setConnectionPassiveMode()

setConnectionPassiveMode() 

Set the connections to passive mode.

Throws

\League\Flysystem\ConnectionRuntimeException

setConnectionRoot()

setConnectionRoot() 

Set the connection root.

login()

login() 

Login.

Throws

\League\Flysystem\ConnectionRuntimeException

createActualDirectory()

createActualDirectory(string  $directory, resource  $connection) : boolean

Create a directory.

Parameters

Returns

listDirectoryContentsRecursive()

listDirectoryContentsRecursive(string  $directory) 

Parameters

isPureFtpdServer()

isPureFtpdServer() : boolean

Returns

ftpRawlist()

ftpRawlist(string  $options, string  $path) : array

The ftp_rawlist function with optional escaping.

Parameters

Returns

getRawExecResponseCode()

getRawExecResponseCode(  $command) 

Parameters