4 关注者

上传文件

Yii 中的文件上传通常借助 yii\web\UploadedFile 来实现,它将每个上传的文件封装成一个 UploadedFile 对象。结合 yii\widgets\ActiveForm模型,您可以轻松实现安全的上传机制。

创建模型

就像处理纯文本输入一样,要上传单个文件,您需要创建一个模型类,并使用模型的一个属性来保存上传的文件实例。您还应该声明一个验证规则来验证文件上传。例如,

namespace app\models;

use yii\base\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 属性用于保存上传的文件实例。它与一个 file 验证规则相关联,该规则使用 yii\validators\FileValidator 来确保上传的文件扩展名为 pngjpgupload() 方法将执行验证并在服务器上保存上传的文件。

file 验证器允许您检查文件扩展名、大小、MIME 类型等。有关更多详细信息,请参阅 核心验证器 部分。

提示:如果您正在上传图像,可以考虑使用 image 验证器。image 验证器通过 yii\validators\ImageValidator 实现,它验证属性是否已收到有效的图像,然后可以使用 Imagine 扩展 保存或处理该图像。

渲染文件输入

接下来,在视图中创建一个文件输入

<?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 版本开始,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 yii\base\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;
        }
    }
}

在视图文件中,您应该在 fileInput() 调用中添加 multiple 选项,以便文件上传字段可以接收多个文件。您还需要将 imageFiles 更改为 imageFiles[],以便属性值作为数组提交。

<?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(),将一个 UploadedFile 实例数组分配给 UploadForm::imageFiles

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]);
    }
}

发现错别字或您认为此页面需要改进?
在 GitHub 上编辑它 !