Laravel Supabase Flysystem

Installation

composer require alies-dev/laravel-supabase-flysystem

Configuration

Environment Variables

SUPABASE_STORAGE_KEY=your-supabase-key
SUPABASE_STORAGE_BUCKET=your-bucket-name
SUPABASE_STORAGE_ENDPOINT=https://your-project-ref.supabase.co

Full Configuration Options

'supabase' => [
 'driver' => 'supabase',
 'key' => env('SUPABASE_STORAGE_KEY'),
 'bucket' => env('SUPABASE_STORAGE_BUCKET'),
 'endpoint' => env('SUPABASE_STORAGE_ENDPOINT'),
 // Optional configuration
 'url' => env('SUPABASE_STORAGE_URL'), // Custom URL for public access
 'public' => env('SUPABASE_STORAGE_PUBLIC', false), // Set to true for public buckets
 'signed_url_ttl,' => 60 * 60 * 24, // Default TTL for signed URLs (1 day)
 'url_options' => [], // Default URL generation options supported by Supabase Storage (download, transform)
],

Usage

Basic Operations

// Store a file
Storage::disk('supabase')->put('path/to/file.jpg', $contents);
// Check if a file exists
if (Storage::disk('supabase')->exists('path/to/file.jpg')) {
 // File exists
}
// Get file contents
$contents = Storage::disk('supabase')->get('path/to/file.jpg');
// Delete a file
Storage::disk('supabase')->delete('path/to/file.jpg');
// Copy a file
Storage::disk('supabase')->copy('original.jpg', 'copy.jpg');
// Move/rename a file
Storage::disk('supabase')->move('old-name.jpg', 'new-name.jpg');

URL Generation

// Get a URL (signed or public based on configuration)
$url = Storage::disk('supabase')->url('path/to/file.jpg');
// Get a signed URL with default options
$signedUrl = Storage::disk('supabase')->temporaryUrl(
 'path/to/file.jpg',
 now()->addHour()
);
// Get a signed URL with custom transform options
$transformedUrl = Storage::disk('supabase')->url('path/to/file.jpg', [
 'transform' => [
 'width' => 100,
 'height' => 100,
 'format' => 'webp',
 ]
]);
// Get a signed URL with a download option
$downloadUrl = Storage::disk('supabase')->url('path/to/file.jpg', [
 'download' => true,
]);

Directory Operations

// Create a directory
Storage::disk('supabase')->makeDirectory('path/to/directory');
// Delete a directory and all its contents
Storage::disk('supabase')->deleteDirectory('path/to/directory');
// List contents of a directory
$files = Storage::disk('supabase')->files('path/to/directory');
$directories = Storage::disk('supabase')->directories('path/to/directory');
// List all files recursively
$allFiles = Storage::disk('supabase')->allFiles('path/to/directory');

Metadata Operations

// Get file size
$size = Storage::disk('supabase')->size('path/to/file.jpg');
// Get file mime type
$mimeType = Storage::disk('supabase')->mimeType('path/to/file.jpg');
// Get file last modified timestamp
$lastModified = Storage::disk('supabase')->lastModified('path/to/file.jpg');

Advanced Usage

Image Transformations

$url = Storage::disk('supabase')->url('path/to/image.jpg', [
 'transform' => [
 'width' => 300,
 'height' => 200,
 'resize' => 'cover', // 'cover', 'contain', or 'fill'
 'format' => 'webp', // 'webp', 'png', 'jpg', etc.
 'quality' => 80, // 1-100
 ]
]);

Temporary URLs

$url = Storage::disk('supabase')->temporaryUrl(
 'path/to/file.jpg',
 now()->addMinutes(30), // Expires in 30 minutes
 [
 'transform' => [
 'width' => 100,
 'height' => 100,
 ],
 'download' => true, // Force download
 ]
);

Testing

composer test

Changelog

License

Credits