\Puyo\Psr7Stream

ストリームを抽象化したもの

PSR-7 の StreamInterface の実装。 HTTPに限らず利用できるが、現状はバイナリにしか対応していない。

Summary

Methods
Properties
Constants
__construct()
__destruct()
__toString()
close()
detach()
attach()
getSize()
tell()
eof()
isSeekable()
seek()
rewind()
isWritable()
write()
isReadable()
read()
getContents()
getMetaData()
No public properties found
No constants found
No protected methods found
$fp
$tmpFp
N/A
setStream()
isAvailableStream()
closeTmpStream()
No private properties found
N/A

Properties

$fp

$fp : resource

Type

resource

$tmpFp

$tmpFp : resource

ファイルのパスから生成した場合に内部で開くためのStream

Type

resource

Methods

__construct()

__construct(resource|string  $fileOrStream, string  $mode = 'rb') 

ファイルのフルパスもしくはresourceから生成する

Parameters

resource|string $fileOrStream
string $mode

__destruct()

__destruct() 

ファイルパスから生成した場合の一時Streamを解放する

__toString()

__toString() : string

すべてのデータを文字列で取得する

Returns

string —

content

close()

close() 

{@inheritdoc}

detach()

detach() : resource

Returns

resource

attach()

attach(string|resource  $fileOrStream, string  $mode = 'rb') 

streamもしくはファイルのフルパスからstreamを割り当てる

Parameters

string|resource $fileOrStream
string $mode

getSize()

getSize() : integer|null

データサイズを返す

Returns

integer|null —

閉じられている場合はnull

tell()

tell() : integer

現在の書き込みのポインタ位置を返す {@inheritdoc}

Returns

integer

eof()

eof() : boolean

{@inheritdoc}

Returns

boolean —

終端、もしくは未オープンの場合

isSeekable()

isSeekable() : boolean

{@inheritdoc}

Returns

boolean

seek()

seek(integer  $offset, integer  $whence = SEEK_SET) : void

{@inheritdoc}

Parameters

integer $offset
integer $whence

SEEK_* constant

Throws

\RuntimeException

シーク失敗時

rewind()

rewind() : void

ポインタを先頭に戻す

isWritable()

isWritable() : boolean

{@inheritdoc}

Returns

boolean

write()

write(string  $string) : integer

書き込む

Parameters

string $string

Returns

integer —

書き込みバイト数

isReadable()

isReadable() : boolean

{@inheritdoc}

Returns

boolean

read()

read(integer  $length) : string

読み込み

Parameters

integer $length

bytes

Returns

string —

読み込んだデータ

getContents()

getContents() : string

残りのストリームすべてを返す

Returns

string

getMetaData()

getMetaData(string  $key = null) : array|null

{@inheritdoc}

Parameters

string $key

(optional)

Returns

array|null

setStream()

setStream(  $fileOrStream,   $mode = 'rb') 

Parameters

$fileOrStream
$mode

isAvailableStream()

isAvailableStream(resource  $fp) : boolean

Parameters

resource $fp

Returns

boolean

closeTmpStream()

closeTmpStream()