PHPackages denoll/yii2-file-storage - 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. denoll/yii2-file-storage ActiveYii2-extension[File & Storage](/categories/file-storage) denoll/yii2-file-storage ======================== Yii2 file upload delete and storage v1.0.2(6y ago)119BSD-3-ClausePHPCI failing Since Dec 11Pushed 6y ago2 watchersCompare [ Source](https://github.com/denoll/yii2-file-storage)[ Packagist](https://packagist.org/packages/denoll/yii2-file-storage)[ RSS](/packages/denoll-yii2-file-storage/feed)WikiDiscussions master Synced 4w ago READMEChangelog (2)Dependencies (6)Versions (2)Used By (0) [![Latest Stable Version](https://camo.githubusercontent.com/7ac4b34668b089a33fe7cd703b52188630047e1f4768a3c9c1dcf9ddfd20b380/68747470733a2f2f706f7365722e707567782e6f72672f64656e6f6c6c2f796969322d66696c652d73746f726167652f762f737461626c65)](https://packagist.org/packages/denoll/yii2-file-storage)[![Latest Unstable Version](https://camo.githubusercontent.com/e56c14259dc93b1ba67215b74a5a8bbb2a50f1f6483572ae512aab9edd9a6fc9/68747470733a2f2f706f7365722e707567782e6f72672f64656e6f6c6c2f796969322d66696c652d73746f726167652f762f756e737461626c65)](https://packagist.org/packages/denoll/yii2-file-storage) !!! This package creating Eugene Terentev . And I do not pretend to any copyrights. This package has been allocated separately only for their own needs !!! This package is designed to automate routine processes of uploading files, their saving and storage. It includes: - File upload widget (based on [Blueimp File Upload](https://github.com/blueimp/jQuery-File-Upload)) - Component for storing files (built on top of [flysystem](https://github.com/thephpleague/flysystem)) - Actions to download, delete, and view (download) files - Behavior for saving files in the model and delete files when you delete a model Here you can see list of available [filesystem adapters](https://github.com/thephpleague/flysystem#adapters) Demo ---- [](#demo) Since file kit is a part of [yii2-starter-kit](https://github.com/trntv/yii2-starter-kit) it's demo can be found in starter kit demo [here](http://backend.yii2-starter-kit.terentev.net/article/create). Installation ============ [](#installation) The preferred way to install this extension is through [composer](http://getcomposer.org/download/). Either run ``` php composer.phar require denoll/yii2-file-storage ``` or add ``` "denoll/yii2-file-storage": "@stable" ``` to the require section of your `composer.json` file. File Storage ============ [](#file-storage) To work with the File Kit you need to configure FileStorage first. This component is a layer of abstraction over the filesystem - Its main task to take on the generation of a unique name for each file and trigger corresponding events. ``` 'fileStorage'=>[ 'class' => 'denoll\filekit\Storage', 'baseUrl' => '@web/uploads' 'filesystem'=> ... // OR 'filesystemComponent' => ... ], ``` There are several ways to configure `denoll\filekit\Storage` to work with `flysystem`. Using Closure ------------- [](#using-closure) ``` 'fileStorage'=>[ ... 'filesystem'=> function() { $adapter = new \League\Flysystem\Adapter\Local('some/path/to/storage'); return new League\Flysystem\Filesystem($adapter); } ] ``` Using filesystem builder ------------------------ [](#using-filesystem-builder) - Create a builder class that implements `denoll\filekit\filesystem\FilesystemBuilderInterface` and implement method `build` which returns filesystem object. See `examples/` - Add to your configuration: ``` 'fileStorage'=>[ ... 'filesystem'=> [ 'class' => 'app\components\FilesystemBuilder', 'path' => '@webroot/uploads' ... ] ] ``` Read more about flysystem at Using third-party extensions ---------------------------- [](#using-third-party-extensions) - Create filesystem component (example uses `creocoder/yii2-flysystem`) ``` 'components' => [ ... 'fs' => [ 'class' => 'creocoder\flysystem\LocalFilesystem', 'path' => '@webroot/files' ], ... ] ``` - Set filesystem component name in storage configuration: ``` 'components' => [ ... 'fileStorage'=>[ 'filesystemComponent'=> 'fs' ], ... ] ``` Actions ======= [](#actions) File Kit contains several Actions to work with uploads. ### Upload Action [](#upload-action) Designed to save the file uploaded by the widget ``` public function actions(){ return [ 'upload'=>[ 'class'=>'denoll\filekit\actions\UploadAction', //'deleteRoute' => 'my-custom-delete', // my custom delete action for deleting just uploaded files(not yet saved) //'fileStorage' => 'myfileStorage', // my custom fileStorage from configuration 'multiple' => true, 'disableCsrf' => true, 'responseFormat' => Response::FORMAT_JSON, 'responsePathParam' => 'path', 'responseBaseUrlParam' => 'base_url', 'responseUrlParam' => 'url', 'responseDeleteUrlParam' => 'delete_url', 'responseMimeTypeParam' => 'type', 'responseNameParam' => 'name', 'responseSizeParam' => 'size', 'deleteRoute' => 'delete', 'fileStorage' => 'fileStorage', // Yii::$app->get('fileStorage') 'fileStorageParam' => 'fileStorage', // ?fileStorage=someStorageComponent 'sessionKey' => '_uploadedFiles', 'allowChangeFilestorage' => false, 'validationRules' => [ ... ], 'on afterSave' => function($event) { /* @var $file \League\Flysystem\File */ $file = $event->file // do something (resize, add watermark etc) } ] ]; } ``` See additional settings in the corresponding class ### Delete Action [](#delete-action) ``` public function actions(){ return [ 'delete'=>[ 'class'=>'denoll\filekit\actions\DeleteAction', //'fileStorage' => 'fileStorageMy', // my custom fileStorage from configuration(such as in the upload action) ] ]; } ``` See additional settings in the corresponding class ### View (Download) Action [](#view-download-action) ``` public function actions(){ return [ 'view'=>[ 'class'=>'denoll\filekit\actions\ViewAction', ] ]; } ``` See additional settings in the corresponding class Upload Widget ============= [](#upload-widget) Standalone usage ``` echo \denoll\filekit\widget\Upload::widget([ 'model' => $model, 'attribute' => 'files', 'url' => ['upload'], 'sortable' => true, 'maxFileSize' => 10 * 1024 * 1024, // 10Mb 'minFileSize' => 1 * 1024 * 1024, // 1Mb 'maxNumberOfFiles' => 3 // default 1, 'acceptFileTypes' => new JsExpression('/(\.|\/)(gif|jpe?g|png)$/i'), 'showPreviewFilename' => false, 'clientOptions' => [ ...other blueimp options... ] ]); ``` With ActiveForm ``` echo $form->field($model, 'files')->widget( '\denoll\filekit\widget\Upload', [ 'url' => ['upload'], 'sortable' => true, 'maxFileSize' => 10 * 1024 * 1024, // 10 MiB 'maxNumberOfFiles' => 3, 'clientOptions' => [ ...other blueimp options... ] ] ); ``` Upload Widget events -------------------- [](#upload-widget-events) Upload widget trigger some of built-in blueimp events: - start - fail - done - always You can use them directly or add your custom handlers in options: ``` 'clientOptions' => [ 'start' => new JsExpression('function(e, data) { ... do something ... }'), 'done' => new JsExpression('function(e, data) { ... do something ... }'), 'fail' => new JsExpression('function(e, data) { ... do something ... }'), 'always' => new JsExpression('function(e, data) { ... do something ... }'), ] ``` UploadBehavior ============== [](#uploadbehavior) This behavior is designed to save uploaded files in the corresponding relation. Somewhere in model: For multiple files ``` public function behaviors() { return [ 'file' => [ 'class' => 'denoll\filekit\behaviors\UploadBehavior', 'filesStorage' => 'myfileStorage', // my custom fileStorage from configuration(for properly remove the file from disk) 'multiple' => true, 'attribute' => 'files', 'uploadRelation' => 'uploadedFiles', 'pathAttribute' => 'path', 'baseUrlAttribute' => 'base_url', 'typeAttribute' => 'type', 'sizeAttribute' => 'size', 'nameAttribute' => 'name', 'orderAttribute' => 'order' ], ]; } ``` For single file upload ``` public function behaviors() { return [ 'file' => [ 'class' => 'denoll\filekit\behaviors\UploadBehavior', 'filesStorage' => 'fileStorageMy', // my custom fileStorage from configuration(for properly remove the file from disk) 'attribute' => 'file', 'pathAttribute' => 'path', 'baseUrlAttribute' => 'base_url', ... ], ]; } ``` See additional settings in the corresponding class. Validation ========== [](#validation) There are two ways you can perform validation over uploads. On the client side validation is performed by Blueimp File Upload. Here is [documentation](https://github.com/blueimp/jQuery-File-Upload/wiki/Options#validation-options) about available options. On the server side validation is performed by \[\[yii\\web\\UploadAction\]\], where you can configure validation rules for \[\[yii\\base\\DynamicModel\]\] that will be used in validation process Tips ==== [](#tips) Adding watermark ---------------- [](#adding-watermark) Install `intervention/image` library ``` composer require intervention/image ``` Edit your upload actions as so ``` public function actions(){ return [ 'upload'=>[ 'class'=>'denoll\filekit\actions\UploadAction', ... 'on afterSave' => function($event) { /* @var $file \League\Flysystem\File */ $file = $event->file; // create new Intervention Image $img = Intervention\Image\ImageManager::make($file->read()); // insert watermark at bottom-right corner with 10px offset $img->insert('public/watermark.png', 'bottom-right', 10, 10); // save image $file->put($img->encode()); } ... ] ]; } ``` ### Health Score 26 — LowBetter than 41% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community8 Small or concentrated contributor base Maturity57 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 Unknown Total 1 Last Release 2394d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/14dd2a8e96accd0bcac94bcaed51c6ec781f761e3ed5b5d697aefdd2c4dbe9d5?d=identicon)[denoll](/maintainers/denoll) --- Top Contributors [![denoll](https://avatars.githubusercontent.com/u/7146675?v=4)](https://github.com/denoll "denoll (17 commits)") --- Tags blueimpfilesystem-componentflysystemstorageupload-widgetyii2 ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/denoll-yii2-file-storage/health.svg) ``` [![Health](https://phpackages.com/badges/denoll-yii2-file-storage/health.svg)](https://phpackages.com/packages/denoll-yii2-file-storage) ``` ### Alternatives [league/flysystem-aws-s3-v3 AWS S3 filesystem adapter for Flysystem. 1.7k285.7M989](/packages/league-flysystem-aws-s3-v3)[unisharp/laravel-filemanager A file upload/editor intended for use with Laravel 5 to 10 and CKEditor / TinyMCE 2.2k3.5M82](/packages/unisharp-laravel-filemanager)[craftcms/cms Craft CMS 3.6k3.6M3.0k](/packages/craftcms-cms)[tempest/framework The PHP framework that gets out of your way. 2.2k34.4k13](/packages/tempest-framework)[yii2-starter-kit/yii2-file-kit Yii2 file upload and storage kit 151227.3k6](/packages/yii2-starter-kit-yii2-file-kit)[azure-oss/storage-blob-flysystem Flysystem adapter for Azure Storage PHP 281.4M24](/packages/azure-oss-storage-blob-flysystem) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)