Documentation

StreamedTrait uses trait:short, trait:short

Table of Contents

Methods

read()  : array<string|int, mixed>|false
Reads a file.
readStream()  : array<string|int, mixed>|false
Reads a file as a stream.
update()  : mixed
updateStream()  : mixed
Update a file using a stream.
write()  : mixed
writeStream()  : mixed
Write using a stream.
stream()  : mixed
Stream fallback delegator.

Methods

read()

Reads a file.

public abstract read(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Tags
see
ReadInterface::read()
Return values
array<string|int, mixed>|false

readStream()

Reads a file as a stream.

public readStream(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Tags
see
ReadInterface::readStream()
Return values
array<string|int, mixed>|false

update()

public abstract update(mixed $pash, mixed $contents, Config $config) : mixed
Parameters
$pash : mixed
$contents : mixed
$config : Config

updateStream()

Update a file using a stream.

public updateStream(string $path, resource $resource, Config $config) : mixed
Parameters
$path : string
$resource : resource
$config : Config

Config object or visibility setting

Return values
mixed

false of file metadata

writeStream()

Write using a stream.

public writeStream(string $path, resource $resource, Config $config) : mixed
Parameters
$path : string
$resource : resource
$config : Config
Return values
mixed

false or file metadata

stream()

Stream fallback delegator.

protected stream(string $path, resource $resource, Config $config, string $fallback) : mixed
Parameters
$path : string
$resource : resource
$config : Config
$fallback : string
Return values
mixed

fallback result


        
On this page

Search results