How do you handle file and image uploads in Yii?

In Yii, handling file and image uploads involves a combination of model validation, form handling, and controller logic. Below is a step-by-step guide to handle file and image uploads in Yii:

1. Create a Model

First, create a model class that includes a property for the file or image to be uploaded. Use Yii’s yii\web\UploadedFile to handle the uploaded file.

Example

<?php
use yii\web\UploadedFile;

class UploadForm extends \yii\base\Model
{
    public $imageFile;

    public function rules()
    {
        return [
            [['imageFile'], 'file', 'skipOnEmpty' => false, 'extensions' => 'png, jpg'],
        ];
    }
}
?>

Here, we define an imageFile property and add validation rules to ensure the file is not empty and only accepts png and jpg file types.

2. Create a Form in the View

Next, create a form in your view that allows users to select a file to upload.

Example

<?php
<?php
use yii\widgets\ActiveForm;
use yii\helpers\Html;

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

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

<?= Html::submitButton('Submit', ['class' => 'btn btn-primary']) ?>

<?php ActiveForm::end(); ?>
?>

The enctype="multipart/form-data" is necessary for file uploads.

3. Handle File Upload in the Controller

In your controller, handle the uploaded file in the action that processes the form.

Example

<?php
namespace app\controllers;

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

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

        if (Yii::$app->request->isPost) {
            // Get the instance of the uploaded file
            $model->imageFile = UploadedFile::getInstance($model, 'imageFile');
            
            // Validate and save the file
            if ($model->validate()) {
                $path = 'uploads/' . $model->imageFile->baseName . '.' . $model->imageFile->extension;
                if ($model->imageFile->saveAs($path)) {
                    // File is uploaded successfully
                    Yii::$app->session->setFlash('success', 'File uploaded successfully.');
                } else {
                    Yii::$app->session->setFlash('error', 'File upload failed.');
                }
                return $this->refresh();
            }
        }

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

Explanation:

UploadedFile::getInstance($model, ‘imageFile’) retrieves the uploaded file.
$model->validate() validates the file based on the rules in the model.
saveAs() saves the file to a specified path (you may want to customize the directory).

4. Folder for Uploads

Make sure the uploads/ folder exists and has write permissions:

Example

mkdir uploads
chmod 777 uploads

5. Display Uploaded Images (Optional)

To display uploaded images, you can store the file paths in a database and then use the <img> tag in your views:

Example

<?php
<img src="<?= Yii::getAlias('@web') . '/uploads/' . $filename ?>" alt="Uploaded Image">
?>

This is the basic approach to handling file and image uploads in Yii. You can further customize this by handling multiple files, storing file paths in a database, or adding more validation rules.

How do you handle file and image uploads in Yii?

1. Create a Model

Example

2. Create a Form in the View

Example

3. Handle File Upload in the Controller

Example

Explanation:

4. Folder for Uploads

Example

5. Display Uploaded Images (Optional)

Example

Related Questions & Topics