mafordham/aws-s3

A simple, bare-bones S3 helper class

v1.0.0 2026-02-07 18:57 UTC

MIT

README

A lightweight PHP class to interact directly with Amazon S3. No AWS SDK, no AWS CLI — just PHP communicating directly with the AWS REST API.

This class supports common S3 operations like uploading, downloading, listing, and deleting objects. It also supports Composer autoloading for easy integration into modern PHP projects.

Features

• Direct communication with AWS S3 REST API
• No external libraries required (but supports Composer)
• Simple, easy-to-use methods
• Secure AWS request signing

Installation

You can include the class manually:

require_once 'src/AwsS3.php';

Or use Composer autoloading by adding the src/ directory to your composer.json:

{
  "autoload": {
    "psr-4": {
      "MaFordham\\AwsS3\\": "src/"
    }
  }
}

Then run:

composer dump-autoload

and load the class using PSR-4 autoloading.

Configuration

Create a new instance of AwsS3 with your AWS credentials and region:

use YourNamespace\\AwsS3\\AwsS3;

$s3 = new AwsS3([
    'access_key' => 'YOUR_AWS_ACCESS_KEY',
    'secret_key' => 'YOUR_AWS_SECRET_KEY',
    'region'     => 'us-east-1',
]);

• ⚠️ Keep your AWS credentials secure and never commit them to source control.

Usage

List Buckets

$objects = $s3->objectsList();
print_r($objects);

Upload a File

$s3->objectPut('my-bucket', '/remote/path/file.txt', 'image/png', base64_decode('iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO/tO7sAAAAASUVORK5CYII='));

Download a File

$s3->objectGet('my-bucket', '/remote/path/file.txt');

Delete an Object

$s3->objectDelete('my-bucket', '/remote/path/file.txt');

Public URL for an Object

$s3->objectUrl('my-bucket', '/remote/path/file.txt');

Security

• Always store your AWS credentials securely
• Consider using environment variables or a .env file
• Do not commit secrets into the repository

Contributing

Pull requests and issues are welcome. Please follow the standard PR workflow.

License

This project is licensed under the MIT License.