biller / yii2-flysystem
为Yii框架的flysystem 3.0扩展
4.1.0
2024-06-06 13:18 UTC
Requires
- php: ^8.1
- league/flysystem: ^3.0
- league/flysystem-aws-s3-v3: ^3.27
- league/flysystem-memory: ^3.0
- yiisoft/yii2: ^2.0
README
注意:仅适配AWS S3、InMemory和本地文件系统。
基于: https://github.com/creocoder/yii2-flysystem
此扩展为Yii框架提供Flysystem 3.0集成。 Flysystem是一个文件系统抽象,允许您轻松地将本地文件系统与远程文件系统进行交换。
安装
安装此扩展的首选方式是通过composer。
运行以下命令:
$ composer require biller/yii2-flysystem:^3.0
或者将以下内容添加到您的composer.json
文件的require
部分:
"biller/yii2-flysystem": "^3.0"
配置
本地文件系统
按照以下方式配置应用程序的components
:
return [ //... 'components' => [ //... 'fs' => [ 'class' => 'biller\flysystem\LocalFilesystem', 'path' => '@webroot/files', ], ], ];
AWS S3文件系统
运行以下命令:
$ composer require league/flysystem-aws-s3-V3:^3.15
或者将以下内容添加到您的composer.json
文件的require
部分:
"league/flysystem-aws-s3-V3": "^3.15"
将以下内容添加到您的composer.json
文件的require
部分,并按照以下方式配置应用程序的components
:
return [ //... 'components' => [ //... 'awss3Fs' => [ 'class' => 'biller\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' ], ], ];
全局可见性设置
按照以下方式配置fsID
应用程序组件:
return [ //... 'components' => [ //... 'fsID' => [ //... 'config' => [ 'visibility' => \League\Flysystem\Visibility::PRIVATE, ], ], ], ];
使用
写入或更新文件
要写入或更新文件
Yii::$app->fs->write('filename.ext', 'contents');
使用流内容写入或更新文件
$stream = fopen('/path/to/somefile.ext', 'r+'); Yii::$app->fs->writeStream('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->fileExists('filename.ext');
删除文件
删除文件
Yii::$app->fs->delete('filename.ext');
获取文件MIME类型
获取文件MIME类型
$mimetype = Yii::$app->fs->mimeType('filename.ext');
获取文件时间戳
获取文件时间戳
$timestamp = Yii::$app->fs->lastModified('filename.ext');
获取文件大小
获取文件大小
$timestamp = Yii::$app->fs->fileSize('filename.ext');
创建目录
创建目录
Yii::$app->fs->createDirectory('path/to/directory');
在写入更深路径时,目录也会隐式创建
Yii::$app->fs->write('path/to/filename.ext');
删除目录
删除目录
Yii::$app->fs->deleteDirectory('path/to/filename.ext');
管理可见性
可见性是跨多个平台文件权限的抽象。可见性可以是公共的或私有的。
use League\Flysystem\AdapterInterface; Yii::$app->fs->write('filename.ext', 'contents', [ 'visibility' => \League\Flysystem\Visibility.PRIVATE ]);
您还可以更改和检查现有文件的可见性
use League\Flysystem\AdapterInterface; if (Yii::$app->fs->visibility('filename.ext') === \League\Flysystem\Visibility::PRIVATE) { Yii::$app->fs->setVisibility('filename.ext', \League\Flysystem\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);