Documentation

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

Methods

__construct()

Stream constructor.

public __construct([string|resource|StreamInterface $body = '' ]) : mixed
Parameters
$body : string|resource|StreamInterface = ''

create()

public static create([string|resource|StreamInterface $body = '' ]) : static
Parameters
$body : string|resource|StreamInterface = ''
Return values
static

getMetadata()

{@inheritdoc}

public getMetadata([mixed $key = null ]) : mixed
Parameters
$key : mixed = null

read()

{@inheritdoc}

public read(mixed $length) : string
Parameters
$length : mixed
Return values
string

seek()

{@inheritdoc}

public seek(mixed $offset[, mixed $whence = SEEK_SET ]) : void
Parameters
$offset : mixed
$whence : mixed = SEEK_SET

write()

{@inheritdoc}

public write(mixed $string) : int
Parameters
$string : mixed
Return values
int

        
On this page

Search results