https://github.com/unisharp/s3-presigned
An AWS S3 package for pre-signed upload purpose in Laravel and PHP.
https://github.com/unisharp/s3-presigned
Last synced: 8 months ago
JSON representation
An AWS S3 package for pre-signed upload purpose in Laravel and PHP.
- Host: GitHub
- URL: https://github.com/unisharp/s3-presigned
- Owner: UniSharp
- License: mit
- Created: 2017-10-26T05:06:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-25T12:26:33.000Z (over 6 years ago)
- Last Synced: 2025-07-28T21:47:01.902Z (11 months ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 14
- Watchers: 11
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AWS S3 Presigned SDK
==========
[](https://packagist.org/packages/unisharp/s3-presigned)
## Approach
Traditionally to upload a file from users to a private S3 bucket needs two internet connections. One is from client to your own server, and the other is from your server to S3 bucket. Using pre-signed upload can solve this problem. Your server issues pre-signed upload url for client to upload in advance, and the client can upload his file to S3 bucket directly within an authorized time period. This package wraps S3 pre-signed api for PHP and Laravel.
## Installation
```
composer require unisharp/s3-presigned
```
## Laravel 5
### Setup
Add ServiceProvider and Facade in `app/config/app.php`.
```
Unisharp\S3\Presigned\S3PresignedServiceProvider::class,
```
```
'S3Presigned' => Unisharp\S3\Presigned\Facades\S3Presigned::class,
```
> It supports package discovery for Laravel 5.5.
### Configuration
Add settings to **.env** file.
```
// required
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_S3_BUCKET=
// optional
AWS_REGION=ap-northeast-1
AWS_VERSION=latest
AWS_S3_PREFIX=
```
## APIs
```php
/*
* @return string
*/
public function getSimpleUploadUrl($key, $minutes = 10, array $options = [], $guzzle = false)
```
* $key: your s3 file key, a prefix will be prepended automatically.
* $minutes: expire time for the pre-signed url.
* $options: see [AWS docs](http://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#putobject) to find more.
* $guzzle: set true if you want to get a guzzle instance instead of string.
```php
/*
* @return array('endpoint', 'inputs')
*/
public function getUploadForm($minutes = 10, array $policies = [], array $defaults = [])
```
* $minutes: expire time for the pre-signed url.
* $policies: see [AWS docs](http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-post-example.html) to find more.
* $defaults: default key-values you want to add to form inputs.
> for more detail, please see: [AWS docs](https://aws.amazon.com/tw/articles/browser-uploads-to-s3-using-html-post-forms)
```php
/*
* @return array
*/
public function listObjects($directory = '', $recursive = false)
```
```php
/*
* @return boolean
*/
public function deleteObject($key)
```
```php
/*
* @return string
*/
public function getBaseUri()
```
```php
/*
* @return this
*/
public function setPrefix($prefix)
```
```php
/*
* @return string
*/
public function getPrefix()
```
```php
/*
* @return this
*/
public function setBucket($bucket)
```
```php
/*
* @return string
*/
public function getBucket()
```
```php
/*
* @return Aws\S3\S3Client
*/
public function getClient()
```