經典的php多功能文件上傳類別實例詳解

檔案上傳是專案開發中比較常見的功能，但檔案上傳的過程比較繁瑣，只要是有檔案上傳的地方就需要寫這些複雜的程式碼。為了能在每次開發中降低功能的編寫難度，也為了能節省開發時間，通常我們會將這些重複使用的一段程式碼封裝到一個類別中。幫助開發者在以後的開發中，透過編寫幾個簡單程式碼就可以實現複雜的文件上傳功能。對於基礎薄弱的讀者，只要會使用本類即可，而對一些喜歡挑戰的朋友，可以嘗試去讀懂它，並能開發一個屬於自己的文件上傳類別。

一、需求分析

　　要球自訂檔案上傳類，即在使用非常簡便的前提下，又可以完成以下幾項功能：
　　①支援單一檔案上傳。
　　②支援多個檔案上傳。
　　③可以自行指定上傳檔案的儲存位置，可以設定上傳檔案允許的大小和類型，可以由系統對上傳檔案重新命名，又可以設定保留上傳檔案的原名。
　　（說明：要求單一文件上傳和多個文件上傳要採用相同的操作方式，對上傳進行的一些設定也要採用相同的方式）。

二、程式設計

　　根據程式需求的要求，我們可以為檔案上傳類別宣告4個可見的成員屬性，讓使用者在使用時還可以進行一些行為的設定。所需的成員屬性如下表所示：

　　為避免屬性的值被賦上一些非法值，需要將這些成員屬性封裝起來，在物件外面不能訪問，再透過類別中宣告的set()方法為以上四個成員屬性賦值。 set()方法有兩個參數，第一個參數就是成員屬性名稱（不區分大小寫），第二個參數，就是前面參數中屬性對應的值。 set()方法呼叫完成以後，傳回本物件($this)，所以除了可以單獨為每個屬性賦值以外，還可以進行連貫運算一起為多個屬性賦值。本例除了set()方法以外，最主要的是實作上傳檔案的功能，所以系統主要提供了下列一些公有方法，實作檔案上傳的操作，如下表所示：

#　為避免屬性的值被賦上一些非法值，需要將這些成員屬性封裝起來，在物件外面不能訪問，再透過類別中宣告的set()方法為以上四個成員屬性賦值。 set()方法有兩個參數，第一個參數就是成員屬性名稱（不區分大小寫），第二個參數，就是前面參數中屬性對應的值。 set()方法呼叫完成以後，傳回本物件($this)，所以除了可以單獨為每個屬性賦值以外，還可以進行連貫運算一起為多個屬性賦值。本例除了set()方法以外，最主要的是實作上傳檔案的功能，所以系統主要提供了下列一些公有方法，實作檔案上傳的操作，如下表所示：

