PHP Classes

AWS Bucket PHP S3 Client: Perform common operations with Amazon S3

Recommend this page to a friend!
  Info   View files Example   View files View files (15)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2023-11-30 (6 months ago) RSS 2.0 feedNot enough user ratingsTotal: 35 All time: 10,963 This week: 80Up
Version License PHP version Categories
aws-bucket-php-lib 7.0.0Custom (specified...7Files and Folders, Web services, PHP 7
Description 

Author

This package can perform everyday operations with Amazon S3.

It uses the Amazon S3 client library to perform several operations with data stored in Amazon S3 buckets.

Currently, it can:

- Check if there is a file with a given name in a bucket

- Store a file with a given name in a bucket

- List files in a given bucket

- Delete a file with a given name in a bucket

Picture of Leonardo Di Sarli
  Performance   Level  
Name: Leonardo Di Sarli <contact>
Classes: 11 packages by
Country: Brazil Brazil
Age: ???
All time rank: 3918315 in Brazil Brazil
Week rank: 89 Up4 in Brazil Brazil Up
Innovation award
Innovation award
Nominee: 5x

Winner: 2x

Example

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use
AwsBucket\AwsBucket;

$config = [
  
'credentials' => [
      
'key' => '', //you must put your aws iam key here
      
'secret' => '', //you must put your aws iam secret here
  
],
  
'version' => 'latest',
  
'region' => 'us-east-2',
];

$awsBucket = new AwsBucket($config);

$bucket = 'not-empty-test-bucket';
$content = 'this is your file content';
$name = 'sample';
$extension = 'txt';

$putFile = $awsBucket->putFile(
   
$bucket,
   
$content,
   
$name,
   
$extension
);
print_r($putFile);
echo
PHP_EOL;

sleep(3);

$listFiles = $awsBucket->listFiles(
   
$bucket
);
print_r($listFiles);


Details

AWS Bucket PHP

Latest Version codecov CI Build Downloads Old Downloads PRs Welcome Packagist License (custom server)

PHP library to connect to and use AWS S3 Bucket.

Installation

Release 7.0.0 Requires PHP 8.3

Release 6.0.0 Requires PHP 8.2

Release 5.0.0 Requires PHP 8.1

Release 4.0.0 Requires PHP 7.4

Release 3.0.0 Requires PHP 7.3

Release 2.0.0 Requires PHP 7.2

Release 1.0.0 Requires PHP 7.1

The recommended way to install is through Composer.

composer require not-empty/aws-bucket-php-lib

Usage

Putting a file

use AwsBucket\AwsBucket;
$config = [
   'credentials' => [
       'key' => '', //you must put your aws iam key here
       'secret' => '', //you must put your aws iam secret here
   ],
   'version' => 'latest',
   'region' => 'us-east-1', //you must put your bucket region here
];
$awsBucket = new AwsBucket($config);
$bucket = 'my-bucket'; //you must put your bucket name here
$content = 'this is your file content';
$name = 'sample';
$extension = 'txt';
$putFile = $awsBucket->putFile(
    $bucket,
    $content,
    $name,
    $extension
);
var_dump($putFile);

Listing files

$listFiles = $awsBucket->listFiles(
    $bucket
);
var_dump($listFiles);

If you getting 403 or 400 erros, you must configure your bucket permitions, in AWS console to allow the files uploads.

if you want an environment to run or test it, you can build and install dependences like this

docker build --build-arg PHP_VERSION=8.3-rc-cli -t not-empty/aws-bucket-php-lib:php83 -f contrib/Dockerfile .

Access the container

docker run -v ${PWD}/:/var/www/html -it not-empty/aws-bucket-php-lib:php83 bash

Verify if all dependencies is installed

composer install --no-dev --prefer-dist

put your credentials, region and name of bucket in sample file sample/aws-bucket-sample.php

...
$config = [
   'credentials' => [
       'key' => '', //you must put your aws iam key here
       'secret' => '', //you must put your aws iam secret here
   ],
   'version' => 'latest',
   'region' => 'us-east-1', //you must put your bucket region here
];
$bucket = 'my-bucket'; //you must put your bucket name here

and run

php sample/aws-bucket-sample.php

Development

Want to contribute? Great!

The project using a simple code. Make a change in your file and be careful with your updates! Any new code will only be accepted with all validations.

To ensure that the entire project is fine:

First you need to building a correct environment to install all dependences

docker build --build-arg PHP_VERSION=8.3-rc-cli -t not-empty/aws-bucket-php-lib:php83 -f contrib/Dockerfile .

Access the container

docker run -v ${PWD}/:/var/www/html -it not-empty/aws-bucket-php-lib:php83 bash

Install all dependences

composer install --dev --prefer-dist

Run all validations

composer check

Not Empty Foundation - Free codes, full minds


  Files folder image Files  
File Role Description
Files folder image.github (1 directory)
Files folder imagecontrib (4 files)
Files folder imagesample (1 file)
Files folder imagesrc (1 file)
Files folder imagetests (1 file)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpcs.xml Data Auxiliary data
Accessible without login Plain text file phpmd.xml Data Auxiliary data
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  .github  
File Role Description
Files folder imageworkflows (1 file)

  Files folder image Files  /  .github  /  workflows  
File Role Description
  Accessible without login Plain text file php.yml Data Auxiliary data

  Files folder image Files  /  contrib  
File Role Description
  Accessible without login Plain text file coverage-checker.php Example Example script
  Accessible without login Plain text file Dockerfile Data Auxiliary data
  Accessible without login Plain text file pre-commit Data Auxiliary data
  Accessible without login Plain text file setup.sh Data Auxiliary data

  Files folder image Files  /  sample  
File Role Description
  Accessible without login Plain text file aws-bucket-sample.php Example Example script

  Files folder image Files  /  src  
File Role Description
  Plain text file AwsBucket.php Class Class source

  Files folder image Files  /  tests  
File Role Description
  Plain text file AwsBucketTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:35
This week:0
All time:10,963
This week:80Up