Class Stream

Data stream class (PSR-7).

Kotchasan\Http\Stream implements Psr\Http\Message\StreamInterface

Namespace: Kotchasan\Http
Author: Goragod Wiriya admin@goragod.com
Since: 1.0
Located at Kotchasan/Http/Stream.php

Methods summary
`public`	# `__construct( resource $stream, string $mode = 'r' )` Create a new Stream. Create a new Stream. Parameters `$stream` `$mode` Throws `InvalidArgumentException` $stream ไม่ใช่ resource
`public string`	# `__toString( )` อ่านข้อมูลทั้งหมดของ stream ส่งออกเป็น string. อ่านข้อมูลทั้งหมดของ stream ส่งออกเป็น string. Returns string Implementation of `Psr\Http\Message\StreamInterface::__toString()`
`public`	# `close( )` ยกเลิก stream คืนหน่วยความจำ. ยกเลิก stream คืนหน่วยความจำ. Implementation of `Psr\Http\Message\StreamInterface::close()`
`public resource\|null`	# `detach( )` reset ข้อมูลของ Class กลับเป็นค่าเริ่มต้น คืนค่า resource เดิม reset ข้อมูลของ Class กลับเป็นค่าเริ่มต้น คืนค่า resource เดิม Returns resource\|null Implementation of `Psr\Http\Message\StreamInterface::detach()`
`public boolean`	# `eof( )` ตรวจสอบว่า pointer อยู่ที่จุดสุดท้ายของ stream หรือยัง คืนค่า true ถ้าอยู่ที่จุดสิ้นสุดของไฟล์. ตรวจสอบว่า pointer อยู่ที่จุดสุดท้ายของ stream หรือยัง คืนค่า true ถ้าอยู่ที่จุดสิ้นสุดของไฟล์. Returns boolean Implementation of `Psr\Http\Message\StreamInterface::eof()`
`public string`	# `getContents( )` อ่านข้อมูลทั้งหมดจาก stream. อ่านข้อมูลทั้งหมดจาก stream. Returns string Throws `RuntimeException` ถ้าไม่สามารถอ่านได้ Implementation of `Psr\Http\Message\StreamInterface::getContents()`
`public array\|mixed\|null`	# `getMetadata( string $key = null )` อ่านข้อมูลประจำตัวของ stream array คืนค่าข้อมูลทั้งหมด ถ้าไม่ระบุ $key mixed คืนค่าข้อมูลจาก $key ที่กำหนด null ไม่พบ $key หรือไม่ใช่ stream. อ่านข้อมูลประจำตัวของ stream array คืนค่าข้อมูลทั้งหมด ถ้าไม่ระบุ $key mixed คืนค่าข้อมูลจาก $key ที่กำหนด null ไม่พบ $key หรือไม่ใช่ stream. Parameters `$key` Returns array\|mixed\|null Implementation of `Psr\Http\Message\StreamInterface::getMetadata()`
`public integer\|null`	# `getSize( )` อ่านขนาดของ stream คืนค่าขนาดเป็น byte หรือ null ถ้าไม่รู้ขนาด. อ่านขนาดของ stream คืนค่าขนาดเป็น byte หรือ null ถ้าไม่รู้ขนาด. Returns integer\|null Implementation of `Psr\Http\Message\StreamInterface::getSize()`
`public boolean`	# `isReadable( )` ตรวจสอบว่าสามารถอ่านข้อมูล stream ได้หรือไม่ คืนค่า true ถ้าอ่านได้. ตรวจสอบว่าสามารถอ่านข้อมูล stream ได้หรือไม่ คืนค่า true ถ้าอ่านได้. Returns boolean Implementation of `Psr\Http\Message\StreamInterface::isReadable()`
`public boolean`	# `isSeekable( )` อ่านความสามารถในการกำหนดตำแหน่งของ pointer คืนค่า true ถ้าสามารถ seek ได้. อ่านความสามารถในการกำหนดตำแหน่งของ pointer คืนค่า true ถ้าสามารถ seek ได้. Returns boolean Implementation of `Psr\Http\Message\StreamInterface::isSeekable()`
`public boolean`	# `isWritable( )` ตรวจสอบว่าสามารถเขียน stream ได้หรือไม่ คืนค่า true ถ้าเขียนได้. ตรวจสอบว่าสามารถเขียน stream ได้หรือไม่ คืนค่า true ถ้าเขียนได้. Returns boolean Implementation of `Psr\Http\Message\StreamInterface::isWritable()`
`public string`	# `read( integer $length )` อ่านข้อมูล stream ตามจำนวนที่กำหนด. อ่านข้อมูล stream ตามจำนวนที่กำหนด. Parameters `$length` จำนวนที่ต้องการ Returns string Throws `RuntimeException` ถ้าไม่สามารถอ่านได้ Implementation of `Psr\Http\Message\StreamInterface::read()`
`public`	# `rewind( )` เลื่อน pointer ไปยังจุดเริ่มต้นของ stream. เลื่อน pointer ไปยังจุดเริ่มต้นของ stream. Throws `RuntimeException` on failure Implementation of `Psr\Http\Message\StreamInterface::rewind()`
`public`	# `seek( integer $offset, integer $whence = SEEK_SET )` เลื่อน pointer ไปยังตำแหน่งที่กำหนด. เลื่อน pointer ไปยังตำแหน่งที่กำหนด. Parameters `$offset` ตำแหน่งของ pointer `$whence` Throws `RuntimeException` on failure Implementation of `Psr\Http\Message\StreamInterface::seek()`
`public integer`	# `tell( )` คืนค่าตำแหน่งของ pointer ปัจจุบัน. คืนค่าตำแหน่งของ pointer ปัจจุบัน. Returns integer Throws `RuntimeException` on error Implementation of `Psr\Http\Message\StreamInterface::tell()`
`public integer`	# `write( string $string )` เขียนข้อมูลลงบน stream คืนค่าจำนวน byte ที่เขียน. เขียนข้อมูลลงบน stream คืนค่าจำนวน byte ที่เขียน. Parameters `$string` ข้อมูลที่เขียน Returns integer Throws `RuntimeException` on failure Implementation of `Psr\Http\Message\StreamInterface::write()`

Properties summary
`protected array`	`$meta` stream metadata. stream metadata.	#
`protected boolean`	`$readable` stream readable. stream readable.	#
`protected boolean`	`$seekable` stream seekable. stream seekable.	#
`protected null\|integer`	`$size` stream size. stream size.	#
`protected resource`	`$stream` stream resource. stream resource.	#
`protected boolean`	`$writable` stream writable. stream writable.	#