mahdishariat/yii2-flysystem-wrapper

yii2 flysystem wrapper

yii2 flysystem wrapper

yii2 flysystem wrapper. Flysystem is a filesystem abstraction which allows you to easily swap out a local filesystem for a remote one., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require --prefer-dist whc/yii2-flysystem-wrapper "*"

or add, _(*4)

"whc/yii2-flysystem-wrapper": "*"

to the require section of your composer.json file., _(*5)

then up migrations, _(*6)

php yii migrate/up --migrationPath=vendor/whc/yii2-flysystem-wrapper/migrations

Usage/Features

Once the extension is installed, simply use it in your code by :, _(*7)

add "fs" to components, _(*8)

'fs' => [
    'class' => 'Integral\Flysystem\Adapter\PDOAdapter', // or other adapters
    'tableName' => 'file_storage'
],

upload sample code, _(*9)

<?php
$model = new MyModel();
if (Yii::$app->request->isPost) {
    $model->files = UploadedFile::getInstancesByName('files');
    if ($model->validate()) {
        $data = [
            'path' => '@common/files',
            'context' => '025',
            'version' => '1',
            'metadata' => ['meta' => 1, 'meta2' => 2, 'meta3' => 3],
        ];
        return FlysystemWrapper::upload($model->files, $data);
    }
        return $model;
}
?>

note: in model file rule "maxFiles" is required, _(*10)

<?php
[['files'], 'file', 'skipOnEmpty' => false, 'maxFiles' => 10, 'extensions' => 'txt, jpg']
?>

get a file by hash key, _(*11)

<?php
$hashKey = 'XXX';
return FlysystemWrapper::getByHash($hashKey);
?>

read a file by hash key, _(*12)

<?php
$hashKey = 'XXX';
return FlysystemWrapper::readByHash($hashKey);
?>

delete a file by hash key, _(*13)

<?php
$hashKey = 'XXX';
return FlysystemWrapper::deleteByHash($hashKey);
?>

note: delete method is logical, _(*14)

search file(s) by metadatas or file model spesial attributes, _(*15)

<?php
$params = ['meta1' => 1, 'version' => 2];
return FlysystemWrapper::searchByParams($params);
?>