Documentation

ResourceWrapper
in package
implements StreamInterface

A wrapper for a resource providing it with a PSR-7 StreamInterface API.

Tags
author

zozlak

Interfaces, Classes, Traits and Enums

StreamInterface

Table of Contents

$res  : resource
__construct()  : mixed
__toString()  : string
close()  : void
detach()  : resource
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

Methods

__construct()

public __construct(resource $resource) : mixed
Parameters
$resource : resource
Tags
Return values
mixed

__toString()

public __toString() : string
Tags
Return values
string

getContents()

public getContents() : string
Tags
Return values
string

getMetadata()

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

getSize()

public getSize() : int|null
Tags
Return values
int|null

isReadable()

public isReadable() : bool
Tags
Return values
bool

isSeekable()

public isSeekable() : bool
Tags
Return values
bool

isWritable()

public isWritable() : bool
Tags
Return values
bool

read()

public read(int $length) : string
Parameters
$length : int
Tags
Return values
string

seek()

public seek(int $offset[, int $whence = SEEK_SET ]) : void
Parameters
$offset : int
$whence : int = SEEK_SET
Tags
throws
RuntimeException
Return values
void

write()

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

        

Search results