Yii2 file/image upload behavior for ActiveRecord

FileUploadBehavior

This behavior allow you to add file and image uploading logic with ActiveRecord behavior.

Usage

Attach the behavior to your model class:

public function behaviors()
{
    return [
        'file-upload' => [
            'class' => '\yiidreamteam\upload\FileUploadBehavior',
            'attribute' => 'fileUpload',
            'filePath' => '[[web_root]]/uploads/[[pk]].[[extension]]',
            'fileUrl' => '/uploads/[[pk]].[[extension]]',
        ],
    ];
}

Possible path/url placeholders:

• [[app_root]] - application root
• [[web_root]] - web root
• [[model]] - model name
• [[pk]] - model Pk
• [[id]] - the same as [[pk]]
• [[attribute_name]] - model attribute (may be id or other model attribute), for example [[attribute_systemName]]
• [[id_path]] - id subdirectories structure
• [[parent_id]] - parent object primary key value
• [[basename]] - original filename with extension
• [[filename]] - original filename without extension
• [[extension]] - original extension
• [[base_url]] - site base url

Add validation rule:

public function rules()
{
    return [
        ['fileUpload', 'file'],   
    ];
}

Setup proper form enctype:

$form = \yii\bootstrap\ActiveForm::begin([
    'enableClientValidation' => false,
    'options' => [
        'enctype' => 'multipart/form-data',
    ],
]);

File should be uploading fine.

You can get uploaded file url using model call:

echo $model->getUploadedFileUrl('fileUpload');

ImageUploadBehavior

Image upload behavior extends file upload behavior with image thumbnails generation. You can configure set of different thumbnail profiles to generate.

Usage

Attach the behavior to your model class:

public function behaviors()
{
    return [
        'image-upload' => [
             'class' => '\yiidreamteam\upload\ImageUploadBehavior',
             'attribute' => 'imageUpload',
             'thumbs' => [
                 'thumb' => ['width' => 400, 'height' => 300],
             ],
             'filePath' => '[[web_root]]/images/[[pk]].[[extension]]',
             'fileUrl' => '/images/[[pk]].[[extension]]',
             'thumbPath' => '[[web_root]]/images/[[profile]]_[[pk]].[[extension]]',
             'thumbUrl' => '/images/[[profile]]_[[pk]].[[extension]]',
        ],
    ];
}

Possible path/url placeholders:

• [[app_root]] - application root
• [[web_root]] - web root
• [[model]] - model name
• [[pk]] - model Pk
• [[id]] - the same as [[pk]]
• [[attribute_name]] - model attribute (may be id or other model attribute), for example [[attribute_systemName]]
• [[id_path]] - id subdirectories structure
• [[basename]] - original filename with extension
• [[filename]] - original filename without extension
• [[extension]] - original extension
• [[base_url]] - site base url
• [[profile]] - thumbnail profile name

Add validation rule:

public function rules()
{
    return [
        ['imageUpload', 'file', 'extensions' => 'jpeg, gif, png'],   
    ];
}

Setup proper form enctype:

$form = \yii\bootstrap\ActiveForm::begin([
    'enableClientValidation' => false,
    'options' => [
        'enctype' => 'multipart/form-data',
    ],
]);

File should be uploading fine.

You can get uploaded image url using model call:

echo $model->getImageFileUrl('imageUpload');

or:

echo $model->getImageFileUrl('imageUpload', '/images/empty.jpg');

You can also get generated thumbnail image url:

echo $model->getThumbFileUrl('imageUpload', 'thumb');

or:

echo $model->getThumbFileUrl('imageUpload', 'thumb', '/images/thumb_empty.jpg');

Licence

MIT

Contacts

• https://github.com/yii-dream-team/yii2-upload-behavior
• https://packagist.org/packages/yii-dream-team/yii2-upload-behavior