README

Amazon Simple Storage Service, or S3 in short, is a service to store and retrieve any amount of data, at any time, from anywhere on the web.

See table of contents.

Installation

composer require proximify/s3

API

Check out the API documentation.

Example

Create a bucket

$bucketName = 'yourUniqueBucketName';
$credetials = [
    'key' => 'API_KEY',
    'secret' => 'API_SECRET'
];

S3::init($credentials);
$result = S3::create($bucketName);

Options

The table below shows all the available options accepted by init function.

Program	Description
`region`	Bucket region. See all the available regions here

Testing

Go to dev directory and type:

../vendor/bin/phpunit tests/

Note: You will need AWS credentials to run the test suit. To get yours, follow the steps here.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to and actually do, grant us the rights to use your contribution. For details, visit our Contributor License Agreement.

When you submit a pull request, we will determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided. You will only need to do this once across all repositories using our CLA.

This project has adopted the Proximify Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact support@proximify.com with any additional questions or comments.

License

Licensed under the GNU General Public License Version 2 license.

Software component is made by Proximify. We invite the community to participate.

proximify / s3

Maintainers

Details