Documentation

DroppingStream
in package
implements StreamInterface Uses StreamDecoratorTrait

Stream decorator that begins dropping data once the size of the underlying stream becomes too full.

Tags
final

Interfaces, Classes and Traits

StreamInterface
Describes a data stream.

Table of Contents

$maxLength  : mixed
__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()  : mixed
close()  : mixed
detach()  : mixed
eof()  : mixed
getContents()  : mixed
getMetadata()  : mixed
getSize()  : mixed
isReadable()  : mixed
isSeekable()  : mixed
isWritable()  : mixed
read()  : mixed
rewind()  : mixed
seek()  : mixed
tell()  : mixed
write()  : int
Write data to the stream.
createStream()  : StreamInterface
Implement in subclasses to dynamically create streams when requested.

Properties

Methods

__call()

Allow decorators to implement custom methods

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

Missing method name

$args : array<string|int, mixed>

Method arguments

Return values
mixed

__construct()

public __construct(StreamInterface $stream, int $maxLength) : mixed
Parameters
$stream : StreamInterface

Underlying stream to decorate.

$maxLength : int

Maximum size before dropping data.

Return values
mixed

__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

Name of the property (allows "stream" only).

Return values
StreamInterface

getMetadata()

public getMetadata([mixed $key = null ]) : mixed
Parameters
$key : mixed = null
Return values
mixed

read()

public read(mixed $length) : mixed
Parameters
$length : mixed
Return values
mixed

seek()

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

write()

Write data to the stream.

public write(mixed $string) : int
Parameters
$string : mixed

The string that is to be written.

Return values
int

Returns the number of bytes written to the stream.

Search results