Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wyrihaximus/reactphp-filesystem-s3
https://github.com/wyrihaximus/reactphp-filesystem-s3
hacktoberfest php reactphp
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/wyrihaximus/reactphp-filesystem-s3
- Owner: WyriHaximus
- License: mit
- Created: 2015-03-27T19:06:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-05T05:18:22.000Z (11 months ago)
- Last Synced: 2024-10-05T08:20:15.651Z (about 1 month ago)
- Topics: hacktoberfest, php, reactphp
- Language: PHP
- Size: 23.4 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ReactPHP S3 Filesystem Adapter
[](https://travis-ci.org/WyriHaximus/reactphp-filesystem-s3)
[](https://packagist.org/packages/WyriHaximus/react-filesystem-s3)
[](https://packagist.org/packages/WyriHaximus/react-filesystem-s3)
[](https://packagist.org/packages/wyrihaximus/react-filesystem-s3)
AWS S3 adapter for [react/filesystem](https://github.com/reactphp/filesystem)
### Installation ###
To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `~`.
```
composer require wyrihaximus/react-filesystem-s3
```
### How to use ###
Before we start using the adapter we need to set it up, it requires an event loop and an options array which is passed directly into a new `Aws\Sdk` object. The `Aws\Sdk` object creates a new S3 client based on those options. (If none provided the adapter will create a new handler stack. This behavior can be overwritten by specifying one in `$options['http_handler']`.)
```php
$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
);
```
Next all you have to do is create a new `Filesystem` instance with the new adapter:
```php
$filesystem = Filesystem::createFromAdapter($adapter);
```
This filesystem can then be used to, for example, list the contents in the root of your S3 bucket:
```php
$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;
});
```
See the [examples](https://github.com/WyriHaximus/reactphp-filesystem-s3/tree/master/examples) directory for complete examples.
## Contributing ##
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License ##
Copyright 2015 [Cees-Jan Kiewiet](http://wyrihaximus.net/)
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.