Gitee
\
app
admin
controller
controller
listener
Composer
Autoload
League
Flysystem
Adapter
Polyfill
Cached
Storage
Plugin
Util
Opis
Closure
Psr
Cache
Container
Log
Test
SimpleCache
spec
League
Flysystem
Cached
Symfony
Component
VarDumper
Caster
Cloner
Command
Descriptor
Dumper
ContextProvider
Exception
Server
Test
Polyfill
Mbstring
Php72
Php80
think
app
command
cache
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
contract
db
builder
concern
connector
exception
event
exception
facade
file
filesystem
driver
helper
initializer
log
driver
middleware
model
concern
relation
paginator
driver
response
route
dispatch
service
session
driver
tests
trace
validate
view
driver

\League\Flysystem\AdapterFtp

Summary

Methods
Properties
Constants
copy()
readStream()
writeStream()
__construct()
setConfig()
getHost()
setHost()
setPermPublic()
setPermPrivate()
getPort()
getRoot()
setPort()
setRoot()
getUsername()
setUsername()
getPassword()
setPassword()
getTimeout()
setTimeout()
getSystemType()
setSystemType()
listContents()
removeDotDirectories()
has()
getSize()
getVisibility()
ensureDirectory()
getConnection()
getPermPublic()
getPermPrivate()
__destruct()
connect()
disconnect()
isConnected()
setPathPrefix()
getPathPrefix()
applyPathPrefix()
removePathPrefix()
setTransferMode()
setSsl()
setPassive()
setIgnorePassiveAddress()
setRecurseManually()
setUtf8()
write()
update()
updateStream()
rename()
delete()
deleteDir()
createDir()
getMetadata()
getMimetype()
getTimestamp()
read()
setVisibility()
No public properties found
No constants found
listDirectoryContents()
normalizeListing()
sortListing()
normalizeObject()
normalizeUnixObject()
normalizeWindowsObject()
detectSystemType()
detectType()
normalizePermissions()
setUtf8Mode()
setConnectionPassiveMode()
setConnectionRoot()
login()
createActualDirectory()
listDirectoryContentsRecursive()
isPureFtpdServer()
ftpRawlist()
$connection
$host
$port
$ssl
$timeout
$passive
$separator
$root
$permPublic
$permPrivate
$configurable
$systemType
$alternativeRecursion
$safeStorage
$pathPrefix
$pathSeparator
$transferMode
$ignorePassiveAddress
$recurseManually
$utf8
$isPureFtpd
N/A
No private methods found
No private properties found
N/A

Properties

$connection

$connection : mixed

Type

mixed —

$host

$host : string

Type

string —

$port

$port : int

Type

int —

$ssl

$ssl : bool

Type

bool —

$timeout

$timeout : int

Type

int —

$passive

$passive : bool

Type

bool —

$separator

$separator : string

Type

string —

$permPublic

$permPublic : int

Type

int —

$permPrivate

$permPrivate : int

Type

int —

$configurable

$configurable : array

Type

array —

$systemType

$systemType : string

Type

string —

$alternativeRecursion

$alternativeRecursion : bool

Type

bool —

$safeStorage

$safeStorage : \League\Flysystem\SafeStorage

Type

SafeStorage —

$pathPrefix

$pathPrefix : string|null

Type

string|null — path prefix

$pathSeparator

$pathSeparator : string

Type

string —

$transferMode

$transferMode : int

Type

int —

$ignorePassiveAddress

$ignorePassiveAddress : null|bool

Type

null|bool —

$recurseManually

$recurseManually : bool

Type

bool —

$utf8

$utf8 : bool

Type

bool —

$isPureFtpd

$isPureFtpd : bool

Type

bool —

Methods

copy()

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

Copy a file.

Parameters

string $path
string $newpath

Returns

bool —

readStream()

