valiant/yii2-upload-behavior

This package is abandoned and no longer maintained. No replacement package was suggested.

Yii2 file/image upload behavior for ActiveRecord

1.1.3 2016-12-01 08:00 UTC

Requires

• php: >=5.4.0
• masterexploder/phpthumb: *
• yiisoft/yii2: *

MIT

• Igor Prokofev

• image
• file
• upload
• thumbnail
• Behavior
• resize

README

This is fork for yii-dream-team/yii2-upload-behavior from Yii Dream Team (http://yiidreamteam.com)

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.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist valiant/yii2-upload-behavior "*"

or add

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

to the require section of your composer.json.

FileUploadBehavior

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

Usage

Attach the behavior to your model class:

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

You can use Yii path aliases like @app, @webroot, @web in your path template configuration.

You can also use additional placeholders in path templates. Placeholder [[foobar]] will be replaced with appropriate placeholder value.

Possible path/url placeholders:

• [[model]] - model class name
• [[pk]] - value of the primary key
• [[id]] - the same as [[pk]]
• [[extension]] - original extension
• [[attribute]] - attribute name
• [[id_path]] - id subdirectories structure (if model primary key is 12345, placeholder value will be 1/2/3/4/5/0/0/0/0/0)
• [[id_hash]] - id subdirectories structure by md5 hash (if model primary key is 12345, md5 hash is 827ccb0eea8a706c4c34a16891f84e7b placeholder value will be 8/27/ccb0eea8a706c4c34a16891f84e7b)
• [[id_hash_piece]] - id hash dex piece, will be in range 0-255 (if model primary key is 12345, md5 hash is 827ccb0eea8a706c4c34a16891f84e7b, first 2 hex numbers is 82, convert hexDex and placeholder value will be 130)
• [[attribute_name]] - attribute value, for example [[attribute_ownerId]]

Add validation rule:

public function rules()
{
    return [
        ['attachment', '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('attachment');

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 [
        [
             'class' => '\valiant\behaviors\ImageUploadBehavior',
             'attribute' => 'image',
             'thumbs' => [
                 'thumb' => ['width' => 400, 'height' => 300],
                 'albumThumb' => ['width' => 200],
                 'albumLogo' => ['height' => 500],
             ],
             'filePath' => '@webroot/images/[[pk]].[[extension]]',
             'fileUrl' => '/images/[[pk]].[[extension]]',
             'thumbPath' => '@webroot/images/[[profile]]_[[pk]].[[extension]]',
             'thumbUrl' => '/images/[[profile]]_[[pk]].[[extension]]',
        ],
    ];
}

You can use Yii path aliases like @app, @webroot, @web in your path template configuration.

You can also use additional placeholders in path templates. Placeholder [[foobar]] will be replaced with appropriate placeholder value.

Possible path/url placeholders:

• [[model]] - model class name
• [[pk]] - value of the primary key
• [[id]] - the same as [[pk]]
• [[extension]] - original extension
• [[attribute]] - attribute name
• [[id_path]] - id subdirectories structure (if model primary key is 12345, placeholder value will be 1/2/3/4/5/0/0/0/0/0)
• [[id_hash]] - id subdirectories structure by md5 hash (if model primary key is 12345, md5 hash is 827ccb0eea8a706c4c34a16891f84e7b placeholder value will be 8/27/ccb0eea8a706c4c34a16891f84e7b)
• [[id_hash_piece]] - id hash dex piece, will be in range 0-255 (if model primary key is 12345, md5 hash is 827ccb0eea8a706c4c34a16891f84e7b, first 2 hex numbers is 82, convert hexDex and placeholder value will be 130)
• [[attribute_name]] - attribute value, for example [[attribute_ownerId]]
• [[profile]] - thumbnail profile name, use it in thumbnail path/url
• [[width]] - thumbnail width, use it in thumbnail path/url
• [[height]] - thumbnail height, use it in thumbnail path/url

Add validation rule:

public function rules()
{
    return [
        ['image', 'file', 'extensions' => 'jpg, 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('image');

You can specify default image for models without uploaded image:

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

You can also get generated thumbnail image url:

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

You can specify default thumbnail image for models without uploaded image:

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

Licence

MIT

Links

• Source code on GitHub
• Composer package on Packagist