kotchasan

Stream
in package
implements StreamInterface

Data stream class (PSR-7)

Tags
author

Goragod Wiriya admin@goragod.com

since
1.0

Interfaces, Classes and Traits

StreamInterface
Describes a data stream.

Table of Contents

$meta  : array<string|int, mixed>
stream metadata
$readable  : bool
stream readable
$seekable  : bool
stream seekable
$size  : null|int
stream size
$stream  : resource
stream resource
$writable  : bool
stream writable
__construct()  : mixed
Create a new Stream
__toString()  : string
อ่านข้อมูลทั้งหมดของ stream ส่งออกเป็น string
close()  : mixed
ยกเลิก stream คืนหน่วยความจำ
detach()  : resource|null
reset ข้อมูลของ Class กลับเป็นค่าเริ่มต้น คืนค่า resource เดิม
eof()  : bool
ตรวจสอบว่า pointer อยู่ที่จุดสุดท้ายของ stream หรือยัง คืนค่า true ถ้าอยู่ที่จุดสิ้นสุดของไฟล์
getContents()  : string
อ่านข้อมูลทั้งหมดจาก stream
getMetadata()  : array<string|int, mixed>|mixed|null
อ่านข้อมูลประจำตัวของ stream array คืนค่าข้อมูลทั้งหมด ถ้าไม่ระบุ $key mixed คืนค่าข้อมูลจาก $key ที่กำหนด null ไม่พบ $key หรือไม่ใช่ stream
getSize()  : int|null
อ่านขนาดของ stream คืนค่าขนาดเป็น byte หรือ null ถ้าไม่รู้ขนาด
isReadable()  : bool
ตรวจสอบว่าสามารถอ่านข้อมูล stream ได้หรือไม่ คืนค่า true ถ้าอ่านได้
isSeekable()  : bool
อ่านความสามารถในการกำหนดตำแหน่งของ pointer คืนค่า true ถ้าสามารถ seek ได้
isWritable()  : bool
ตรวจสอบว่าสามารถเขียน stream ได้หรือไม่ คืนค่า true ถ้าเขียนได้
read()  : string
อ่านข้อมูล stream ตามจำนวนที่กำหนด
rewind()  : mixed
เลื่อน pointer ไปยังจุดเริ่มต้นของ stream
seek()  : mixed
เลื่อน pointer ไปยังตำแหน่งที่กำหนด
tell()  : int
คืนค่าตำแหน่งของ pointer ปัจจุบัน
write()  : int
เขียนข้อมูลลงบน stream คืนค่าจำนวน byte ที่เขียน

Properties

$meta

stream metadata

protected array<string|int, mixed> $meta

$readable

stream readable

protected bool $readable

$seekable

stream seekable

protected bool $seekable

$size

stream size

protected null|int $size

$stream

stream resource

protected resource $stream

$writable

stream writable

protected bool $writable

Methods

__construct()

Create a new Stream

public __construct(resource $stream[, string $mode = 'r' ]) : mixed
Parameters
$stream : resource
$mode : string = 'r'
Tags
throws
InvalidArgumentException

$stream ไม่ใช่ resource

Return values
mixed

__toString()

อ่านข้อมูลทั้งหมดของ stream ส่งออกเป็น string

public __toString() : string
Return values
string

close()

ยกเลิก stream คืนหน่วยความจำ

public close() : mixed
Return values
mixed

detach()

reset ข้อมูลของ Class กลับเป็นค่าเริ่มต้น คืนค่า resource เดิม

public detach() : resource|null
Return values
resource|null

eof()

ตรวจสอบว่า pointer อยู่ที่จุดสุดท้ายของ stream หรือยัง คืนค่า true ถ้าอยู่ที่จุดสิ้นสุดของไฟล์

public eof() : bool
Return values
bool

getContents()

อ่านข้อมูลทั้งหมดจาก stream

public getContents() : string
Tags
throws
RuntimeException

ถ้าไม่สามารถอ่านได้

Return values
string

getMetadata()

อ่านข้อมูลประจำตัวของ stream array คืนค่าข้อมูลทั้งหมด ถ้าไม่ระบุ $key mixed คืนค่าข้อมูลจาก $key ที่กำหนด null ไม่พบ $key หรือไม่ใช่ stream

public getMetadata([string $key = null ]) : array<string|int, mixed>|mixed|null
Parameters
$key : string = null
Return values
array<string|int, mixed>|mixed|null

getSize()

อ่านขนาดของ stream คืนค่าขนาดเป็น byte หรือ null ถ้าไม่รู้ขนาด

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

isReadable()

ตรวจสอบว่าสามารถอ่านข้อมูล stream ได้หรือไม่ คืนค่า true ถ้าอ่านได้

public isReadable() : bool
Return values
bool

isSeekable()

อ่านความสามารถในการกำหนดตำแหน่งของ pointer คืนค่า true ถ้าสามารถ seek ได้

public isSeekable() : bool
Return values
bool

isWritable()

ตรวจสอบว่าสามารถเขียน stream ได้หรือไม่ คืนค่า true ถ้าเขียนได้

public isWritable() : bool
Return values
bool

read()

อ่านข้อมูล stream ตามจำนวนที่กำหนด

public read(int $length) : string
Parameters
$length : int

จำนวนที่ต้องการ

Tags
throws
RuntimeException

ถ้าไม่สามารถอ่านได้

Return values
string

rewind()

เลื่อน pointer ไปยังจุดเริ่มต้นของ stream

public rewind() : mixed
Tags
throws
RuntimeException

on failure

Return values
mixed

seek()

เลื่อน pointer ไปยังตำแหน่งที่กำหนด

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

ตำแหน่งของ pointer

$whence : int = SEEK_SET
Tags
throws
RuntimeException

on failure

Return values
mixed

tell()

คืนค่าตำแหน่งของ pointer ปัจจุบัน

public tell() : int
Tags
throws
RuntimeException

on error

Return values
int

write()

เขียนข้อมูลลงบน stream คืนค่าจำนวน byte ที่เขียน

public write(string $string) : int
Parameters
$string : string

ข้อมูลที่เขียน

Tags
throws
RuntimeException

on failure

Return values
int

Search results