PHP 文件上傳操作類

目錄

• 前言
• 代碼
• 使用方法
• 錯誤碼說明

前言

今天在公司無事，就搞了下文件上傳的東東，方便自己的學習，和今後的使用，目前只支持單文件上傳。下麵是代碼部分，也可以訪問我的 Gitee 或 Github，不想看代碼的童鞋可以直接[下載]。。。（算了，討厭百度雲，如果有需要的話留言）代碼使用，使用方法請點擊

代碼

<?php

namespace E;

class FileUpload
{
    /**
     * @var $name 上傳文件標記名
     */
    protected $name = 'file';

    /**
     * @var $ext 所允許的擴展名
     */
    protected $exts  = [];

    /**
     * @var $file 上傳的文件資源
     */
    protected $file = null;

    /**
     * @var $upload_success 是否上傳成功標誌
     */
    protected $upload_success = false;

    /**
     * @var $max_size 上傳文件所允許的大小，單位為 M
     */
    protected $max_size = 2;

    /**
     * @var $error_code 錯誤碼
     */
    protected $error_code = 0;

    /**
     * @var $error_msg 錯誤信息
     */
    protected $error_msg = '';

    /**
     * @var $file_ext 文件擴展名
     */
    protected $file_ext = '';

    /**
     * @var $type 文件類型，預設為任意類型
     */
    protected $type = 'file';

    protected const ERR_OK         = 0;
    protected const ERR_FILE_SIZE  = 1;
    protected const ERR_FORM_SIZE  = 2;
    protected const ERR_PARTIAL    = 3;
    protected const ERR_NO_FILE    = 4;
    protected const ERR_FILE_EXIST = 5;
    protected const ERR_NO_TMP_DIR = 6;
    protected const ERR_CANT_WRITE = 7;
    protected const ERR_FILE_TYPE  = 8;

    /**
     * 配置上傳信息
     *
     * @param array $arr
     * @return E\FileUpload
     */
    public function config($arr)
    {
        foreach ($arr as $key => $val) {
            if (property_exists($this, $key)) {
                $this->$key = $val;
            }
        }
        return $this;
    }

    /**
     * 進行文件上傳操作
     *
     * @return E\FileUpload
     */
    public function upload()
    {
        $this->file     = $this->getFile();
        $this->file_ext = strrchr($this->file['name'], '.');

        $this->upload_success = !($this->uploadError() || $this->overMaxSize() || $this->notAllowType());

        return $this;
    }

    /**
     * 判斷文件是否上傳成功
     * 
     * @return boolean
     */
    public function uploadSuccess()
    {
        return $this->upload_success;
    }

    /**
     * 保存已上傳的文件
     *
     * @param string $path
     * @param string $file_name
     *
     * @return boolean
     */
    public function save($path, $file_name = '')
    {
        if (!$this->uploadSuccess()) {
            return false;
        }

        // 判斷文件夾是否存在，如果不存在，新建一個文件夾
        if (!is_dir($path)) {
            mkdir($path);
        }

        // 獲取文件名，不包含尾碼
        $file_name = $file_name ?: 'e_' . time() . mt_rand(10000, 99999);

        $file = rtrim($path, '/') . '/' . $file_name . $this->file_ext;

        // 判斷文件是否存在
        if (file_exists($file)) {
            $this->error_code = self::ERR_FILE_EXIST;
            return false;
        }

        if (move_uploaded_file($this->file['tmp_name'], $file)) {
            return true;
        }

        // 文件未上傳成功，出現未知錯誤
        $this->error_code = -1;
        return false;
    }

    /**
     * 返回錯誤碼
     * 
     * @return integer
     */
    public function errorCode()
    {
        return $this->error_code;
    }

    /**
     * 返回錯誤信息
     *
     * @return string
     */
    public function errorMsg()
    {
        !$this->error_msg && $this->setErrorMsgByCode($this->error_code);

        return $this->error_msg;
    }

    /**
     * 獲取上傳文件
     * 
     * @return mixed
     */
    protected function getFile()
    {
        return $_FILES[$this->name];
    }

    /**
     * 判斷是否上傳錯誤
     * 
     * @return boolean
     */
    protected function uploadError()
    {
        $this->error_code = $this->file['error'];

        return (bool)$this->file['error'];
    }

    /**
     * 根據錯誤代碼設置錯誤信息
     *
     * @param  int $code
     */
    protected function setErrorMsgByCode($code)
    {
        $msg_arr = [
            '',
            '上傳文件最大為 ' . $this->getMaxSize() . 'M',
            '上傳文件過大',
            '文件只有部分被上傳',
            '沒有文件被上傳',
            '文件已存在',
            '文件丟失',
            '文件寫入失敗',
            '只能上傳' . implode(',', $this->exts) . '類型的文件'
        ];

        $this->error_msg = $msg_arr[$code] ?? '未知錯誤';
    }

    /**
     * 獲取上傳文件所限制的最大大小
     * 
     * @return int
     */
    protected function getMaxSize()
    {
        return min($this->max_size, (int)ini_get('upload_max_filesize'));
    }

    /**
     * 判斷文件是否超出限制大小
     *
     * @return boolean
     */
    protected function overMaxSize()
    {
        if ($this->file['size'] > $this->getMaxSize() * 1024 * 1024 * 8) {
            $this->error_code = self::ERR_FILE_SIZE;
            return true;
        }
        return false;
    }

    /**
     * 通過類型獲取尾碼名數組
     *
     * @return array
     */
    protected function getExtsByType()
    {
        $exts_arr = [
            'image' => ['jpg', 'jpeg', 'png', 'gif'],
            'file'  => [],
            'zip'   => ['zip', 'rar', '7z']
        ];

        return $exts_arr[$this->type] ?? [];
    }

    /**
     * 判斷是否是允許的類型
     * 
     * @return boolean
     */
    protected function notAllowType()
    {
        $this->exts = $this->exts ?: $this->getExtsByType();

        if (!$this->exts) return false;

        if (preg_match('/^\.' . implode('|', $this->exts) . '$/i', $this->file_ext)) {
            return false;
        }

        $this->error_code = self::ERR_FILE_TYPE;
        return true;
    }
}

使用方法

1. 引入文件

include 'FileUpload.class.php';

2. 實例化類

$uploader = new E\FileUpload();

3. 配置

$uploader->config([
    'name'      => 'file',
    'exts'      => ['jpg'],
    'type'      => 'image',
    'max_size'  => 2,
]);

配置項的說明：

4. 上傳

$uploader->upload();

5. 保存

$uploader->save('./uploads/', 'test')

save 方法的返回值是一個布爾值，上傳成功返回 true，失敗返回 false，可以根據返回的狀態進行相應的操作，如果失敗，可以使用 errorCode() 方法獲取錯誤代碼，使用 errorMsg() 方法獲取錯誤信息。

save 方法的第一個參數為必填參數，是要保存的路徑，第二個參數是文件名，可選，如果不填，則會自動生成，生成規則： e_ 連接上當前時間的時間戳再連接5位隨機數

也可以使用鏈式操作：

$uploader->upload()->save('./uploads/', 'test');

錯誤碼說明