kotchasan

UploadedFile
in package
implements UploadedFileInterface

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

Tags
author

Goragod Wiriya admin@goragod.com

since
1.0

Interfaces, Classes and Traits

UploadedFileInterface
Value object representing a file uploaded through an HTTP request.

Table of Contents

$error  : int
ข้อผิดพลาดการอัปโหลด UPLOAD_ERR_XXX
$ext  : string
นามสกุลของไฟล์อัปโหลด
$isMoved  : bool
ใช้สำหรับบอกว่ามีการย้ายไฟล์ไปแล้ว
$mime  : string
MIME Type
$name  : string
ชื่อไฟล์ที่อัปโหลด
$sapi  : bool
Indicates if the upload is from a SAPI environment
$size  : int
ขนาดไฟล์อัปโหลด
$stream  : Stream
file stream
$tmp_name  : string
ไฟล์อัปโหลด รวมพาธ
__construct()  : mixed
ไฟล์อัปโหลด
copyTo()  : bool
สำเนาไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย
cropImage()  : bool|string
ฟังก์ชั่น ตัดรูปภาพ ตามขนาดที่กำหนด และย้ายไปยังปลายทาง รูปภาพปลายทางจะมีขนาดเท่าที่กำหนด หากรูปภาพต้นฉบับมีขนาดหรืออัตราส่วนไม่พอดีกับขนาดของภาพปลายทาง รูปภาพจะถูกตัดขอบออกหรือจะถูกขยาย เพื่อให้พอดีกับรูปภาพปลายทางที่ต้องการ ผลลัพท์จะได้ไฟล์รูปภาพ jpg เท่านั้น สำเร็จคืนค่า true ไม่สำเร็จคืนค่าข้อความผิดพลาด
getCleanFilename()  : string
อ่านชื่อไฟล์จากไฟล์ที่อัปโหลดและตัดตัวอักษที่ไม่สามารถใช้เป็นชื่อไฟล์ได้ออก ยอมรับ ภาษาอังกฤษ ตัวเลข ( ) _ - และ .(จุด) เท่านั้น นอกเหนือจากนั้นจะถูกแทนที่ด้วย $replace ติดกันไม่เกิน 1 ตัวอักษร
getClientFileExt()  : string
คืนค่านามสกุลของไฟล์อัปโหลด ตัวพิมพ์เล็ก เช่น jpg
getClientFilename()  : string|null
อ่านชื่อไฟล์ (ต้นฉบับ) ของไฟล์ที่อัปโหลด
getClientMediaType()  : string|null
อ่าน MIME Type ของไฟล์
getError()  : int
อ่านข้อผิดพลาดของไฟล์อัปโหลด คืนค่า UPLOAD_ERR_XXX
getErrorMessage()  : string
อ่านข้อผิดพลาดของไฟล์อัปโหลด เป็นข้อความ
getSize()  : int|null
อ่านขนาดของไฟล์อัปโหลด
getStream()  : StreamInterface
ส่งออกไฟล์อัปโหลดเป็น Stream
getTempFileName()  : string|null
อ่านไฟล์รวม path จากตัวแปร tmp_name
getUploadSize()  : string|int
อ่านการตั้งค่าขนาดของไฟลอัปโหลด
hasError()  : bool
ตรวจสอบว่ามีข้อผิดพลาดการอัปโหลดหรือไม่ คืนค่า false ถ้าไม่มีไฟล์อัปโหลดหรืออัปโหลดสำเร็จ, คืนค่า true ถ้ามีข้อผิดพลาด
hasUploadFile()  : bool
ตรวจสอบไฟล์อัปโหลด คืนค่า true ถ้ามีไฟล์อัปโหลด
moveTo()  : bool
ย้ายไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย
resizeImage()  : array<string|int, mixed>|bool
ปรับขนาดของรูปภาพอัปโหลด โดยรักษาอัตราส่วนของภาพตามความกว้างที่ต้องการ หากรูปภาพมีขนาดเล็กกว่าที่กำหนด จะเป็นการ copy file หากรูปภาพมีความสูง หรือความกว้างมากกว่า $width จะถูกปรับขนาดให้มีขนาดไม่เกิน $width (ทั้งความสูงและความกว้าง) และเปลี่ยนชนิดของภาพเป็น jpg คืนค่าแอเรย์ [name, width, height, mime] ของรูปภาพปลายทาง หรือ false ถ้าไม่สามารถดำเนินการได้
validFileExt()  : bool
ตรวจสอบนามสกุลของไฟล์อัปโหลด คืนค่า true ถ้านามสกุลของไฟล์อัปโหลดอยู่ใน $exts
check()  : bool
ฟังชั่นตรวจสอบไฟล์อัปโหลด คืนค่า true ถ้าสามารถอัปโหลดได้

