README

此扩展为 Yii 框架提供 Flysystem 集成。 Flysystem 是一个文件系统抽象层，允许您轻松地将本地文件系统与远程文件系统进行交换。

安装

安装此扩展的首选方法是使用 composer。

运行以下命令之一：

$ composer require sorokinmedia/yii2-flysystem

或

"sorokinmedia/yii2-flysystem": "dev-master"

将其添加到您的 composer.json 文件的 require 部分。

配置

本地文件系统

按照以下方式配置应用的 components：

return [
    //...
    'components' => [
        //...
        'fs' => [
            'class' => 'sorokinmedia\flysystem\LocalFilesystem',
            'path' => '@webroot/files',
        ],
    ],
];

AWS S3 文件系统

运行以下命令之一：

$ composer require league/flysystem-aws-s3-v3

或

"league/flysystem-aws-s3-v3": "~1.0"

将以下内容添加到您的 composer.json 文件的 require 部分，并按照以下方式配置应用的 components：

return [
    //...
    'components' => [
        //...
        'awss3Fs' => [
            'class' => 'sorokinmedia\flysystem\AwsS3Filesystem',
            'key' => 'your-key',
            'secret' => 'your-secret',
            'bucket' => 'your-bucket',
            'region' => 'your-region',
            // 'version' => 'latest',
            // 'baseUrl' => 'your-base-url',
            // 'prefix' => 'your-prefix',
            // 'options' => [],
            // 'endpoint' => 'http://my-custom-url'
        ],
    ],
];

缓存功能

运行以下命令之一：

$ composer require league/flysystem-cached-adapter

或

"league/flysystem-cached-adapter": "~1.0"

将以下内容添加到您的 composer.json 文件的 require 部分，并按照以下方式配置 fsID 应用组件：

return [
    //...
    'components' => [
        //...
        'fsID' => [
            //...
            'cache' => 'cacheID',
            // 'cacheKey' => 'flysystem',
            // 'cacheDuration' => 3600,
        ],
    ],
];

全局可见性设置

按照以下方式配置 fsID 应用组件：

return [
    //...
    'components' => [
        //...
        'fsID' => [
            //...
            'config' => [
                'visibility' => \League\Flysystem\AdapterInterface::VISIBILITY_PRIVATE,
            ],
        ],
    ],
];

使用

写入文件

要写入文件

Yii::$app->fs->write('filename.ext', 'contents');

使用流内容写入文件

$stream = fopen('/path/to/somefile.ext', 'r+');
Yii::$app->fs->writeStream('filename.ext', $stream);

更新文件

要更新文件

Yii::$app->fs->update('filename.ext', 'contents');

使用流内容更新文件

$stream = fopen('/path/to/somefile.ext', 'r+');
Yii::$app->fs->updateStream('filename.ext', $stream);

写入或更新文件

要写入或更新文件

Yii::$app->fs->put('filename.ext', 'contents');

使用流内容写入或更新文件

$stream = fopen('/path/to/somefile.ext', 'r+');
Yii::$app->fs->putStream('filename.ext', $stream);

读取文件

要读取文件

$contents = Yii::$app->fs->read('filename.ext');

获取读取流

$stream = Yii::$app->fs->readStream('filename.ext');
$contents = stream_get_contents($stream);
fclose($stream);

检查文件是否存在

要检查文件是否存在

$exists = Yii::$app->fs->has('filename.ext');

删除文件

要删除文件

Yii::$app->fs->delete('filename.ext');

读取和删除文件

要读取和删除文件

$contents = Yii::$app->fs->readAndDelete('filename.ext');

重命名文件

要重命名文件

Yii::$app->fs->rename('filename.ext', 'newname.ext');

获取文件 MIME 类型

要获取文件 MIME 类型

$mimetype = Yii::$app->fs->getMimetype('filename.ext');

获取文件时间戳

要获取文件时间戳

$timestamp = Yii::$app->fs->getTimestamp('filename.ext');

获取文件大小

要获取文件大小

$timestamp = Yii::$app->fs->getSize('filename.ext');

创建目录

要创建目录

Yii::$app->fs->createDir('path/to/directory');

在写入更深路径时也会隐式创建目录

Yii::$app->fs->write('path/to/filename.ext');

删除目录

要删除目录

Yii::$app->fs->deleteDir('path/to/filename.ext');

管理可见性

可见性是跨多个平台的文件权限的抽象。可见性可以是公开或私有。

use League\Flysystem\AdapterInterface;

Yii::$app->fs->write('filename.ext', 'contents', [
    'visibility' => AdapterInterface::VISIBILITY_PRIVATE
]);

您还可以更改和检查现有文件的可见性

use League\Flysystem\AdapterInterface;

if (Yii::$app->fs->getVisibility('filename.ext') === AdapterInterface::VISIBILITY_PRIVATE) {
    Yii::$app->fs->setVisibility('filename.ext', AdapterInterface::VISIBILITY_PUBLIC);
}

列出内容

要列出内容

$contents = Yii::$app->fs->listContents();

foreach ($contents as $object) {
    echo $object['basename']
        . ' is located at' . $object['path']
        . ' and is a ' . $object['type'];
}

默认情况下，Flysystem 非递归地列出顶级目录。您可以通过提供目录名称和递归布尔值来获取更精确的结果

$contents = Yii::$app->fs->listContents('path/to/directory', true);

列出路径

要列出路径

$paths = Yii::$app->fs->listPaths();

foreach ($paths as $path) {
    echo $path;
}

确保存在特定元数据的列出

要确保存在特定元数据的列出

$listing = Yii::$app->fs->listWith(
    ['mimetype', 'size', 'timestamp'],
    'optional/path/to/directory',
    true
);

foreach ($listing as $object) {
    echo $object['path'] . ' has mimetype: ' . $object['mimetype'];
}

使用显式元数据获取文件信息

要使用显式元数据获取文件信息

$info = Yii::$app->fs->getWithMetadata('path/to/filename.ext', ['timestamp', 'mimetype']);
echo $info['mimetype'];
echo $info['timestamp'];