怎麼做

上傳檔案

上傳 Yii 中的檔案通常是在[[yii \ web \ UploadedFile]]的幫助下完成的,它將每個上傳的檔案封裝為 UploadedFile 物件。結合[[yii \ widgets \ ActiveForm]]和模型,你可以輕鬆實現安全的檔案上傳機制。

建立模型

與使用純文字輸入一樣,要上傳單個檔案,你將建立模型類並使用模型的屬性來保留上載的檔案例項。你還應宣告驗證規則以驗證檔案上載。例如,

namespace app\models;

use yiiase\Model;
use yii\web\UploadedFile;

class UploadForm extends Model
{
    /**
     * @var UploadedFile
     */
    public $imageFile;

    public function rules()
    {
        return [
            [['imageFile'], 'file', 'skipOnEmpty' => false, 'extensions' => 'png, jpg'],
        ];
    }
    
    public function upload()
    {
        if ($this->validate()) {
            $this->imageFile->saveAs('uploads/' . $this->imageFile->baseName . '.' . $this->imageFile->extension);
            return true;
        } else {
            return false;
        }
    }
}

在上面的程式碼中,imageFile 屬性用於儲存上傳的檔案例項。它與使用[[yii \ validators \ FileValidator]]的 file 驗證規則相關聯,以確保上傳副檔名為 pngjpg 的檔案。upload() 方法將執行驗證並將上載的檔案儲存在伺服器上。

file 驗證器允許你檢查副檔名,大小,MIME 型別等。有關更多詳細資訊,請參閱核心驗證器部分。

提示:如果要上傳影象,可以考慮使用 image 驗證器。image 驗證器通過[[yii \ validators \ ImageValidator]]實現,驗證屬性是否已收到有效影象,然後可以使用 Imagine Extension 儲存或處理該影象。

渲染檔案輸入

接下來,在檢視中建立檔案輸入:

<?php
use yii\widgets\ActiveForm;
?>

<?php $form = ActiveForm::begin(['options' => ['enctype' => 'multipart/form-data']]) ?>

    <?= $form->field($model, 'imageFile')->fileInput() ?>

    <button>Submit</button>

<?php ActiveForm::end() ?>

請務必記住,你將 enctype 選項新增到表單中,以便可以正確上載檔案。fileInput() 呼叫將呈現 <input type="file"> 標記,允許使用者選擇要上傳的檔案。

提示:自版本 2.0.8 起,[[yii \ web \ widgets \ ActiveField::fileInput | fileInput]]在使用檔案輸入欄位時自動將 enctype 選項新增到表單。

接線

現在在控制器操作中,編寫程式碼以連線模型和檢視以實現檔案上載:

namespace app\controllers;

use Yii;
use yii\web\Controller;
use app\models\UploadForm;
use yii\web\UploadedFile;

class SiteController extends Controller
{
    public function actionUpload()
    {
        $model = new UploadForm();

        if (Yii::$app->request->isPost) {
            $model->imageFile = UploadedFile::getInstance($model, 'imageFile');
            if ($model->upload()) {
                // file is uploaded successfully
                return;
            }
        }

        return $this->render('upload', ['model' => $model]);
    }
}

在上面的程式碼中,提交表單時,呼叫[[yii \ web \ UploadedFile :: getInstance()]]方法將上傳的檔案表示為 UploadedFile 例項。然後,我們依靠模型驗證來確保上載的檔案有效並將檔案儲存在伺服器上。

上傳多個檔案

你還可以一次上傳多個檔案,並對前面小節中列出的程式碼進行一些調整。

首先,你應該通過在 file 驗證規則中新增 maxFiles 選項來調整模型類,以限制允許上載的最大檔案數。將 maxFiles 設定為 0 意味著可以同時上載的檔案數量沒有限制。允許同時上傳的最大檔案數也受限於 PHP 指令 max_file_uploads ,預設為 20.還應更新 upload() 方法以逐個儲存上傳的檔案。

namespace app\models;

use yiiase\Model;
use yii\web\UploadedFile;

class UploadForm extends Model
{
    /**
     * @var UploadedFile[]
     */
    public $imageFiles;

    public function rules()
    {
        return [
            [['imageFiles'], 'file', 'skipOnEmpty' => false, 'extensions' => 'png, jpg', 'maxFiles' => 4],
        ];
    }
    
    public function upload()
    {
        if ($this->validate()) { 
            foreach ($this->imageFiles as $file) {
                $file->saveAs('uploads/' . $file->baseName . '.' . $file->extension);
            }
            return true;
        } else {
            return false;
        }
    }
}

在檢視檔案中,你應該將 multiple 選項新增到 fileInput() 呼叫,以便檔案上載欄位可以接收多個檔案:

<?php
use yii\widgets\ActiveForm;
?>

<?php $form = ActiveForm::begin(['options' => ['enctype' => 'multipart/form-data']]) ?>

    <?= $form->field($model, 'imageFiles[]')->fileInput(['multiple' => true, 'accept' => 'image/*']) ?>

    <button>Submit</button>

<?php ActiveForm::end() ?>

最後在控制器動作中,你應該呼叫 UploadedFile::getInstances() 而不是 UploadedFile::getInstance() 來為 UploadForm::imageFiles 分配一個 UploadedFile 例項陣列。

namespace app\controllers;

use Yii;
use yii\web\Controller;
use app\models\UploadForm;
use yii\web\UploadedFile;

class SiteController extends Controller
{
    public function actionUpload()
    {
        $model = new UploadForm();

        if (Yii::$app->request->isPost) {
            $model->imageFiles = UploadedFile::getInstances($model, 'imageFiles');
            if ($model->upload()) {
                // file is uploaded successfully
                return;
            }
        }

        return $this->render('upload', ['model' => $model]);
    }
}