README

此扩展为 Yii 框架提供了 Flysystem 的集成。 Flysystem 是一种文件系统抽象，它允许您轻松地将本地文件系统替换为远程文件系统。

安装

安装此扩展的首选方法是通过 composer。

运行

$ composer require acidwave/yii2-flysystem

或添加

"acidwave/yii2-flysystem": "1.0.*"

到您的 composer.json 文件的 require 部分。

配置

本地文件系统

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

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

FTP 文件系统

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

return [
    //...
    'components' => [
        //...
        'ftpFs' => [
            'class' => 'Acidwave\Flysystem\FtpFilesystem',
            'host' => 'ftp.example.com',
            // 'port' => 21,
            'username' => 'your-username',
            'password' => 'your-password',
            // 'ssl' => true,
            // 'timeout' => 60,
            'root' => '/path/to/root',
            // 'passive' => false,
            // 'transferMode' => FTP_TEXT,
            // 'enableTimestampsOnUnixListings' => false,
            // 'systemType' => null, // 'windows' or 'unix'
        ],
    ],
];

AWS S3 文件系统

运行

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

或添加

"league/flysystem-aws-s3-v3": "^2.0"

到您的 composer.json 文件的 require 部分，并按照以下方式配置应用程序的 components：

return [
    //...
    'components' => [
        //...
        'awss3Fs' => [
            'class' => 'Acidwave\Flysystem\AwsS3Filesystem',
            'key' => 'your-key',
            'secret' => 'your-secret',
            'bucket' => 'your-bucket',
            'region' => 'your-region',
            // 'version' => 'latest',
            // 'baseUrl' => 'your-base-url',
            // 'prefix' => 'your-prefix',
            // 'visibility' => \League\Flysystem\Visibility::PUBLIC,
            // 'endpoint' => 'http://my-custom-url'
        ],
    ],
];

Dropbox 文件系统

运行

$ composer require league/flysystem-dropbox

或添加

"league/flysystem-dropbox": "^2.0"

到您的 composer.json 文件的 require 部分，并按照以下方式配置应用程序的 components：

return [
    //...
    'components' => [
        //...
        'dropboxFs' => [
            'class' => 'Acidwave\Flysystem\DropboxFilesystem',
            'token' => 'your-token',
            // 'prefix' => 'your-prefix',
        ],
    ],
];

SFTP 文件系统

运行

$ composer require league/flysystem-sftp

或添加

"league/flysystem-sftp": "^2.0"

到您的 composer.json 文件的 require 部分，并按照以下方式配置应用程序的 components：

return [
    //...
    'components' => [
        //...
        'sftpFs' => [
            'class' => 'Acidwave\Flysystem\SftpFilesystem',
            'host' => 'sftp.example.com',
            // 'port' => 22,
            'username' => 'your-username',
            'password' => 'your-password',
            'privateKey' => '/path/to/or/contents/of/privatekey',
            'passphrase' => 'my-super-secret-passphrase-for-the-private-key',
            // 'useAgent' => false,
            // 'timeout' => 60,
            'root' => '/path/to/root',
            // 'dirPrivate' => 0700,
            // 'dirPublic' => 0755,
            // 'filePrivate' => 0600,
            // 'filePublic' => 0644,
        ],
    ],
];

ZipArchive 文件系统

运行

$ composer require league/flysystem-ziparchive

或添加

"league/flysystem-ziparchive": "^2.0"

到您的 composer.json 文件的 require 部分，并按照以下方式配置应用程序的 components：

return [
    //...
    'components' => [
        //...
        'ziparchiveFs' => [
            'class' => 'Acidwave\Flysystem\ZipArchiveFilesystem',
            'filename' => '@webroot/files/archive.zip',
            // 'localDirectoryPermissions' => 700,
        ],
    ],
];

全局可见性设置

按照以下方式配置 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');

重命名文件

重命名文件

Yii::$app->fs->move('filename.ext', 'newname.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\Visibility;

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

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

use League\Flysystem\Visibility;

if (Yii::$app->fs->visibility('filename.ext') === Visibility::PRIVATE) {
    Yii::$app->fs->setVisibility('filename.ext', Visibility::PUBLIC);
}

列出内容

列出内容

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

foreach ($contents as $object) {
    echo basename($object->path())
        . ' is located at' . $object->path()
        . ' and is a ';
    if ($object instanceof \League\Flysystem\FileAttributes) {
        echo 'file' . PHP_EOF;
    } elseif ($object instanceof \League\Flysystem\DirectoryAttributes) {
        echo 'directory' . PHP_EOF;
    }
}

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

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

捐赠

通过 Liberapay 支持此项目和其他由 acidwave 维护的项目。