Properties

$error

ข้อผิดพลาดการอัปโหลด UPLOAD_ERR_XXX

private int $error

$ext

นามสกุลของไฟล์อัปโหลด

private string $ext

$isMoved

ใช้สำหรับบอกว่ามีการย้ายไฟล์ไปแล้ว

private bool $isMoved = false

$name

ชื่อไฟล์ที่อัปโหลด

private string $name

$sapi

Indicates if the upload is from a SAPI environment

private bool $sapi = false

$size

ขนาดไฟล์อัปโหลด

private int $size

$tmp_name

ไฟล์อัปโหลด รวมพาธ

private string $tmp_name

Methods

__construct()

ไฟล์อัปโหลด

public __construct(string $path, string $originalName[, string $mimeType = null ][, int $size = null ][, int $error = null ][, bool $sapi = true ]) : mixed
Parameters
$path : string

ไฟล์อัปโหลด รวมพาธ

$originalName : string

ชื่อไฟล์ที่อัปโหลด

$mimeType : string = null

MIME Type

$size : int = null

ขนาดไฟล์อัปโหลด

$error : int = null

ข้อผิดพลาดการอัปโหลด UPLOAD_ERR_XXX

$sapi : bool = true

indicates if the upload is in a SAPI environment

Return values
mixed

copyTo()

สำเนาไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย

public copyTo(string $targetPath) : bool
Parameters
$targetPath : string

ที่อยู่ปลายทางที่ต้องการย้าย

Tags
throws
RuntimeException

ข้อผิดพลาดการอัปโหลด

throws
InvalidArgumentException

ไดเรคทอรี่ไม่สามารถเขียนได้

Return values
bool

cropImage()

ฟังก์ชั่น ตัดรูปภาพ ตามขนาดที่กำหนด และย้ายไปยังปลายทาง รูปภาพปลายทางจะมีขนาดเท่าที่กำหนด หากรูปภาพต้นฉบับมีขนาดหรืออัตราส่วนไม่พอดีกับขนาดของภาพปลายทาง รูปภาพจะถูกตัดขอบออกหรือจะถูกขยาย เพื่อให้พอดีกับรูปภาพปลายทางที่ต้องการ ผลลัพท์จะได้ไฟล์รูปภาพ jpg เท่านั้น สำเร็จคืนค่า true ไม่สำเร็จคืนค่าข้อความผิดพลาด

public cropImage(array<string|int, mixed> $exts, string $targetPath, int $width, int $height[, string $watermark = '' ]) : bool|string
Parameters
$exts : array<string|int, mixed>

นามสกุลของไฟล์รูปภาพที่ยอมรับ เช่น [jpg, gif, png]

$targetPath : string

path และชื่อไฟล์ของไฟล์รูปภาพปลายทาง

$width : int

ความกว้างของรูปภาพที่ต้องการ

$height : int

ความสูงของรูปภาพที่ต้องการ

$watermark : string = ''

(optional) ข้อความลายน้ำ

Tags
throws
InvalidArgumentException

ข้อผิดพลาดหากที่อยู่ปลายทางไม่สามารถเขียนได้

throws
RuntimeException

ข้อผิดพลาดไม่สามารถสร้างรูปภาพได้

Return values
bool|string

getCleanFilename()

อ่านชื่อไฟล์จากไฟล์ที่อัปโหลดและตัดตัวอักษที่ไม่สามารถใช้เป็นชื่อไฟล์ได้ออก ยอมรับ ภาษาอังกฤษ ตัวเลข ( ) _ - และ .(จุด) เท่านั้น นอกเหนือจากนั้นจะถูกแทนที่ด้วย $replace ติดกันไม่เกิน 1 ตัวอักษร

public getCleanFilename([string $replace = '_' ]) : string
Parameters
$replace : string = '_'

ตัวอักษรที่จะแทนที่อักขระไที่ไม่ต้องการ ถ้าไม่ระบุจะใช้ _ (ขีดล่าง)

Return values
string

getClientFileExt()

คืนค่านามสกุลของไฟล์อัปโหลด ตัวพิมพ์เล็ก เช่น jpg

public getClientFileExt() : string
Return values
string

getClientFilename()

อ่านชื่อไฟล์ (ต้นฉบับ) ของไฟล์ที่อัปโหลด

public getClientFilename() : string|null
Return values
string|null

getClientMediaType()

อ่าน MIME Type ของไฟล์

public getClientMediaType() : string|null
Return values
string|null

