bajadev/yii2-upload-behavior

Yii2 file/image upload behavior for ActiveRecord

Yii2 file/image upload behavior for ActiveRecord

This package is the set of two similar behaviors. The first one allows you to keep the uploaded file as-is. And the second one allows you to generate set of thumbnails for the uploaded image. Behaviors could be attached multiple times for different attributes., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

composer bajadev/yii2-upload-behavior "*"

or add, _(*4)

"bajadev/yii2-upload-behavior": "*"

to the require section of your composer.json., _(*5)

FileUploadBehavior

This behavior allow you to add file uploading logic with ActiveRecord behavior., _(*6)

Usage

Attach the behavior to your model class:, _(*7)

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

You can use Yii path aliases like @app, @webroot, @web in your path template configuration., _(*8)

You can also use additional placeholders in path templates. Placeholder [[foobar]] will be replaced with appropriate placeholder value., _(*9)

Possible path/url placeholders:, _(*10)

• [[model]] - model class name
• [[pk]] - value of the primary key
• [[id]] - the same as [[pk]]
• [[attribute_name]] - attribute value, for example [[attribute_ownerId]]
• [[slug_attribute_name]] - generate attribute value by Inflector, for example [[attribute_ownerId]]
• [[md5_attribute_name]] - generate md5 value, for example [[attribute_ownerId]]
• [[id_path]] - id subdirectories structure (if model primary key is 12345, placeholder value will be 1/2/3/4/5
• [[basename]] - original filename with extension
• [[filename]] - original filename without extension
• [[extension]] - original extension

Add validation rule:, _(*11)

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

Setup proper form enctype:, _(*12)

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

File should be uploading fine., _(*13)

You can get uploaded file url using model call:, _(*14)

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., _(*15)

Usage

Attach the behavior to your model class:, _(*16)

public function behaviors()
{
    return [
        [
             'class' => '\bajadev\upload\ImageUploadBehavior',
             'attribute' => 'imageUpload',
             'thumbs' => [
                 'thumb' => ['width' => 400, 'height' => 300, 'crop' => true, 'quality' => 80, 'inset' => true],
             ],
             'deleteOriginalFile' => true,
             'rotateImageByExif' => true,
             'filePath' => '@webroot/images/[[pk]].[[extension]]',
             'fileUrl' => '@web/images/[[pk]].[[extension]]',
             'thumbPath' => '@webroot/images/[[profile]]_[[pk]].[[extension]]',
             'thumbUrl' => '@web/images/[[profile]]_[[pk]].[[extension]]',
        ],
    ];
}

You can use Yii path aliases like @app, @webroot, @web in your path template configuration., _(*17)

You can also use additional placeholders in path templates. Placeholder [[foobar]] will be replaced with appropriate placeholder value., _(*18)

Possible path/url placeholders:, _(*19)

• [[model]] - model class name
• [[pk]] - value of the primary key
• [[id]] - the same as [[pk]]
• [[attribute_name]] - attribute value, for example [[attribute_ownerId]]
• [[slug_attribute_name]] - generate attribute value by Inflector, for example [[attribute_ownerId]]
• [[md5_attribute_name]] - generate md5 value, for example [[attribute_ownerId]]
• [[id_path]] - id subdirectories structure (if model primary key is 12345, placeholder value will be 1/2/3/4/5/
• [[basename]] - original filename with extension
• [[filename]] - original filename without extension
• [[extension]] - original extension
• [[profile]] - thumbnail profile name, use it in thumbnail path/url

Add validation rule:, _(*20)

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

Setup proper form enctype:, _(*21)

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

File should be uploading fine., _(*22)

You can get uploaded image url using model call:, _(*23)

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

You can specify default image for models without uploaded image:, _(*24)

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

You can also get generated thumbnail image url:, _(*25)

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

You can specify default thumbnail image for models without uploaded image:, _(*26)

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

Licence

MIT, _(*27)