<?php
  /** 
    file: fileupload.class.php 文件上传类FileUpload
    本类的实例对象用于处理上传文件，可以上传一个文件，也可同时处理多个文件上传
  */
  class FileUpload { 
    private $path = "./uploads";          //上传文件保存的路径
    private $allowtype = array(&#39;jpg&#39;,&#39;gif&#39;,&#39;png&#39;); //设置限制上传文件的类型
    private $maxsize = 1000000;           //限制文件上传大小（字节）
    private $israndname = true;           //设置是否随机重命名文件， false不随机
 
    private $originName;              //源文件名
    private $tmpFileName;              //临时文件名
    private $fileType;               //文件类型(文件后缀)
    private $fileSize;               //文件大小
    private $newFileName;              //新文件名
    private $errorNum = 0;             //错误号
    private $errorMess="";             //错误报告消息
 
    /**
     * 用于设置成员属性（$path, $allowtype,$maxsize, $israndname）
     * 可以通过连贯操作一次设置多个属性值
     *@param  string $key  成员属性名(不区分大小写)
     *@param  mixed  $val  为成员属性设置的值
     *@return  object     返回自己对象$this，可以用于连贯操作
     */
    function set($key, $val){
      $key = strtolower($key); 
      if( array_key_exists( $key, get_class_vars(get_class($this) ) ) ){
        $this->setOption($key, $val);
      }
      return $this;
    }
 
    /**
     * 调用该方法上传文件
     * @param  string $fileFile  上传文件的表单名称 
     * @return bool        如果上传成功返回数true 
     */
 
    function upload($fileField) {
      $return = true;
      /* 检查文件路径是滞合法 */
      if( !$this->checkFilePath() ) {       
        $this->errorMess = $this->getError();
        return false;
      }
      /* 将文件上传的信息取出赋给变量 */
      $name = $_FILES[$fileField][&#39;name&#39;];
      $tmp_name = $_FILES[$fileField][&#39;tmp_name&#39;];
      $size = $_FILES[$fileField][&#39;size&#39;];
      $error = $_FILES[$fileField][&#39;error&#39;];
 
      /* 如果是多个文件上传则$file["name"]会是一个数组 */
      if(is_Array($name)){    
        $errors=array();
        /*多个文件上传则循环处理 ， 这个循环只有检查上传文件的作用，并没有真正上传 */
        for($i = 0; $i < count($name); $i++){ 
          /*设置文件信息 */
          if($this->setFiles($name[$i],$tmp_name[$i],$size[$i],$error[$i] )) {
            if(!$this->checkFileSize() || !$this->checkFileType()){
              $errors[] = $this->getError();
              $return=false; 
            }
          }else{
            $errors[] = $this->getError();
            $return=false;
          }
          /* 如果有问题，则重新初使化属性 */
          if(!$return)          
            $this->setFiles();
        }
 
        if($return){
          /* 存放所有上传后文件名的变量数组 */
          $fileNames = array();      
          /* 如果上传的多个文件都是合法的，则通过销魂循环向服务器上传文件 */
          for($i = 0; $i < count($name); $i++){ 
            if($this->setFiles($name[$i], $tmp_name[$i], $size[$i], $error[$i] )) {
              $this->setNewFileName(); 
              if(!$this->copyFile()){
                $errors[] = $this->getError();
                $return = false;
              }
              $fileNames[] = $this->newFileName;  
            }          
          }
          $this->newFileName = $fileNames;
        }
        $this->errorMess = $errors;
        return $return;
      /*上传单个文件处理方法*/
      } else {
        /* 设置文件信息 */
        if($this->setFiles($name,$tmp_name,$size,$error)) {
          /* 上传之前先检查一下大小和类型 */
          if($this->checkFileSize() && $this->checkFileType()){ 
            /* 为上传文件设置新文件名 */
            $this->setNewFileName(); 
            /* 上传文件  返回0为成功， 小于0都为错误 */
            if($this->copyFile()){ 
              return true;
            }else{
              $return=false;
            }
          }else{
            $return=false;
          }
        } else {
          $return=false; 
        }
        //如果$return为false, 则出错，将错误信息保存在属性errorMess中
        if(!$return)
          $this->errorMess=$this->getError();  
 
        return $return;
      }
    }
 
    /** 
     * 获取上传后的文件名称
     * @param  void   没有参数
     * @return string 上传后，新文件的名称， 如果是多文件上传返回数组
     */
    public function getFileName(){
      return $this->newFileName;
    }
 
    /**
     * 上传失败后，调用该方法则返回，上传出错信息
     * @param  void   没有参数
     * @return string  返回上传文件出错的信息报告，如果是多文件上传返回数组
     */
    public function getErrorMsg(){
      return $this->errorMess;
    }
 
    /* 设置上传出错信息 */
    private function getError() {
      $str = "上传文件<font color=&#39;red&#39;>{$this->originName}</font>时出错 : ";
      switch ($this->errorNum) {
        case 4: $str .= "没有文件被上传"; break;
        case 3: $str .= "文件只有部分被上传"; break;
        case 2: $str .= "上传文件的大小超过了HTML表单中MAX_FILE_SIZE选项指定的值"; break;
        case 1: $str .= "上传的文件超过了php.ini中upload_max_filesize选项限制的值"; break;
        case -1: $str .= "未允许类型"; break;
        case -2: $str .= "文件过大,上传的文件不能超过{$this->maxsize}个字节"; break;
        case -3: $str .= "上传失败"; break;
        case -4: $str .= "建立存放上传文件目录失败，请重新指定上传目录"; break;
        case -5: $str .= "必须指定上传文件的路径"; break;
        default: $str .= "未知错误";
      }
      return $str.&#39;<br>&#39;;
    }
 
    /* 设置和$_FILES有关的内容 */
    private function setFiles($name="", $tmp_name="", $size=0, $error=0) {
      $this->setOption(&#39;errorNum&#39;, $error);
      if($error)
        return false;
      $this->setOption(&#39;originName&#39;, $name);
      $this->setOption(&#39;tmpFileName&#39;,$tmp_name);
      $aryStr = explode(".", $name);
      $this->setOption(&#39;fileType&#39;, strtolower($aryStr[count($aryStr)-1]));
      $this->setOption(&#39;fileSize&#39;, $size);
      return true;
    }
 
    /* 为单个成员属性设置值 */
    private function setOption($key, $val) {
      $this->$key = $val;
    }
 
    /* 设置上传后的文件名称 */
    private function setNewFileName() {
      if ($this->israndname) {
        $this->setOption(&#39;newFileName&#39;, $this->proRandName());  
      } else{ 
        $this->setOption(&#39;newFileName&#39;, $this->originName);
      } 
    }
 
    /* 检查上传的文件是否是合法的类型 */
    private function checkFileType() {
      if (in_array(strtolower($this->fileType), $this->allowtype)) {
        return true;
      }else {
        $this->setOption(&#39;errorNum&#39;, -1);
        return false;
      }
    }
 
    /* 检查上传的文件是否是允许的大小 */
    private function checkFileSize() {
      if ($this->fileSize > $this->maxsize) {
        $this->setOption(&#39;errorNum&#39;, -2);
        return false;
      }else{
        return true;
      }
    }
 
    /* 检查是否有存放上传文件的目录 */
    private function checkFilePath() {
      if(empty($this->path)){
        $this->setOption(&#39;errorNum&#39;, -5);
        return false;
      }
      if (!file_exists($this->path) || !is_writable($this->path)) {
        if (!@mkdir($this->path, 0755)) {
          $this->setOption(&#39;errorNum&#39;, -4);
          return false;
        }
      }
      return true;
    }
 
    /* 设置随机文件名 */
    private function proRandName() {    
      $fileName = date(&#39;YmdHis&#39;)."_".rand(100,999);    
      return $fileName.&#39;.&#39;.$this->fileType; 
    }
 
    /* 复制上传文件到指定的位置 */
    private function copyFile() {
      if(!$this->errorNum) {
        $path = rtrim($this->path, &#39;/&#39;).&#39;/&#39;;
        $path .= $this->newFileName;
        if (@move_uploaded_file($this->tmpFileName, $path)) {
          return true;
        }else{
          $this->setOption(&#39;errorNum&#39;, -3);
          return false;
        }
      } else {
        return false;
      }
    }
  }

四、檔案上傳類別的應用程式

　　本例的檔案上傳類別FileUpload，即支援單一檔案上傳，也支援多個檔案一起向伺服器上傳，在處理方式上沒有差別的，只不過在寫上標籤單時，多個檔案上傳一定要以陣列方式傳遞給伺服器。單一檔案上傳表單如下所示：

<form action="upload.php" method="post" enctype="multipart/form-data" >
    name: <input type="text" name="username" value="" /><br>
    <input type="hidden" name="MAX_FILE_SIZE" value="1000000" />
    up pic: <input type="file" name="pic[]" value=""><br>
    up pic: <input type="file" name="pic[]" value=""><br>
    up pic: <input type="file" name="pic[]" value=""><br>
    up pic: <input type="file" name="pic[]" value=""><br>
 
    <input type="submit" value="upload" /><br>
 
</form>

　　上面表單，都將提交的位置指向了同一個檔案upload.php，所以不難看出單一和多個檔案上傳是一樣的處理方式，upload. php程式碼如下所示：

<?php
    //包含一个文件上传类中的上传类
    include "fileupload.class.php";
 
    $up = new fileupload;
    //设置属性(上传的位置， 大小， 类型， 名是是否要随机生成)
    $up -> set("path", "./images/");
    $up -> set("maxsize", 2000000);
    $up -> set("allowtype", array("gif", "png", "jpg","jpeg"));
    $up -> set("israndname", false);
 
    //使用对象中的upload方法， 就可以上传文件， 方法需要传一个上传表单的名子 pic, 如果成功返回true, 失败返回false
    if($up -> upload("pic")) {
        echo &#39;<pre class="brush:php;toolbar:false">&#39;;
        //获取上传后文件名子
        var_dump($up->getFileName());
        echo &#39;

'; } else { echo '

';
        //获取上传失败以后的错误提示
        var_dump($up->getErrorMsg());
        echo '

'; } ?>

　　在upload.php檔案中，首先必須載入檔案上傳FileUpload類別所在的檔案fileupload.class.php。再來就是實例化文件上傳類別的對象，然後透過呼叫upload()方法上傳文件，如果上傳成功，可以透過getFileName()方法取得上傳後的檔案名稱，如果上傳失敗，還可以透過getErrorMsg()方法取得錯誤報告。如果需要改變上傳的一些行為，可以透過呼叫set()方法來完成一些屬性的設定。 set()方法可以單獨使用設定一個屬性的值，如果需要改變多個屬性的值，可以連續呼叫set()方法進行設置，也可以連貫操作同時設定多個屬性。

以上是經典的php多功能文件上傳類別實例詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！