php tus aws s3

Project not maintained

This project is not being maintained. Please use the original project ankitpokhrel/tus-php to ensure regular updates. Here are some notes about using the project with AWS S3.

PHP TUS protocol server for Amazon Web Service S3

Simple, light, minimum TUS server connected with AWS S3. Based on ankitpokhrel/tus-php.

Versions

If you are using Symfony, check the table below.

Symfony Version	php-tus-aws-s3 version
^4.3	~1.0
^5.0 or ^6.0	~1.1

Installation

Composer

composer require rafaeltovar/php-tus-aws-s3:~1.x predis/predis

Features

• Implements TUS protocol server for upload files
• AWS S3 multiparts uploads
• Uploads directly to AWS S3
• Use Redis like data cache with Predis
• Flysystem compatible

Documentation

Understanding TusPhpS3Server class constructor

use TusPhpTusServer as TusServer;

class Server
extends TusServer
{
    //...
    public function __construct(
        TusPhpCacheAbstractCache $cache,
        LeagueFlysystemAwsS3v3AwsS3Adapter $storage,
        TusPhpS3HttpRequest $request,
        $excludeAttrApiPath = [],
        $forceLocationSSL = true)
        {
            //...
        }
}

Property	Type	Details
$cache	TusPhpCacheAbstractCache	We are using TusPhpS3CachePredisCache for Predis client.
$storage	LeagueFlysystemAwsS3v3AwsS3Adapter	This adapter contains the AWS S3 Client.
$request	TusPhps3HttpRequest	This object contain a SymfonyComponentHttpFoundationRequest.
$excludeAttrApiPath	array	Exclude some parts from Api path for create a real Api Base Path for TUS Server. For example, if my Api base path is https://example.com/uploads but my upload PATCH is http://example.com/uploads/{id} We need exclude ['id'].
$forceLocationSSL	boolean	Force location header property to https.

TUS Routes

/**
 * Create new upload
 * or get server configuration
 **/
$routes->add('uploads', '/api/uploads')
        ->controller([UploadController::class, 'upload'])
        ->methods([POST, OPTIONS])

/**
 * Upload files
 * or delete uploads
 **/
$routes->add('uploads', '/api/uploads/{id}')
        ->controller([UploadController::class, 'upload'])
        ->methods([PATCH, DELETE])

Running TUS Server

use TusPhpS3;

use AwsS3S3Client;
use LeagueFlysystemAwsS3v3AwsS3Adapter;

use SymfonyComponentHttpFoundationRequest as HttpRequest;

class UploadController
{
    public function upload()
    {

        // redis connection
        $predis = new PredisClient('tcp://10.0.0.1:6379');


        // AWS S3 Client
        $S3client = new S3Client([
            'credentials' => [
                'key'    => 'your-key',
                'secret' => 'your-secret',
            ],
            'region' => 'your-region',
            'version' => 'latest|version',
        ]);

        $server = new TusPhpS3Server(
            new TusPhpS3CachePredisCache($predis),
            new AwsS3Adapter($S3client, 'your-bucket-name', 'optional/path/prefix'),
            new TusPhpS3HttpRequest(HttpRequest::createFromGlobals()),
            ['id'],
            true
        );

        return $server->serve(); // return an TusPhpS3HttpResponse
    }
}