getError()

อ่านข้อผิดพลาดของไฟล์อัปโหลด คืนค่า UPLOAD_ERR_XXX

public getError() : int
Return values
int

getErrorMessage()

อ่านข้อผิดพลาดของไฟล์อัปโหลด เป็นข้อความ

public getErrorMessage() : string
Tags
staticvar

array $errors

Return values
string

getSize()

อ่านขนาดของไฟล์อัปโหลด

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

getStream()

ส่งออกไฟล์อัปโหลดเป็น Stream

public getStream() : StreamInterface
Tags
throws
RuntimeException

ถ้าไม่พบไฟล์

Return values
StreamInterface

getTempFileName()

อ่านไฟล์รวม path จากตัวแปร tmp_name

public getTempFileName() : string|null
Return values
string|null

getUploadSize()

อ่านการตั้งค่าขนาดของไฟลอัปโหลด

public static getUploadSize([bool $return_byte = false ]) : string|int
Parameters
$return_byte : bool = false

false (default) คืนค่าเป็นข้อความเช่น 2M, true คืนค่าเป็นตัวเลข (byte)

Return values
string|int

hasError()

ตรวจสอบว่ามีข้อผิดพลาดการอัปโหลดหรือไม่ คืนค่า false ถ้าไม่มีไฟล์อัปโหลดหรืออัปโหลดสำเร็จ, คืนค่า true ถ้ามีข้อผิดพลาด

public hasError() : bool
Return values
bool

hasUploadFile()

ตรวจสอบไฟล์อัปโหลด คืนค่า true ถ้ามีไฟล์อัปโหลด

public hasUploadFile() : bool
Return values
bool

moveTo()

ย้ายไฟล์อัปโหลดไปยังที่อยู่ใหม่ คืนค่า true ถ้าอัปโหลดเรียบร้อย

public moveTo(string $targetPath) : bool
Parameters
$targetPath : string

ที่อยู่ปลายทางที่ต้องการย้าย

Tags
throws
InvalidArgumentException

ข้อผิดพลาดหากที่อยู่ปลายทางไม่สามารถเขียนได้

throws
RuntimeException

ข้อผิดพลาดการอัปโหลด

Return values
bool

resizeImage()

ปรับขนาดของรูปภาพอัปโหลด โดยรักษาอัตราส่วนของภาพตามความกว้างที่ต้องการ หากรูปภาพมีขนาดเล็กกว่าที่กำหนด จะเป็นการ copy file หากรูปภาพมีความสูง หรือความกว้างมากกว่า $width จะถูกปรับขนาดให้มีขนาดไม่เกิน $width (ทั้งความสูงและความกว้าง) และเปลี่ยนชนิดของภาพเป็น jpg คืนค่าแอเรย์ [name, width, height, mime] ของรูปภาพปลายทาง หรือ false ถ้าไม่สามารถดำเนินการได้

public resizeImage(array<string|int, mixed> $exts, string $target, string $name, int $width[, string $watermark = '' ]) : array<string|int, mixed>|bool
Parameters
$exts : array<string|int, mixed>

นามสกุลของไฟล์รูปภาพที่ยอมรับ เช่น [jpg, gif, png]

$target : string

path ของไฟล์รูปภาพปลายทาง

$name : string

ชื่อไฟล์ของรูปภาพปลายทาง

$width : int

ขนาดสูงสุดของรูปภาพที่ต้องการ

$watermark : string = ''

(optional) ข้อความลายน้ำ

Return values
array<string|int, mixed>|bool

validFileExt()

ตรวจสอบนามสกุลของไฟล์อัปโหลด คืนค่า true ถ้านามสกุลของไฟล์อัปโหลดอยู่ใน $exts

public validFileExt(array<string|int, mixed> $exts) : bool
Parameters
$exts : array<string|int, mixed>

รายการนามสกุลของไฟล์อัปโหลดที่ยอมรับ เช่น [jpg, gif, png]

Return values
bool

check()

ฟังชั่นตรวจสอบไฟล์อัปโหลด คืนค่า true ถ้าสามารถอัปโหลดได้

private check(array<string|int, mixed> $exts, string $targetDir) : bool
Parameters
$exts : array<string|int, mixed>

นามสกุลของไฟล์รูปภาพที่ยอมรับ เช่น [jpg, gif, png]

$targetDir : string

ไดเรคทอรี่ปลายทาง

Tags
throws
RuntimeException

ถ้าชนิดของไฟล์อัปโหลดไม่ถูกต้อง

throws
InvalidArgumentException

ถ้าไดเร็คทอรี่ไม่สามารถเขียนได้

Return values
bool

Search results