ファイルのアップロード ¶

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属性を使用してアップロードされたファイルインスタンスを保持しています。これは、yii\validators\FileValidator を使用して、拡張子がpngまたはjpgのファイルがアップロードされることを確認するfile検証ルールに関連付けられています。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以降、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()メソッドも、アップロードされたファイルを1つずつ保存するように更新する必要があります。

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::getInstance()の代わりにUploadedFile::getInstances()を呼び出して、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]);
    }
}