NoSeekStream
in package
implements
StreamInterface
Uses
StreamDecoratorTrait
Stream decorator that prevents a stream from being seeked.
Tags
Interfaces, Classes and Traits
- StreamInterface
- Describes a data stream.
Table of Contents
- __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() : bool
- Returns whether or not the stream is seekable.
- isWritable() : mixed
- read() : mixed
- rewind() : mixed
- seek() : mixed
- Seek to a position in the stream.
- tell() : mixed
- write() : mixed
- createStream() : StreamInterface
- Implement in subclasses to dynamically create streams when requested.
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) : mixed
Parameters
- $stream : StreamInterface
-
Stream to decorate
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 —__toString()
public
__toString() : mixed
Return values
mixed —close()
public
close() : mixed
Return values
mixed —detach()
public
detach() : mixed
Return values
mixed —eof()
public
eof() : mixed
Return values
mixed —getContents()
public
getContents() : mixed
Return values
mixed —getMetadata()
public
getMetadata([mixed $key = null ]) : mixed
Parameters
- $key : mixed = null
Return values
mixed —getSize()
public
getSize() : mixed
Return values
mixed —isReadable()
public
isReadable() : mixed
Return values
mixed —isSeekable()
Returns whether or not the stream is seekable.
public
isSeekable() : bool
Return values
bool —isWritable()
public
isWritable() : mixed
Return values
mixed —read()
public
read(mixed $length) : mixed
Parameters
- $length : mixed
Return values
mixed —rewind()
public
rewind() : mixed
Return values
mixed —seek()
Seek to a position in the stream.
public
seek(mixed $offset[, mixed $whence = SEEK_SET ]) : mixed
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.
Return values
mixed —tell()
public
tell() : mixed
Return values
mixed —write()
public
write(mixed $string) : mixed
Parameters
- $string : mixed
Return values
mixed —createStream()
Implement in subclasses to dynamically create streams when requested.
protected
createStream() : StreamInterface