readStream(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

writeStream()

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

Parameters

mixed $path
mixed $resource
\League\Flysystem\Config $config

Returns

mixed —

__construct()

__construct(array  $config) : mixed

Constructor.

Parameters

array $config

Returns

mixed —

setConfig()

setConfig(array  $config) : $this

Set the config.

Parameters

array $config

Returns

$this —

getHost()

getHost() : string

Returns the host.

Returns

string —

setHost()

setHost(string  $host) : $this

Set the host.

Parameters

string $host

Returns

$this —

setPermPublic()

setPermPublic(int  $permPublic) : $this

Set the public permission value.

Parameters

int $permPublic

Returns

$this —

setPermPrivate()

setPermPrivate(int  $permPrivate) : $this

Set the private permission value.

Parameters

int $permPrivate

Returns

$this —

getPort()

getPort() : int

Returns the ftp port.

Returns

int —

getRoot()

getRoot() : string

Returns the root folder to work from.

Returns

string —

setPort()

setPort(int|string  $port) : $this

Set the ftp port.

Parameters

int|string $port

Returns

$this —

setRoot()

setRoot(string  $root) : $this

Set the root folder to work from.

Parameters

string $root

Returns

$this —

getUsername()

getUsername() : string

Returns the ftp username.

Returns

string —

username

setUsername()

setUsername(string  $username) : $this

Set ftp username.

Parameters

string $username

Returns

$this —

getPassword()

getPassword() : string

Returns the password.

Returns

string —

password

setPassword()

setPassword(string  $password) : $this

Set the ftp password.

Parameters

string $password

Returns

$this —

getTimeout()

getTimeout() : int

Returns the amount of seconds before the connection will timeout.

Returns

int —

setTimeout()

setTimeout(int  $timeout) : $this

Set the amount of seconds before the connection should timeout.

Parameters

int $timeout

Returns

$this —

getSystemType()

getSystemType() : string

Return the FTP system type.

Returns

string —

setSystemType()

setSystemType(string  $systemType) : $this

Set the FTP system type (windows or unix).

Parameters

string $systemType

Returns

$this —

listContents()

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

Parameters

mixed $directory
mixed $recursive

Returns

mixed —

removeDotDirectories()

removeDotDirectories(array  $list) : array

Filter out dot-directories.

Parameters

array $list

Returns

array —

has()

has(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getSize()

getSize(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getVisibility()

getVisibility(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

ensureDirectory()

ensureDirectory(string  $dirname) : mixed

Ensure a directory exists.

Parameters

string $dirname

Returns

mixed —

getConnection()

getConnection() : mixed

Returns

mixed —

getPermPublic()

getPermPublic() : int

Get the public permission value.

Returns

int —

getPermPrivate()

getPermPrivate() : int

Get the private permission value.

Returns

int —

__destruct()

__destruct() : mixed

Disconnect on destruction.

Returns

mixed —

connect()

connect() : mixed

Connect to the FTP server.

Returns

mixed —

disconnect()

disconnect() : mixed

Disconnect from the FTP server.

Returns

mixed —

isConnected()

isConnected() : bool

Check if the connection is open.

Throws

\ErrorException

Returns

bool —

setPathPrefix()

setPathPrefix(string  $prefix) : void

Set the path prefix.

Parameters

string $prefix

getPathPrefix()

getPathPrefix() : string|null

Get the path prefix.

Returns

string|null —

path prefix or null if pathPrefix is empty

applyPathPrefix()

applyPathPrefix(string  $path) : string

Prefix a path.

Parameters

string $path

Returns

string —

prefixed path

removePathPrefix()

removePathPrefix(string  $path) : string

Remove a path prefix.

Parameters

string $path

Returns

string —

path without the prefix

setTransferMode()

setTransferMode(int  $mode) : $this

Set the transfer mode.

Parameters

int $mode

Returns

$this —

setSsl()

setSsl(bool  $ssl) : $this

Set if Ssl is enabled.

Parameters

bool $ssl

Returns

$this —

setPassive()

setPassive(bool  $passive = true) : mixed

Set if passive mode should be used.

Parameters

bool $passive

Returns

mixed —

setIgnorePassiveAddress()

setIgnorePassiveAddress(bool  $ignorePassiveAddress) : mixed

Parameters

bool $ignorePassiveAddress

Returns

mixed —

setRecurseManually()

setRecurseManually(bool  $recurseManually) : mixed

Parameters

bool $recurseManually

Returns

mixed —

setUtf8()

setUtf8(bool  $utf8) : mixed

Parameters

bool $utf8

Returns

mixed —

write()

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

Parameters

mixed $path
mixed $contents
\League\Flysystem\Config $config

Returns

mixed —

update()

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

Parameters

mixed $path
mixed $contents
\League\Flysystem\Config $config

Returns

mixed —

updateStream()

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

Parameters

mixed $path
mixed $resource
\League\Flysystem\Config $config

Returns

mixed —

rename()

rename(mixed  $path, mixed  $newpath) : mixed

Parameters

mixed $path
mixed $newpath

Returns

mixed —

delete()

delete(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

deleteDir()

deleteDir(mixed  $dirname) : mixed

Parameters

mixed $dirname

Returns

mixed —

createDir()

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

Parameters

mixed $dirname
\League\Flysystem\Config $config

Returns

mixed —

getMetadata()

getMetadata(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getMimetype()

getMimetype(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getTimestamp()

getTimestamp(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

read()

read(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

setVisibility()

setVisibility(mixed  $path, mixed  $visibility) : mixed

Parameters

mixed $path
mixed $visibility

Returns

mixed —

listDirectoryContents()

listDirectoryContents(string  $directory, mixed  $recursive = true) : mixed

Parameters

string $directory
mixed $recursive

Returns

mixed —

normalizeListing()

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

Normalize a directory listing.

Parameters

array $listing
string $prefix

Returns

array —

directory listing

sortListing()

sortListing(array  $result) : array

Sort a directory listing.

Parameters

array $result

Returns

array —

sorted listing

normalizeObject()

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

Normalize a file entry.

Parameters

string $item
string $base

Throws

\League\Flysystem\NotSupportedException

Returns

array —

normalized file array

normalizeUnixObject()

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

Normalize a Unix file entry.

Parameters

string $item
string $base

Returns

array —

normalized file array

normalizeWindowsObject()

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

Normalize a Windows/DOS file entry.

Parameters

string $item
string $base

Returns

array —

normalized file array

detectSystemType()

detectSystemType(string  $item) : string

Get the system type from a listing item.

Parameters

string $item

Returns

string —

the system type

detectType()

detectType(string  $permissions) : string

Get the file type from the permissions.

Parameters

string $permissions

Returns

string —

file type

normalizePermissions()

normalizePermissions(string  $permissions) : int

Normalize a permissions string.

Parameters

string $permissions

Returns

int —

setUtf8Mode()

setUtf8Mode() : mixed

Set the connection to UTF-8 mode.

Returns

mixed —

setConnectionPassiveMode()

setConnectionPassiveMode() : mixed

Set the connections to passive mode.

Throws

\RuntimeException

Returns

mixed —

setConnectionRoot()

setConnectionRoot() : mixed

Set the connection root.

Returns

mixed —

login()

login() : mixed

Login.

Throws

\RuntimeException

Returns

mixed —

createActualDirectory()

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

Create a directory.

Parameters

string $directory
resource $connection

Returns

bool —

listDirectoryContentsRecursive()

listDirectoryContentsRecursive(string  $directory) : mixed

Parameters

string $directory

Returns

mixed —

isPureFtpdServer()

isPureFtpdServer() : bool

Returns

bool —

ftpRawlist()

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

The ftp_rawlist function with optional escaping.

Parameters

string $options
string $path

Returns

array —