PHPackages                             mix8872/yii2-files - 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 & Storage](/categories/file-storage)
4. /
5. mix8872/yii2-files

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

mix8872/yii2-files
==================

Module for files attachment

2.0.0(3y ago)06011MITJavaScriptPHP >=7.1.0

Since Apr 7Pushed 3y ago1 watchersCompare

[ Source](https://github.com/mix8872/yii2-files)[ Packagist](https://packagist.org/packages/mix8872/yii2-files)[ RSS](/packages/mix8872-yii2-files/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (5)Versions (24)Used By (1)

Yii2-files module
=================

[](#yii2-files-module)

Module for attach any files to the your models.

**This module is a new version of [`mix8872/files-attacher`](https://github.com/mix8872/files-attacher) and not compatible with it!
You may use old mix8872/files-attacher or completely delete it and install this module.
The migration mechanism is not provided.**

Installation
------------

[](#installation)

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

Either run

```
php composer.phar require --prefer-dist mix8872/yii2-files

```

or add

```
"mix8872/yii2-files": "~1.0"

```

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

Then you must run migration by running command:

yii migrate --migrationPath=@vendor/mix8872/yii2-files/src/migrations

Configure
---------

[](#configure)

To configure module please add following to the modules section of common main config:

Common:

```
'modules' => [
    'files' => [
        'class' => 'mix8872\yiiFiles\Module',
        'parameters' => [ // general module parameters
            'sizes' => [ // if imgProcessDriver is GD supports only jpeg, png and gif
                'galleryMiddle' => ['width' => '880', 'height' => '587', 'model' => ['common\modules\imageslider\models\ImageSlider']],
                'galleryPreview' => ['width' => '120', 'height' => '60', 'model' => ['common\modules\imageslider\models\ImageSlider']]
            ],
            'sizesNameBy' => 'template', // or 'key', optional, default 'size'
            'sizesNameTemplate' => '_resize_%k-%s', //optional, if sizesNameBy set to 'template'
            'imgProcessDriver' => 'gd', //or 'imagick', optional, default 'gd',
            'filesNameBy' => 'translit', // optional, by default naming is random string
            'savePath' => '/uploads/attachments/', // optional, default save path is '/uploads/attachments/'
        ],
        'attributes' => [ // general attributes configuration, optional
            'preview' => [
                'filetypes' => ['image/*'],
                'resize' => ['width' => '1024', 'height' => '768'], //optional, if imgProcessDriver is GD supports only jpeg, png and gif
            ],
            'images' => [
                'multiple' => true,
                'filetypes' => ['image/*'],
            ]
        ]
    ],
	// ... other modules definition
],
```

Frontend:

```
'modules' => [
        ...

        'files' => [
            'as access' => [
                'class' => \yii\filters\AccessControl::class,
                'rules' => [
                    [
                        'allow' => false,
                    ],
                ],
            ],
        ],
    ],

```

Important!!!
------------

[](#important)

#### Don't forget deny access to module from frontend app!!!

[](#dont-forget-deny-access-to-module-from-frontend-app)

Backend:

```
'modules' => [
        ...

        'files' => [
            'as access' => [
				'class' => 'yii\filters\AccessControl',
				'rules' => [
					[
						'controllers' => ['files/default'],
						'allow' => true,
						'roles' => ['admin']
					],
				]
			],
        ],
    ],

```

In config you may define access control to prevent access to the administrative part of the module.

Also you can define `sizes` to create additional sizes for uploaded images.

In `resize` definitions, also you can optional define model for which scaling will be applied. Support definition several models as array.

To use sizes names template you may define `sizesNameTemplate` option, where `%k` - key, `%s` - size. By default - `%s`;

If `origResize` option defined original image size will be changed. Also you can define models array;

Also you can change image driver to imagick.

By define `filesNameBy` option you may change files naming style from random string to translit file name, also you can define `model` attribute too.

For changing default save path you can define `savePath` option. The path will be considered from the web directory.

Usage
-----

[](#usage)

Using the module is available as a widget and behavior for the model.

First, you must configure the behavior of the required models in this way:

In tags attribute you may define tags for attach files, if you define same tags in delteOld attribute then files loaded with this tags will be rewritten by newly added files.

Also you can configure attachment parameters directly in behavior:

```
public function behaviors()
    {
        return [
            'files' => [
                'class' => \mix8872\yiiFiles\behaviors\FileAttachBehavior::class,
                'attributes' => [
                    'images' => [
                        'multiple' => true, // optional, default false. allow multiple loading
                        'filetypes' => ['image/*'], // array of mime types of allowed files
                        'resize' => ['width' => '1024', 'height' => '768'], //optional, for images only
                    ],
                    'videos' => [

                    ]
                ],
            ],
            // ... other behaviors
        ];
    }
```

Any way you must declare fileAttachBehavior with this name `files`:

```
public function behaviors()
    {
        return [
            'files' => [
                'class' => \mix8872\yiiFiles\behaviors\FileAttachBehavior::class,
                ...
            ],
            // ... other behaviors
        ];
    }
```

If you need do a batch update models with their files then you may define `indexBy` behavior property
and specify the name of the parent model property that will be used for indexing. By default is `id`.

```
public function behaviors()
    {
        return [
            'files' => [
                'class' => \mix8872\yiiFiles\behaviors\FileAttachBehavior::class,
                'attributes' => [ ... ],
                'indexBy' => 'code', // by default - id
                ...
            ],
            // ... other behaviors
        ];
    }
```

Next you may add widget model and echo widget with its config:

```
use mix8872\yiiFiles\widgets\FilesWidget;

?>