dicr/yii2-file

Yii2 的文件系统组件

安装: 212

依赖者: 1

建议者: 0

安全: 0

星标: 1

分支: 0

类型:yii2-extension

8.1.9 2022-02-19 22:57 UTC

README

包含以下功能

  • FileStore - 文件存储的抽象;

    • LocaFileStore - 本地文件系统的存储实现;
    • FtpFileStore - FTP 文件存储;
    • SftpFileStore - 通过 SFTP 存储文件;
    • FlysystemFileStore - 通过 Flysystem 库存储;
  • File - 文件的抽象,支持文件操作;

    • UploadFile - 从其他文件或 $_FILES 数据中上传文件到存储;
    • ThumbFile - 创建带磁盘缓存的图片预览;
    • CSVFile - 用于操作 CSV 文件的抽象;
      • CSVResponseFormatter - 以 CSV 文件形式生成响应;
  • FileAttributeBehavior - 支持模型文件属性;

  • FileInputWidget - 支持用于上传和编辑模型属性文件/图片的表单字段;

文件存储处理

以本地文件存储为例配置组件

$config = [
    'components' => [
        // хранилище файлов
        'fileStore' => [
            'class' => dicr\file\LocalFileStore::class,
            'path' => '@webroot/files', // базовый путь на диске
            'url' => '@web/files' // базовый URL для скачивания (опционально)
        ]
    ]
];

使用方法

/** @var dicr\file\FileStore $store получаем настроенный компонент хранилища */
$store = Yii::$app->get('fileStore');

// или например хранилище в локальной файловой системе
$store2 = dicr\file\LocalFileStore::root();

// список файлов хранилища в директории pdf
$files = $store->list('pdf');

// Получаем файл по имени
$file = $store->file('pdf/my-report.pdf');

// выводим содержимое файла
echo $file->content;

// выводим url файла в хранилище
echo $file->url;

创建图片预览

要使用预览,需要配置本地文件系统中的图片缓存

$config = [
    'components' => [
        // хранилище для превью картинок
        'thumbStore' => [
            'class' => dicr\file\LocalFileStore::class,
            'path' => '@webroot/thumb',
            'url' => '@web/thumb',
        ],
    
        // основное хранилище файлов
        'fileStore' => [
            'class' => dicr\file\LocalFileStore::class,
            'path' => '@webroot/files',
            // конфигурация компонента для создания превью
            'thumbFileConfig' => [
                'store' => 'thumbStore', // компонент хранилища для кэша картинок
                'noimage' => '@webroot/res/img/noimage.png' // заглушка для создания превью несуществующих файлов моделей
            ]
        ]
    ]
];

使用预览

use yii\helpers\Html;
use dicr\file\FileStore;

/** @var FileStore $store */
$store = Yii::$app->get('fileStore');

// получаем файл из хранилища
$file = $store->file('images/image.jpg');

// выводим картинку превью
echo Html::img($file->thumb(['width' => 320, 'height' => 240])->url);

模型文件属性

商品模型的示例

use yii\db\ActiveRecord;
use dicr\file\File;
use dicr\file\FileAttributeBehavior;

/**
 * @property-read ?File $image одна картинка
 * @property-read File[] $docs набор файлов документов
 * 
 * FileAttributeBehavior
 * 
 * @method bool loadFileAttributes($formName = null)
 * @method saveFileAttributes()
 * @method File|File[]|null getFileAttribute(string $attribute, bool $refresh = false)
 */
class Product extends ActiveRecord
{
    /**
     * @inheritDoc
     */
    public function behaviors() : array
    {
        return [
            // добавляем файловые аттрибуты
            'file' => [
                'class' => FileAttributeBehavior::class,
                'attributes' => [
                    'image' => 1, // одна картинка
                    'docs' => 0 // неограниченное кол-во файлов
                ]
            ]   
        ];       
    }

    /**
     * @inheritDoc
     */
    public function load($data, $formName = null) : bool
    {
        $ret = parent::load($data, $formName);

        // загружаем файловые аттрибуты
        if ($this->loadFileAttributes($formName)) {
            $ret = true;
        }

        return $ret;
    }
}

使用文件属性

use dicr\file\UploadFile;use yii\db\ActiveRecord;use yii\helpers\Html;

/**
 * @var ActiveRecord $model
 */

// добавляем картинку товару
$model->image = new UploadFile('/tmp/newimage.jpg');

// сохраняем
$model->save();

// выводим превью картинки товара
echo Html::img((string)$model->image->thumb(['width' => 320, 'height' => 200]));

// выводим ссылки загрузки файлов товара
foreach ($model->docs ?: [] as $doc) {
    echo Html::a($doc->name, $doc->url);
}

商品文件编辑表单

use dicr\file\FileInputWidget;use yii\db\ActiveRecord;
use yii\widgets\ActiveForm;

/**
 * @var ActiveForm $form
 * @var ActiveRecord $model
 */

// поле с виджетом редактирования картинки
echo $form->field($model, 'image')->widget(FileInputWidget::class, [
  'layout' => 'images',
  'limit' => 1,
  'accept' => 'image/*',
  'removeExt' => true
]);

// поле с виджетом редактирования документов
echo $form->field($model, 'docs')->widget(FileInputWidget::class, [
  'layout' => 'files',
  'limit' => 0,
  'removeExt' => true
]);