Stream
in package
implements
StreamInterface
uses
StreamDecoratorTrait
Class Stream
Table of Contents
Interfaces
- StreamInterface
Properties
- $stream : StreamInterface
Methods
- __construct() : mixed
- Stream constructor.
- __destruct() : void
- __toString() : string
- {@inheritdoc}
- close() : void
- {@inheritdoc}
- create() : static
- detach() : mixed
- {@inheritdoc}
- eof() : bool
- {@inheritdoc}
- getContents() : string
- {@inheritdoc}
- getMetadata() : mixed
- {@inheritdoc}
- getSize() : int|null
- {@inheritdoc}
- isReadable() : bool
- {@inheritdoc}
- isSeekable() : bool
- {@inheritdoc}
- isWritable() : bool
- {@inheritdoc}
- read() : string
- {@inheritdoc}
- rewind() : void
- {@inheritdoc}
- seek() : void
- {@inheritdoc}
- tell() : int
- {@inheritdoc}
- write() : int
- {@inheritdoc}
Properties
$stream
protected
StreamInterface
$stream
Methods
__construct()
Stream constructor.
public
__construct([string|resource|StreamInterface $body = '' ]) : mixed
Parameters
- $body : string|resource|StreamInterface = ''
__destruct()
public
__destruct() : void
Attributes
- #[ReturnTypeWillChange]
__toString()
{@inheritdoc}
public
__toString() : string
Return values
stringclose()
{@inheritdoc}
public
close() : void
create()
public
static create([string|resource|StreamInterface $body = '' ]) : static
Parameters
- $body : string|resource|StreamInterface = ''
Return values
staticdetach()
{@inheritdoc}
public
detach() : mixed
eof()
{@inheritdoc}
public
eof() : bool
Return values
boolgetContents()
{@inheritdoc}
public
getContents() : string
Return values
stringgetMetadata()
{@inheritdoc}
public
getMetadata([mixed $key = null ]) : mixed
Parameters
- $key : mixed = null
getSize()
{@inheritdoc}
public
getSize() : int|null
Return values
int|nullisReadable()
{@inheritdoc}
public
isReadable() : bool
Return values
boolisSeekable()
{@inheritdoc}
public
isSeekable() : bool
Return values
boolisWritable()
{@inheritdoc}
public
isWritable() : bool
Return values
boolread()
{@inheritdoc}
public
read(mixed $length) : string
Parameters
- $length : mixed
Return values
stringrewind()
{@inheritdoc}
public
rewind() : void
seek()
{@inheritdoc}
public
seek(mixed $offset[, mixed $whence = SEEK_SET ]) : void
Parameters
- $offset : mixed
- $whence : mixed = SEEK_SET
tell()
{@inheritdoc}
public
tell() : int
Return values
intwrite()
{@inheritdoc}
public
write(mixed $string) : int
Parameters
- $string : mixed