Retrieving files in Laravel - Mini Project: Build & Apply

Retrieving Files in Laravel

📖 Scenario: You are building a simple Laravel application that needs to retrieve and display files stored in the storage/app/public directory. This is a common task when you want to show images or documents uploaded by users.

🎯 Goal: Build a Laravel controller method that retrieves a file from the storage and returns it as a response so it can be displayed or downloaded by the user.

📋 What You'll Learn

Create a route to handle file retrieval requests

Create a controller method named showFile that accepts a filename parameter

Use Laravel's Storage facade to check if the file exists in the public disk

Return the file as a response using Laravel's response()->file() method

Return a 404 error if the file does not exist

💡 Why This Matters

🌍 Real World

Many web applications need to serve user-uploaded files such as images, PDFs, or documents. This project shows how to safely retrieve and serve those files using Laravel's built-in tools.

💼 Career

Understanding how to retrieve and serve files is essential for backend developers working with Laravel. It is a common task in building content management systems, e-commerce sites, and user profile features.

1

Set up the route for file retrieval

Create a route in routes/web.php that listens for GET requests at /files/{filename} and uses the FileController and its showFile method.

Laravel

// Add the route for file retrieval here
# Your code here

Need a hint?

Use Route::get with the URL pattern /files/{filename} and specify the controller and method as an array.

2

Create the controller method to retrieve the file

In app/Http/Controllers/FileController.php, create a public method named showFile that accepts a parameter $filename. This method will handle the file retrieval logic.

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class FileController extends Controller
{
    // Create the showFile method below
    # Your code here
}

Need a hint?

Define a public method named showFile that takes $filename as a parameter.

3

Check if the file exists using Storage facade

Inside the showFile method, use Storage::disk('public')->exists($filename) to check if the file exists in the public disk. If the file does not exist, return abort(404).

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;
use Symfony\Component\HttpFoundation\Response;

class FileController extends Controller
{
    public function showFile(string $filename): Response
    {
        // Check if file exists
        # Your code here
    }
}

Need a hint?

Use Storage::disk('public')->exists($filename) to check file existence and abort(404) to return a not found error.

4

Return the file as a response

Complete the showFile method by returning the file using response()->file() with the full path from Storage::disk('public')->path($filename).

Laravel

exists($filename)) {
            abort(404);
        }
        // Return the file as response
        # Your code here
    }
}

Need a hint?

Use response()->file() with the full file path from Storage::disk('public')->path($filename) to return the file.