README

This is a Laravel package that handles and make easy the upload, overwrite, delete, cdn purge of files and directories on AWS S3 like cloud storages.

It supports a form uploaded file (UploadedFile) or a base64 file string

Support

At the actual version it support only Digital Ocean SPACES cloud storage.

In the future I will add new cloud storages support or accept pull requests.

Configuration

You should install it via composer:

composer require andreinocenti/laravel-file-s3-like

This package use the Laravel Illuminate\Support\Facades\Storage facade to handle the files.

So you must config the filesystem AWS like disk that you want to use.

Below the optimal config to be used

config/filesystem.php

'spaces-disk' => [
    'driver' => 's3',
    'key' => env('SPACES_ACCESS_KEY_ID'),
    'secret' => env('SPACES_SECRET_ACCESS_KEY'),
    'region' => env('SPACES_DEFAULT_REGION'),
    'bucket' => env('SPACES_BUCKET'),
    'url' => env('SPACES_URL'),
    'endpoint' => env('SPACES_ENDPOINT'),
    'folder' => env('SPACES_FOLDER'), // This will be the default directory used. It can be empty, if so the default directory will be the bucket root
    'cdn_endpoint' => env('SPACES_CDN_ENDPOINT'), // at Digital Ocean Spaces the CDN is auto set when a file is uploaded. So set here the cdn_endpoint (edge)
    'use_path_style_endpoint' => env('SPACES_USE_PATH_STYLE_ENDPOINT', false),
    'throw' => false,
],

Usage

You can use the FileS3LikeSpaces facade

use AndreInocenti\LaravelFileS3Like\Facades\FileS3LikeSpaces;

FileS3LikeSpaces::disk('spaces-disk')
    ->directory('images')
    ->upload($file, 'new-test');

Or you can use the FileS3Like Facade, if you do you must set the repository() you want to use.

use AndreInocenti\LaravelFileS3Like\Facades\FileS3Like;

FileS3Like::repository('spaces')
    ->disk('spaces-disk')
    ->directory('images')
    ->upload($file, 'new-test');

Methods / Accessors

FileS3Like and its repositories (Eg: FileS3LikeSpaces)

Method	Description
repository(string $repository): self	The repository is the s3 like service that this package support, that you want to use. Eg.: spaces. Check the Support list
disk(string $disk): self	Sets the filesystem disk that the Storage facade will use to handle the files on the cloud storage
directory(string $directory): self	The directory in the cloud storage bucket that will be handled. Important: It will concat with the folder configurated in the file filesystem. The folder configuration, is good to have always the same base directory configured, instead of the "directory()" that can change anytime EG.: if folder was configured to be "public", and the directory "images", the final path will be `public/images`.
upload(UploadedFile\|string $file, ?string $filename = null): DiskFile	Upload the file to the storage. If $filename is empty, the name of the file will be aUUID hash.
save(string $repository): DiskFile	Upload and update the file on the space disk, purge cache and return the file url. If a file with the same name already exists, it will be overwritten and the cache will be purged. If it is a new file, it will only be uploaded. If $filename is empty, the name of the file will be aUUID hash.
purge(string $filepath): self	Purges a CDN cache of a file. $filename - Inform the file name and path of the file to be purged.
delete(string $filepath): self	Delete a file from the cloud storage disk
deleteDirectory(string $filepath): self	Recursively delete a directory from the cloud storage disk
directories(string $filepath): array	List directories in the directory set
files(string $filepath): array	List files in the directory set

DiskFile

DiskFile is a DTO class that is created and delivered when the functions upload or save are called. The class contain accessors that returns some file data.

Method	Description
getFilepath(): string	Return the file, filepath without the url. Eg: "some/path/to/file.jpg".
getFilename(): string	Return the file name. Eg: "file.jpg".
getUrl(): string	Returns the full file url. Eg: "https://somedomain.com/some/path/to/file.jpg".
getExtension(): string	Returns the file extension. Eg: "jpg".

andreinocenti / laravel-file-s3-like

Maintainers

Details