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