wyrihaximus/react-filesystem-s3

dev-master 2019-09-04 18:46 UTC

This package is auto-updated.

Last update: 2024-09-05 06:53:48 UTC


README

Build Status Latest Stable Version Total Downloads License

react/filesystem的AWS S3适配器

安装

要使用Composer安装,请使用以下命令,它将自动检测最新版本并将其与~绑定。

composer require wyrihaximus/react-filesystem-s3 

如何使用

在开始使用适配器之前,我们需要进行设置,它需要一个事件循环和一个选项数组,这些选项直接传递给新的Aws\Sdk对象。这个Aws\Sdk对象根据这些选项创建一个新的S3客户端。(如果没有提供任何内容,适配器将创建一个新的处理器堆栈。这种行为可以通过在$options['http_handler']中指定一个来覆盖。)

$loop = Factory::create(); // The required event loop
$adapter = new S3Adapter(
    $loop,
    [
        'credentials' => [ // The credentials to use with this adapter
            'key' => 'KEY',
            'secret' => 'SECRET',
        ],
        'region' => 'REGION', // THe region your bucket resides
        'version' => 'latest',
    ],
    'BUCKET' // Your buckets name
);

接下来,您只需要使用新适配器创建一个新的Filesystem实例。

$filesystem = Filesystem::createFromAdapter($adapter);

这个文件系统可以用来列出S3存储桶根目录中的内容,例如。

$filesystem->dir('')->ls()->then(function (\SplObjectStorage $ls) {
    foreach ($ls as $node) {
        echo $node->getPath(), PHP_EOL;
    }
    echo 'Found ', $ls->count(), ' nodes', PHP_EOL;
}, function ($e) {
    echo $e->getMessage(), PHP_EOL;
});

有关完整示例,请参阅示例目录

贡献

有关详细信息,请参阅CONTRIBUTING

许可证

版权所有 2015 Cees-Jan Kiewiet

在此特此授予任何人免费获得本软件及其相关文档文件(以下简称“软件”)副本的权利,用于不受限制地处理软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本,并允许向获得软件的人提供软件副本以进行此类操作,前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、特定目的适用性和非侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任负责,无论该索赔、损害或其他责任是基于合同、侵权或其他方式,是否与软件或其使用或以其他方式有关。