S3 cloud storage integration in Laravel

Introduction

S3 cloud storage lets you save files safely on the internet instead of your computer. Laravel helps you connect to S3 easily to store and get files.

You want to save user-uploaded photos or documents online.

You need to share files across different servers or apps.

You want to keep backups of important files safely.

You want to serve files fast to users worldwide.

You want to avoid filling your local server storage.

Syntax

Laravel

use Illuminate\Support\Facades\Storage;

// Save a file to S3
Storage::disk('s3')->put('folder/filename.txt', 'File content');

// Get a file from S3
$content = Storage::disk('s3')->get('folder/filename.txt');

// Delete a file from S3
Storage::disk('s3')->delete('folder/filename.txt');

Use Storage::disk('s3') to work with S3 storage.

Make sure your S3 credentials are set in .env and config/filesystems.php.

Examples

Save a photo file to the 'photos' folder on S3.

Laravel

Storage::disk('s3')->put('photos/pic1.jpg', $fileContents);

Retrieve the contents of a PDF report from S3.

Laravel

$contents = Storage::disk('s3')->get('documents/report.pdf');

Remove an old file from S3 storage.

Laravel

Storage::disk('s3')->delete('old/file.txt');

Sample Program

This Laravel controller lets users upload files to S3 and download them back. It checks if the file exists before downloading.

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;

class FileController extends Controller
{
    public function upload(Request $request)
    {
        $request->validate([
            'file' => 'required|file',
        ]);

        $path = Storage::disk('s3')->putFile('uploads', $request->file('file'));

        return response()->json(['message' => 'File uploaded!', 'path' => $path]);
    }

    public function download($filename)
    {
        if (!Storage::disk('s3')->exists('uploads/' . $filename)) {
            return response()->json(['message' => 'File not found'], 404);
        }

        $file = Storage::disk('s3')->get('uploads/' . $filename);
        $type = Storage::disk('s3')->mimeType('uploads/' . $filename);

        return response($file, 200)->header('Content-Type', $type);
    }
}

Important Notes

Set your AWS keys in the .env file: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION, and AWS_BUCKET.

Run php artisan config:cache after changing config files to apply updates.

Use Laravel's built-in validation to check file types and sizes before uploading.

Summary

S3 integration in Laravel helps store files safely online.

Use Storage::disk('s3') to save, get, or delete files.

Always set AWS credentials and bucket info in your environment settings.

Practice

1. What is the main purpose of integrating S3 cloud storage in a Laravel application?

easy

A. To speed up database queries

B. To store files safely online and access them via Laravel

C. To replace Laravel's routing system

D. To manage user authentication

Solution

1. Step 1: Understand S3 integration role

   S3 cloud storage is used to store files remotely and securely in the cloud.

2. Step 2: Connect with Laravel usage

   Laravel uses Storage::disk('s3') to interact with these files, enabling safe online storage.

3. Final Answer:

   To store files safely online and access them via Laravel -> Option B

4. Quick Check:

   S3 integration = safe online file storage [OK]

Hint: Remember S3 is for file storage, not database or routing [OK]

Common Mistakes:

• Confusing S3 with database optimization
• Thinking S3 replaces routing or authentication
• Assuming S3 is for local file storage only

2. Which of the following is the correct Laravel syntax to store a file named 'photo.jpg' on the S3 disk?

easy

A. Storage::put('s3', 'photo.jpg', $fileContent);

B. Storage::disk('photo.jpg')->put('s3', $fileContent);

C. Storage::s3()->store('photo.jpg', $fileContent);

D. Storage::disk('s3')->put('photo.jpg', $fileContent);

Solution

1. Step 1: Identify correct method chaining

   Laravel uses Storage::disk('s3') to select the S3 disk, then put() to save files.

2. Step 2: Match parameters order

   The put() method takes the filename first, then the file content.

3. Final Answer:

   Storage::disk('s3')->put('photo.jpg', $fileContent); -> Option D

4. Quick Check:

   Correct syntax = Storage::disk('s3')->put(filename, content) [OK]

Hint: Use disk('s3') before put() to target S3 storage [OK]

Common Mistakes:

• Swapping parameters in put() method
• Using Storage::put() without disk() for S3
• Calling non-existent methods like s3()

3. Given this Laravel code snippet:

Storage::disk('s3')->put('docs/report.txt', 'Annual Report');
$exists = Storage::disk('s3')->exists('docs/report.txt');
return $exists ? 'File found' : 'File missing';

What will be the output?

medium

A. File found

B. Syntax error

C. File missing

D. Runtime exception

Solution

1. Step 1: Store file on S3 disk

   The put() method saves 'docs/report.txt' with content 'Annual Report'.

2. Step 2: Check file existence

   The exists() method checks if the file is present, which returns true after put().

3. Final Answer:

   File found -> Option A

4. Quick Check:

   File saved and exists = 'File found' [OK]

Hint: put() then exists() returns true if file saved successfully [OK]

Common Mistakes:

• Assuming file doesn't exist immediately after put()
• Confusing method names like exist() instead of exists()
• Expecting syntax or runtime errors without cause

4. You wrote this code to delete a file from S3:

Storage::disk('s3')->delete('images/photo.png');

But the file is not deleted. What is the most likely cause?

medium

A. You must call Storage::delete() without disk() for S3

B. The delete() method requires a second parameter

C. AWS credentials or bucket name not set correctly in .env

D. Laravel does not support deleting files on S3

Solution

1. Step 1: Check AWS configuration

   Deleting files on S3 requires correct AWS keys and bucket info in environment settings.

2. Step 2: Verify method usage

   The delete() method needs only the filename; no second parameter is required.

3. Final Answer:

   AWS credentials or bucket name not set correctly in .env -> Option C

4. Quick Check:

   Missing AWS config = delete fails [OK]

Hint: Always verify AWS keys and bucket in .env before file ops [OK]

Common Mistakes:

• Adding extra parameters to delete() method
• Calling delete() without disk('s3') for S3 files
• Believing Laravel can't delete S3 files

5. You want to upload multiple files to S3 and then list all files in the 'uploads/' folder. Which Laravel code snippet correctly does this?

hard

A. foreach ($files as $file) { Storage::disk('s3')->put('uploads/'.$file->getClientOriginalName(), file_get_contents($file)); } $list = Storage::disk('s3')->files('uploads');

B. Storage::disk('s3')->putFiles('uploads', $files); $list = Storage::disk('s3')->allFiles('uploads');

C. foreach ($files as $file) { Storage::put('s3/uploads/'.$file, $file); } $list = Storage::disk('s3')->list('uploads');

D. Storage::disk('uploads')->put($files); $list = Storage::disk('s3')->files();

Solution

1. Step 1: Upload multiple files correctly

   Loop over each file, use Storage::disk('s3')->put() with correct path and file content.

2. Step 2: List files in 'uploads/' folder

   Use Storage::disk('s3')->files('uploads') to get all files in that folder.

3. Final Answer:

   foreach ($files as $file) { Storage::disk('s3')->put('uploads/'.$file->getClientOriginalName(), file_get_contents($file)); } $list = Storage::disk('s3')->files('uploads'); -> Option A

4. Quick Check:

   Loop put + files() list = correct multi-file S3 upload [OK]

Hint: Use loop with put() and files() to upload and list files [OK]

Common Mistakes:

• Using non-existent putFiles() method
• Wrong disk name or method for listing files
• Passing files array directly without looping