flysystem-aws-s3-v3

Flysystem-aws-s3-v3 is a PHP package that provides an AWS S3 adapter for the Flysystem filesystem abstraction library. It allows developers to interact with Amazon S3 storage using a consistent API, making it easier to work with cloud storage in PHP applications.

Pros

• Seamless integration with Flysystem, providing a unified interface for various storage systems
• Supports AWS S3 features like presigned URLs and multipart uploads
• Easy to use and configure with minimal setup required
• Actively maintained and compatible with the latest versions of Flysystem and AWS SDK

Cons

• Requires knowledge of Flysystem's architecture and concepts
• Limited to AWS S3 storage; not suitable for other cloud storage providers
• Dependency on the AWS SDK for PHP, which may increase the project's overall size
• May have a slight performance overhead compared to direct AWS SDK usage

Code Examples

1. Creating an S3 adapter and filesystem:

use Aws\S3\S3Client;
use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
use League\Flysystem\Filesystem;

$client = new S3Client([
    'credentials' => [
        'key'    => 'your-key',
        'secret' => 'your-secret',
    ],
    'region' => 'your-region',
    'version' => 'latest',
]);

$adapter = new AwsS3V3Adapter($client, 'your-bucket-name');
$filesystem = new Filesystem($adapter);

2. Writing and reading a file:

$filesystem->write('path/to/file.txt', 'Contents of the file');
$contents = $filesystem->read('path/to/file.txt');
echo $contents; // Outputs: Contents of the file

3. Generating a presigned URL:

$adapter = $filesystem->getAdapter();
$expiration = new \DateTime('+1 hour');
$url = $adapter->getPresignedUrl('path/to/file.txt', $expiration);
echo $url; // Outputs: https://your-bucket.s3.amazonaws.com/path/to/file.txt?...

Getting Started

1. Install the package via Composer:

   composer require league/flysystem-aws-s3-v3
   

2. Create an S3 client and configure the adapter:

   use Aws\S3\S3Client;
   use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
   use League\Flysystem\Filesystem;
   
   $client = new S3Client([
       'credentials' => [
           'key'    => 'your-key',
           'secret' => 'your-secret',
       ],
       'region' => 'your-region',
       'version' => 'latest',
   ]);
   
   $adapter = new AwsS3V3Adapter($client, 'your-bucket-name');
   $filesystem = new Filesystem($adapter);
   

3. Start using the filesystem:

   $filesystem->write('file.txt', 'Hello, World!');
   $contents = $filesystem->read('file.txt');