Class UploadedFile

Class สำหรับจัดการไฟล์อัปโหลด.

Kotchasan\Http\UploadedFile implements Psr\Http\Message\UploadedFileInterface

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

Methods summary
`public`	# `__construct( string $path, string $originalName, string $mimeType = null, integer $size = null, integer $error = null, boolean $sapi = true )` ไฟล์อัปโหลด. ไฟล์อัปโหลด. Parameters `$path` ไฟล์อัปโหลด รวมพาธ `$originalName` ชื่อไฟล์ที่อัปโหลด `$mimeType` MIME Type `$size` ขนาดไฟล์อัปโหลด `$error` ข้อผิดพลาดการอัปโหลด UPLOAD_ERR_XXX `$sapi` indicates if the upload is in a SAPI environment
`public boolean`	# `copyTo( string $targetPath )` สำเนาไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย. สำเนาไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย. Parameters `$targetPath` ที่อยู่ปลายทางที่ต้องการย้าย Returns boolean Throws `RuntimeException` ข้อผิดพลาดการอัปโหลด `InvalidArgumentException` ไดเรคทอรี่ไม่สามารถเขียนได้
`public boolean\|string`	# `cropImage( array $exts, string $targetPath, integer $width, integer $height, string $watermark = '' )` ฟังก์ชั่น ตัดรูปภาพ ตามขนาดที่กำหนด และย้ายไปยังปลายทาง รูปภาพปลายทางจะมีขนาดเท่าที่กำหนด หากรูปภาพต้นฉบับมีขนาดหรืออัตราส่วนไม่พอดีกับขนาดของภาพปลายทาง รูปภาพจะถูกตัดขอบออกหรือจะถูกขยาย เพื่อให้พอดีกับรูปภาพปลายทางที่ต้องการ ผลลัพท์จะได้ไฟล์รูปภาพ jpg เท่านั้น สำเร็จคืนค่า true ไม่สำเร็จคืนค่าข้อความผิดพลาด. ฟังก์ชั่น ตัดรูปภาพ ตามขนาดที่กำหนด และย้ายไปยังปลายทาง รูปภาพปลายทางจะมีขนาดเท่าที่กำหนด หากรูปภาพต้นฉบับมีขนาดหรืออัตราส่วนไม่พอดีกับขนาดของภาพปลายทาง รูปภาพจะถูกตัดขอบออกหรือจะถูกขยาย เพื่อให้พอดีกับรูปภาพปลายทางที่ต้องการ ผลลัพท์จะได้ไฟล์รูปภาพ jpg เท่านั้น สำเร็จคืนค่า true ไม่สำเร็จคืนค่าข้อความผิดพลาด. Parameters `$exts` นามสกุลของไฟล์รูปภาพที่ยอมรับ เช่น [jpg, gif, png] `$targetPath` path และชื่อไฟล์ของไฟล์รูปภาพปลายทาง `$width` ความกว้างของรูปภาพที่ต้องการ `$height` ความสูงของรูปภาพที่ต้องการ `$watermark` (optional) ข้อความลายน้ำ Returns boolean\|string Throws `InvalidArgumentException` ข้อผิดพลาดหากที่อยู่ปลายทางไม่สามารถเขียนได้ `RuntimeException` ข้อผิดพลาดไม่สามารถสร้างรูปภาพได้
`public string`	# `getCleanFilename( string $replace = '_' )` อ่านชื่อไฟล์จากไฟล์ที่อัปโหลดและตัดตัวอักษที่ไม่สามารถใช้เป็นชื่อไฟล์ได้ออก ยอมรับ ภาษาอังกฤษ ตัวเลข ( ) _ - และ .(จุด) เท่านั้น นอกเหนือจากนั้นจะถูกแทนที่ด้วย $replace ติดกันไม่เกิน 1 ตัวอักษร. อ่านชื่อไฟล์จากไฟล์ที่อัปโหลดและตัดตัวอักษที่ไม่สามารถใช้เป็นชื่อไฟล์ได้ออก ยอมรับ ภาษาอังกฤษ ตัวเลข ( ) _ - และ .(จุด) เท่านั้น นอกเหนือจากนั้นจะถูกแทนที่ด้วย $replace ติดกันไม่เกิน 1 ตัวอักษร. Parameters `$replace` ตัวอักษรที่จะแทนที่อักขระไที่ไม่ต้องการ ถ้าไม่ระบุจะใช้ _ (ขีดล่าง) Returns string
`public string`	# `getClientFileExt( )` คืนค่านามสกุลของไฟล์อัปโหลด ตัวพิมพ์เล็ก เช่น jpg. คืนค่านามสกุลของไฟล์อัปโหลด ตัวพิมพ์เล็ก เช่น jpg. Returns string
`public string\|null`	# `getClientFilename( )` อ่านชื่อไฟล์ (ต้นฉบับ) ของไฟล์ที่อัปโหลด. อ่านชื่อไฟล์ (ต้นฉบับ) ของไฟล์ที่อัปโหลด. Returns string\|null Implementation of `Psr\Http\Message\UploadedFileInterface::getClientFilename()`
`public string\|null`	# `getClientMediaType( )` อ่าน MIME Type ของไฟล์. อ่าน MIME Type ของไฟล์. Returns string\|null Implementation of `Psr\Http\Message\UploadedFileInterface::getClientMediaType()`
`public integer`	# `getError( )` อ่านข้อผิดพลาดของไฟล์อัปโหลด คืนค่า UPLOAD_ERR_XXX. อ่านข้อผิดพลาดของไฟล์อัปโหลด คืนค่า UPLOAD_ERR_XXX. Returns integer Implementation of `Psr\Http\Message\UploadedFileInterface::getError()`
`public string`	# `getErrorMessage( )` อ่านข้อผิดพลาดของไฟล์อัปโหลด เป็นข้อความ อ่านข้อผิดพลาดของไฟล์อัปโหลด เป็นข้อความ Returns string
`public integer\|null`	# `getSize( )` อ่านขนาดของไฟล์อัปโหลด. อ่านขนาดของไฟล์อัปโหลด. Returns integer\|null Implementation of `Psr\Http\Message\UploadedFileInterface::getSize()`
`public StreamInterface`	# `getStream( )` ส่งออกไฟล์อัปโหลดเป็น Stream. ส่งออกไฟล์อัปโหลดเป็น Stream. Returns StreamInterface Throws `RuntimeException` ถ้าไม่พบไฟล์ Implementation of `Psr\Http\Message\UploadedFileInterface::getStream()`
`public string\|null`	# `getTempFileName( )` อ่านไฟล์รวม path จากตัวแปร tmp_name. อ่านไฟล์รวม path จากตัวแปร tmp_name. Returns string\|null
`public static string\|integer`	# `getUploadSize( boolean $return_byte = false )` อ่านการตั้งค่าขนาดของไฟลอัปโหลด. อ่านการตั้งค่าขนาดของไฟลอัปโหลด. Parameters `$return_byte` false (default) คืนค่าเป็นข้อความเช่น 2M, true คืนค่าเป็นตัวเลข (byte) Returns string\|integer
`public boolean`	# `hasError( )` ตรวจสอบว่ามีข้อผิดพลาดการอัปโหลดหรือไม่ คืนค่า false ถ้าไม่มีไฟล์อัปโหลดหรืออัปโหลดสำเร็จ, คืนค่า true ถ้ามีข้อผิดพลาด. ตรวจสอบว่ามีข้อผิดพลาดการอัปโหลดหรือไม่ คืนค่า false ถ้าไม่มีไฟล์อัปโหลดหรืออัปโหลดสำเร็จ, คืนค่า true ถ้ามีข้อผิดพลาด. Returns boolean
`public boolean`	# `hasUploadFile( )` ตรวจสอบไฟล์อัปโหลด คืนค่า true ถ้ามีไฟล์อัปโหลด. ตรวจสอบไฟล์อัปโหลด คืนค่า true ถ้ามีไฟล์อัปโหลด. Returns boolean
`public boolean`	# `moveTo( string $targetPath )` ย้ายไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย. ย้ายไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย. Parameters `$targetPath` ที่อยู่ปลายทางที่ต้องการย้าย Returns boolean Throws `InvalidArgumentException` ข้อผิดพลาดหากที่อยู่ปลายทางไม่สามารถเขียนได้ `RuntimeException` ข้อผิดพลาดการอัปโหลด Implementation of `Psr\Http\Message\UploadedFileInterface::moveTo()`
`public array\|boolean`	# `resizeImage( array $exts, string $target, string $name, integer $width, string $watermark = '' )` ปรับขนาดของรูปภาพอัปโหลด โดยรักษาอัตราส่วนของภาพตามความกว้างที่ต้องการ หากรูปภาพมีขนาดเล็กกว่าที่กำหนด จะเป็นการ copy file หากรูปภาพมีความสูง หรือความกว้างมากกว่า $width จะถูกปรับขนาดให้มีขนาดไม่เกิน $width (ทั้งความสูงและความกว้าง) และเปลี่ยนชนิดของภาพเป็น jpg คืนค่าแอเรย์ [name, width, height, mime] ของรูปภาพปลายทาง หรือ false ถ้าไม่สามารถดำเนินการได้. ปรับขนาดของรูปภาพอัปโหลด โดยรักษาอัตราส่วนของภาพตามความกว้างที่ต้องการ หากรูปภาพมีขนาดเล็กกว่าที่กำหนด จะเป็นการ copy file หากรูปภาพมีความสูง หรือความกว้างมากกว่า $width จะถูกปรับขนาดให้มีขนาดไม่เกิน $width (ทั้งความสูงและความกว้าง) และเปลี่ยนชนิดของภาพเป็น jpg คืนค่าแอเรย์ [name, width, height, mime] ของรูปภาพปลายทาง หรือ false ถ้าไม่สามารถดำเนินการได้. Parameters `$exts` นามสกุลของไฟล์รูปภาพที่ยอมรับ เช่น [jpg, gif, png] `$target` path ของไฟล์รูปภาพปลายทาง `$name` ชื่อไฟล์ของรูปภาพปลายทาง `$width` ขนาดสูงสุดของรูปภาพที่ต้องการ `$watermark` (optional) ข้อความลายน้ำ Returns array\|boolean
`public boolean`	# `validFileExt( array $exts )` ตรวจสอบนามสกุลของไฟล์อัปโหลด คืนค่า true ถ้านามสกุลของไฟล์อัปโหลดอยู่ใน $exts. ตรวจสอบนามสกุลของไฟล์อัปโหลด คืนค่า true ถ้านามสกุลของไฟล์อัปโหลดอยู่ใน $exts. Parameters `$exts` รายการนามสกุลของไฟล์อัปโหลดที่ยอมรับ เช่น [jpg, gif, png] Returns boolean