Documentation

NoSeekStream
in package
implements StreamInterface uses StreamDecoratorTrait

FinalYes

Stream decorator that prevents a stream from being seeked.

Table of Contents

Interfaces

StreamInterface
Describes a data stream.

Properties

$stream  : StreamInterface

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
Returns whether or not the stream is seekable.
isWritable()  : bool
read()  : string
rewind()  : void
seek()  : void
Seek to a position in the stream.
tell()  : int
write()  : int
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
$args : array<string|int, mixed>

getMetadata()

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

isSeekable()

Returns whether or not the stream is seekable.

public isSeekable() : bool
Return values
bool

read()

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

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.

write()

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

        
On this page

Search results