README

阿里云对象存储（OSS）基于flysystem Yii2 扩展

本扩展的文件管理系统，采用 Flysystem，通过 Yii2扩展creocoder/yii2-flysystem将其集成到Yii2框架中。

通过阿里云OSS的适配器OssAdapter，将两者结合在一起。

目的：标准化文件管理的接口，方便迁移到其他云平台。

安装

推荐通过 composer 安装此扩展。

执行安装命令

$ composer require bestyii/yii2-aliyun-oss

或添加以下

"bestyii/yii2-aliyun-oss": "*"

到 composer.json 文件的 require 部分.

配置

按照以下方式配置Yii的 components

return [
    //...
    'components' => [
        //...
        'fs' => [
                    'class' => 'bestyii\aliyunoss\Filesystem',
                    'accessId' => OSS_ACCESS_ID,
                    'accessSecret' => OSS_ACCESS_SECRET,
                    'region' => OSS_REGION,
                    'bucket' => OSS_BUCKET,
                    'endpoint' => OSS_ENDPOINT,
                    // 'timeout'        => 3600,
                    // 'connectTimeout' => 10,
                    // 'isCName'        => false,
                    // 'token'          => '',
                ],
    ],
];

使用

写入文件

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类型

$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'];

bestyii / yii2-aliyun-oss

维护者

详细信息