Flow PHP

SFTPFilesystem implements Filesystem

Read onlyYes
FinalYes
Tags
type

SFTPConfiguration = array{protocol: string, client: SFTPClientConfiguration, options: SFTPOptions}

import-type

SFTPOptions from Options

SFTPClientConfiguration from ConfiguredSFTPClient

Interfaces

Filesystem

Methods

__construct()  : mixed
appendTo()  : DestinationStream
create()  : DestinationStream
fromArray()  : static
getSystemTmpDir()  : Path
list()  : Generator<int, FileStatus>
mount()  : Mount
mv()  : bool
normalize()  : null|SFTPConfiguration
readFrom()  : SourceStream
rm()  : bool
status()  : FileStatus|null
supports()  : bool
writeTo()  : DestinationStream

Methods

appendTo()

public appendTo(Path $path) : DestinationStream
Parameters
$path : Path
Return values
DestinationStream

create()

public create(Path $path) : DestinationStream
Parameters
$path : Path
Return values
DestinationStream

fromArray()

public static fromArray(array<string|int, mixed> $configuration) : static
Parameters
$configuration : array<string|int, mixed>
Return values
static

getSystemTmpDir()

public getSystemTmpDir() : Path
Return values
Path

list()

public list(Path $path[, Filter $pathFilter = new KeepAll() ]) : Generator<int, FileStatus>
Parameters
$path : Path
$pathFilter : Filter = new KeepAll()
Return values
Generator<int, FileStatus>

mv()

public mv(Path $from, Path $to) : bool
Parameters
$from : Path
$to : Path
Return values
bool

normalize()

public normalize() : null|SFTPConfiguration
Return values
null|SFTPConfiguration

readFrom()

public readFrom(Path $path) : SourceStream
Parameters
$path : Path
Return values
SourceStream

rm()

public rm(Path $path[, bool $recursive = true ]) : bool
Parameters
$path : Path
$recursive : bool = true
Return values
bool

status()

public status(Path $path) : FileStatus|null
Parameters
$path : Path
Return values
FileStatus|null

supports()

public supports(Path $path) : bool
Parameters
$path : Path
Return values
bool

writeTo()

public writeTo(Path $path) : DestinationStream
Parameters
$path : Path
Return values
DestinationStream
On this page

Search results