AbstractFilteredStream
in package
implements
StreamInterface
uses
StreamDecoratorTrait
AbstractYes
Table of Contents
Interfaces
- StreamInterface
Constants
- STATE_CLOSED : mixed = 4
- STATE_CLOSING : mixed = 3
- STATE_OPENING : mixed = 1
- STATE_PROCESSING : mixed = 2
Methods
- __construct() : mixed
- __toString() : string
- close() : void
- detach() : resource|null
- eof() : bool
- getContents() : string
- getMetadata() : array<string|int, mixed>|mixed|null
- getSize() : int|null
- isReadable() : bool
- isSeekable() : bool
- isWritable() : bool
- read() : string
- seek() : void
- tell() : int
- write() : int
- processFooter() : string
- processHeader() : string
- processPayload() : string
Constants
STATE_CLOSED
public
mixed
STATE_CLOSED
= 4
STATE_CLOSING
public
mixed
STATE_CLOSING
= 3
STATE_OPENING
public
mixed
STATE_OPENING
= 1
STATE_PROCESSING
public
mixed
STATE_PROCESSING
= 2
Methods
__construct()
public
__construct(StreamInterface $stream) : mixed
Parameters
- $stream : StreamInterface
__toString()
public
__toString() : string
Return values
stringclose()
public
close() : void
detach()
public
detach() : resource|null
Return values
resource|nulleof()
public
eof() : bool
Return values
boolgetContents()
public
getContents() : string
Return values
stringgetMetadata()
public
getMetadata([string|null $key = null ]) : array<string|int, mixed>|mixed|null
Parameters
- $key : string|null = null
Return values
array<string|int, mixed>|mixed|nullgetSize()
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
Tags
Return values
stringseek()
public
seek(int $offset[, int $whence = SEEK_SET ]) : void
Parameters
- $offset : int
- $whence : int = SEEK_SET
Tags
tell()
public
tell() : int
Return values
intwrite()
public
write(string $string) : int
Parameters
- $string : string
Return values
intprocessFooter()
protected
abstract processFooter() : string
Return values
stringprocessHeader()
protected
abstract processHeader() : string
Return values
stringprocessPayload()
protected
abstract processPayload(string $data) : string
Parameters
- $data : string