StreamDecorator
Decorates a stream.
Tags
Table of Contents
Properties
Methods
- __toString() : string
- close() : void
- detach() : mixed
- eof() : bool
- getContents() : string
- getMetadata() : mixed
- getSize() : int|null
- isReadable() : bool
- isSeekable() : bool
- isWritable() : bool
- read() : string
- rewind() : void
- seek() : void
- tell() : int
- write() : int
Properties
$stream
protected
StreamInterface
$stream
Methods
__toString()
public
__toString() : string
Return values
stringclose()
public
close() : void
detach()
public
detach() : mixed
eof()
public
eof() : bool
Return values
boolgetContents()
public
getContents() : string
Return values
stringgetMetadata()
public
getMetadata([string|null $key = null ]) : mixed
Parameters
- $key : string|null = null
getSize()
public
getSize() : int|null
Return values
int|nullisReadable()
public
isReadable() : bool
Return values
boolisSeekable()
public
isSeekable() : bool
Return values
boolisWritable()
public
isWritable() : bool
Return values
boolread()
public
read(int $length) : string
Parameters
- $length : int
Return values
stringrewind()
public
rewind() : void
seek()
public
seek(int $offset[, int $whence = SEEK_SET ]) : void
Parameters
- $offset : int
- $whence : int = SEEK_SET
tell()
public
tell() : int
Return values
intwrite()
public
write(string $string) : int
Parameters
- $string : string