PHPackages grandmasterx/filekit - 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. grandmasterx/filekit ActiveYii2-extension[File & Storage](/categories/file-storage) grandmasterx/filekit ==================== Yii2 file upload and storage kit 010PHP Since Jul 24Pushed 7y ago1 watchersCompare [ Source](https://github.com/GrandMasterX/filekit)[ Packagist](https://packagist.org/packages/grandmasterx/filekit)[ RSS](/packages/grandmasterx-filekit/feed)WikiDiscussions master Synced 2d ago READMEChangelogDependenciesVersions (1)Used By (0) ![Packagist](https://camo.githubusercontent.com/c5f0b7f391f14003f5e09ab278c00f6e781ff58e0c9bf081c2c6fbfacc3c0f85/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6772616e646d6173746572782f796969322d66696c652d6b69742e737667)[![Dependency Status](https://camo.githubusercontent.com/12c5e403a8ad6af992ae5ce0232033c14965f3b03d5f847d572127efe26e0bbc/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f7068702f6772616e646d6173746572783a796969322d66696c652d6b69742f62616467652e737667)](https://www.versioneye.com/php/grandmasterx:yii2-file-kit/2.0.0) This kit 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/grandmasterx/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 grandmasterx/yii2-file-kit ``` or add ``` "grandmasterx/yii2-file-kit": "@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' => 'grandmasterx\filekit\Storage', 'baseUrl' => '@web/uploads' 'filesystem'=> ... // OR 'filesystemComponent' => ... ], ``` There are several ways to configure `grandmasterx\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 `grandmasterx\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'=>'grandmasterx\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'=>'grandmasterx\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'=>'grandmasterx\filekit\actions\ViewAction', ] ]; } ``` See additional settings in the corresponding class Upload Widget ============= [](#upload-widget) Standalone usage ``` echo \grandmasterx\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... ] ]); ``` Standalone usage - without model ``` echo \grandmasterx\filekit\widget\Upload::widget([ 'name' => 'filename', 'hiddenInputId' => 'filename', // must for not use model '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( '\grandmasterx\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' => 'grandmasterx\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' => 'grandmasterx\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'=>'grandmasterx\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 20 — LowBetter than 14% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community7 Small or concentrated contributor base Maturity40 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/da448c29b0b269957ab1b48b4e90ee34100f676f17645320ccf7fccd5c3c55f9?d=identicon)[GrandMasterX](/maintainers/GrandMasterX) --- Top Contributors [![GrandMasterX](https://avatars.githubusercontent.com/u/4984750?v=4)](https://github.com/GrandMasterX "GrandMasterX (4 commits)") ### Embed Badge ![Health badge](/badges/grandmasterx-filekit/health.svg) ``` [![Health](https://phpackages.com/badges/grandmasterx-filekit/health.svg)](https://phpackages.com/packages/grandmasterx-filekit) ``` ### Alternatives [knplabs/gaufrette PHP library that provides a filesystem abstraction layer 2.5k39.8M123](/packages/knplabs-gaufrette)[google/cloud-storage Cloud Storage Client for PHP 34390.8M125](/packages/google-cloud-storage)[illuminate/filesystem The Illuminate Filesystem package. 15261.6M2.6k](/packages/illuminate-filesystem)[superbalist/flysystem-google-storage Flysystem adapter for Google Cloud Storage 26320.6M30](/packages/superbalist-flysystem-google-storage)[creocoder/yii2-flysystem The flysystem extension for the Yii framework 2931.7M62](/packages/creocoder-yii2-flysystem)[flowjs/flow-php-server PHP library for handling chunk uploads. Works with flow.js html5 file uploads. 2451.6M15](/packages/flowjs-flow-php-server) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)