yii2/docs/guide-ja/input-file-upload.md

ファイルをアップロードする

Yii におけるファイルのアップロードは、通常、アップロードされる個々のファイルを UploadedFile としてカプセル化する yii\web\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 を使って、png または jpg の拡張子を持つファイルがアップロードされることを保証しています。 upload() メソッドは検証を実行して、アップロードされたファイルをサーバに保存します。

file バリデータによって、ファイル拡張子、サイズ、MIME タイプなどをチェックすることが出来ます。 詳細については、コアバリデータ の節を参照してください。

Tip: 画像をアップロードしようとする場合は、image バリデータを代りに使うことを考慮しても構いません。 image バリデータは yii\validators\ImageValidator によって実装されており、属性が有効な画像、すなわち、保存したり Imagine エクステンション を使って処理したりすることが可能な有効な画像を、受け取ったかどうかを検証します。

上記のコードにおいて作成した UploadForm というモデルは、HTML フォームで <input type="file"> となる $file という属性を持ちます。 この属性は yii\validators\FileValidator を使用する file という検証規則を持ちます。

ファイルインプットをレンダリングする

次に、ビューでファイルインプットを作成します。

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

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

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

    <button>送信</button>

<?php ActiveForm::end() ?>

ファイルが正しくアップロードされるように、フォームに enctype オプションを追加することを憶えておくのは重要なことです。 fileInput() を呼ぶと <input type="file"> のタグがレンダリングされて、ユーザがアップロードするファイルを選ぶことが出来るようになります。

Tip: バージョン 2.0.8 以降では、ファイルインプットのフィールドが使われているときは、yii\web\widgets\ActiveField::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()) {
                // ファイルのアップロードが成功
                return;
            }
        }

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

<<<<<<< HEAD model->load(...) の代りに UploadedFile::getInstance(...) を使っています。 \yii\web\UploadedFile はモデルの検証を実行せず、アップロードされたファイルに関する情報を提供するだけです。 そのため、$model->validate() を手作業で実行して、yii\validators\FileValidator を起動する必要があります。 yii\validators\FileValidator は、下記のコアコードが示しているように、属性がファイルであることを要求します。

if (!$file instanceof UploadedFile || $file->error == UPLOAD_ERR_NO_FILE) {
    return [$this->uploadRequired, []];  // "ファイルをアップロードしてください。" というエラーメッセージ
}

検証が成功したら、ファイルを保存します。

$model->file->saveAs('uploads/' . $model->file->baseName . '.' . $model->file->extension);

<<<<<<< HEAD 「ベーシック」アプリケーションテンプレートを使っている場合は、uploads フォルダを web の下に作成しなければなりません。

「ベーシック」プロジェクトテンプレートを使っている場合は、uploads フォルダを web の下に作成しなければなりません。

yiichina/master

以上です。ページをロードして、アップロードを試して見てください。ファイルは basic/web/uploads にアップロードされます。

検証

たいていの場合、検証規則を調整して、特定のファイルだけを受け取るようにしたり、アップロードを必須としたりする必要があります。 下記で、よく使われる規則の構成を見てみましよう。

Required

ファイルのアップロードを必須とする必要がある場合は、次のように skipOnEmpty を false に設定します。

public function rules()
{
    return [
        [['file'], 'file', 'skipOnEmpty' => false],
    ];
}

MIME タイプ

======= 上記のコードでは、フォームが送信されると yii\web\UploadedFile::getInstance() メソッドが呼ばれて、アップロードされたファイルが UploadedFile のインスタンスとして表現されます。 そして、次に、モデルの検証によってアップロードされたファイルが有効なものであることを確かめ、サーバにファイルを保存します。

master

複数のファイルをアップロードする

ここまでの項で示したコードに若干の修正を加えれば、複数のファイルを一度にアップロードすることも出来ます。

最初に、モデルクラスを修正して、file 検証規則に maxFiles オプションを追加して、アップロードを許可されるファイルの最大数を制限しなければなりません。 maxFiles を 0 に設定することは、同時にアップロード出来るファイル数に制限がないことを意味します。 同時にアップロードすることを許されるファイルの数は、また、PHP のディレクティブ max_file_uploads (デフォルト値は 20) によっても制限されます。 upload() メソッドも、アップロードされた複数のファイルを一つずつ保存するように修正しなければなりません。

<<<<<<< HEAD
public function rules()
{
    return [
        [['file'], 'file', 'checkExtensionByMimeType' => false, 'extensions' => 'csv', 'mimeTypes' => 'text/plain'],
    ];
}

一般的なメディアタイプの一覧表

画像のプロパティ

画像をアップロードするときは、yii\validators\ImageValidator が重宝するでしょう。 このバリデータは、属性が有効な画像を受け取ったか否かを検証します。 <<<<<<< HEAD 画像は、保存するか、または、Imagine エクステンション によって処理することが出来ます。

画像は、保存するか、または、Imagine エクステンション によって処理することが出来ます。

yiichina/master

複数のファイルをアップロードする

======= namespace app\models;

master

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` オプションを追加して、ファイルアップロードのフィールドが複数のファイルを受け取ることが出来るようにしなければなりません。

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

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

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

    <button>送信</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()) {
                // ファイルのアップロードが成功
                return;
            }
        }

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