PHPackages                             kriptograf/yii2-upload-behavior - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File &amp; Storage](/categories/file-storage)
4. /
5. kriptograf/yii2-upload-behavior

ActiveYii2-extension[File &amp; Storage](/categories/file-storage)

kriptograf/yii2-upload-behavior
===============================

Yii2 file/image upload behavior for ActiveRecord

0.0.2(6y ago)02MITPHPPHP &gt;=7.1.0

Since Jan 5Pushed 6y ago1 watchersCompare

[ Source](https://github.com/kriptograf/yii2-upload-behavior)[ Packagist](https://packagist.org/packages/kriptograf/yii2-upload-behavior)[ Docs](https://github.com/kriptograf/yii2-upload-behavior)[ RSS](/packages/kriptograf-yii2-upload-behavior/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (3)Used By (0)

Yii2 file/image upload behavior for ActiveRecord
================================================

[](#yii2-fileimage-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
------------

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
composer require --prefer-dist kriptograf/yii2-upload-behavior

```

or add

```
"kriptograf/yii2-upload-behavior": "*"

```

to the `require` section of your composer.json.

FileUploadBehavior
------------------

[](#fileuploadbehavior)

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

### Usage

[](#usage)

Attach the behavior to your model class:

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

```

You can use Yii path [aliases](http://www.yiiframework.com/doc-2.0/guide-concept-aliases.html)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]]`
- `[[attribute_name]]` - attribute 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/0/0/0/0/0`
- `[[basename]]` - original filename with extension
- `[[filename]]` - original filename without extension
- `[[extension]]` - original extension

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
-------------------

[](#imageuploadbehavior)

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

### Usage

[](#usage-1)

Attach the behavior to your model class:

```
public function behaviors()
{
    return [
        [
             'class' => '\kriptograf\upload\ImageUploadBehavior',
             'attribute' => 'imageUpload',
             'thumbs' => [
                 'thumb' => ['width' => 400, 'height' => 300],
             ],
             '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](http://www.yiiframework.com/doc-2.0/guide-concept-aliases.html)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]]`
- `[[attribute_name]]` - attribute 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/0/0/0/0/0`
- `[[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:

```
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');

```

You can specify default image for models without uploaded image:

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

```

You can also get generated thumbnail image url:

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

```

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

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

```

Licence
-------

[](#licence)

MIT

Links
-----

[](#links)

- [Source code on GitHub](https://github.com/kriptograf/yii2-upload-behavior)
- [Composer package on Packagist](https://packagist.org/packages/kriptograf/yii2-upload-behavior)

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

2316d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3b18ade8fdb15c3afc65fc88906bf251949f58baca92084a539729ef09211027?d=identicon)[kriptograf](/maintainers/kriptograf)

---

Top Contributors

[![kriptograf](https://avatars.githubusercontent.com/u/2950209?v=4)](https://github.com/kriptograf "kriptograf (3 commits)")

---

Tags

imageresizefileuploadBehaviorthumb

### Embed Badge

![Health badge](/badges/kriptograf-yii2-upload-behavior/health.svg)

```
[![Health](https://phpackages.com/badges/kriptograf-yii2-upload-behavior/health.svg)](https://phpackages.com/packages/kriptograf-yii2-upload-behavior)
```

###  Alternatives

[yii-dream-team/yii2-upload-behavior

Yii2 file/image upload behavior for ActiveRecord

79207.1k16](/packages/yii-dream-team-yii2-upload-behavior)[mohorev/yii2-upload-behavior

Upload behavior for Yii 2

128265.5k9](/packages/mohorev-yii2-upload-behavior)[liyunfang/yii2-upload-behavior

Upload behavior for Yii 2

161.7k](/packages/liyunfang-yii2-upload-behavior)[demi/image

Yii2 behavior for upload image to model

2214.7k](/packages/demi-image)[sjaakp/yii2-illustrated-behavior

ActiveRecord Behavior with associated Widget for Yii2.

423.1k](/packages/sjaakp-yii2-illustrated-behavior)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
