SDK for PHP V3

HashingStream
in package
implements StreamInterface Uses StreamDecoratorTrait

Stream decorator that calculates a rolling hash of the stream as it is read.

Table of Contents

Interfaces

StreamInterface
Describes a data stream.

Methods

__call()  : mixed
Allow decorators to implement custom methods
__construct()  : mixed
__get()  : StreamInterface
Magic method used to create a new stream if streams are not added in the constructor of a decorator (e.g., LazyOpenStream).
__toString()  : string
close()  : void
detach()  : mixed
eof()  : bool
getContents()  : string
getMetadata()  : mixed
getSize()  : int|null
isReadable()  : bool
isSeekable()  : bool
isWritable()  : bool
read()  : string
Read data from the stream.
rewind()  : void
seek()  : void
Seek to a position in the stream.
tell()  : int
write()  : int

Methods

__call()

Allow decorators to implement custom methods

public __call(string $method, array<string|int, mixed> $args) : mixed
Parameters
$method : string
$args : array<string|int, mixed>

__construct()

public __construct(StreamInterface $stream, HashInterface $hash[, callable $onComplete = null ]) : mixed
Parameters
$stream : StreamInterface

Stream that is being read.

$hash : HashInterface

Hash used to calculate checksum.

$onComplete : callable = null

Optional function invoked when the hash calculation is completed.

__get()

Magic method used to create a new stream if streams are not added in the constructor of a decorator (e.g., LazyOpenStream).

public __get(string $name) : StreamInterface
Parameters
$name : string
Return values
StreamInterface

__toString()

public __toString() : string
Return values
string

close()

public close() : void

detach()

public detach() : mixed

eof()

public eof() : bool
Return values
bool

getContents()

public getContents() : string
Return values
string

getMetadata()

public getMetadata([string|null $key = null ]) : mixed
Parameters
$key : string|null = null

getSize()

public getSize() : int|null
Return values
int|null

isReadable()

public isReadable() : bool
Return values
bool

isSeekable()

public isSeekable() : bool
Return values
bool

isWritable()

public isWritable() : bool
Return values
bool

read()

Read data from the stream.

public read(mixed $length) : string
Parameters
$length : mixed

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Return values
string —

Returns the data read from the stream, or an empty string if no bytes are available.

rewind()

public rewind() : void

seek()

Seek to a position in the stream.

public seek(mixed $offset[, mixed $whence = SEEK_SET ]) : void
Parameters
$offset : mixed

Stream offset

$whence : mixed = SEEK_SET

Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset.

tell()

public tell() : int
Return values
int

write()

public write(string $string) : int
Parameters
$string : string
Return values
int
<-- modeled_exceptions -->
On this page