Flow PHP

StdOutFilesystem implements Filesystem

FinalYes

Interfaces

Filesystem

Methods

__construct() : mixed
appendTo() : DestinationStream
create() : DestinationStream: Bytes become visible whole at close().
fromArray() : static
getSystemTmpDir() : Path
list() : Generator<string|int, FileStatus>
mount() : Mount
mv() : bool
normalize() : null|array<string, mixed>
readFrom() : SourceStream
rm() : bool
status() : FileStatus|null
supports() : bool: True when this filesystem serves the given path's protocol.
writeTo() : DestinationStream: Open destination stream for writing, if file already exists it will be overwritten.

__construct()


    public
                    __construct([Mount $mount = new Mount('stdout') ][, php_user_filter|null $filter = null ]) : mixed

Parameters

$mount : Mount = new Mount('stdout')
$filter : php_user_filter|null = null

appendTo()


    public
                    appendTo(Path $path) : DestinationStream

Parameters

$path : Path

Return values

DestinationStream

create()

Bytes become visible whole at close().


    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>: untrusted: decoded from another process, validated here

Return values

static

getSystemTmpDir()


    public
                    getSystemTmpDir() : Path

Return values

Path

list()


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

Parameters

$path : Path
$pathFilter : Filter = new KeepAll()

Return values

Generator<string|int, FileStatus>

mount()


    public
                    mount() : Mount

Return values

Mount

mv()


    public
                    mv(Path $from, Path $to) : bool

Parameters

$from : Path
$to : Path

Return values

bool

normalize()


    public
                    normalize() : null|array<string, mixed>

Return values

null|array<string, mixed> —

null when this instance holds live state (a client, memory) and cannot be rebuilt

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()

True when this filesystem serves the given path's protocol.


    public
                    supports(Path $path) : bool

Parameters

$path : Path

Return values

bool

writeTo()

Open destination stream for writing, if file already exists it will be overwritten.


    public
                    writeTo(Path $path) : DestinationStream

Parameters

$path : Path

Return values

DestinationStream