Filesystem configuration in Laravel - Step-by-Step Execution

Concept Flow - Filesystem configuration

Start Laravel App

↓

Read config/filesystems.php

↓

Load default disk setting

↓

Initialize disk driver

↓

Use disk for file operations

↓

Read/Write/Delete files

↓

Return operation result

Laravel reads the filesystem config, loads the chosen disk driver, then uses it to perform file operations.

Execution Sample

Laravel

use Illuminate\Support\Facades\Storage;

Storage::disk('local')->put('file.txt', 'Hello Laravel');
$content = Storage::disk('local')->get('file.txt');

This code saves a file named 'file.txt' with content, then reads it back from the local disk.

Execution Table

Step	Action	Disk Used	File	Content	Result
1	Call Storage::disk('local')	local	-	-	Disk instance created
2	Put 'Hello Laravel' into 'file.txt'	local	file.txt	Hello Laravel	File saved
3	Get content of 'file.txt'	local	file.txt	Hello Laravel	Content returned: 'Hello Laravel'
4	End of operations	-	-	-	Process complete

💡 All file operations completed successfully using the 'local' disk.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
disk	null	local disk instance	local disk instance	local disk instance
file	null	file.txt	file.txt	file.txt
content	null	null	Hello Laravel	Hello Laravel

Key Moments - 2 Insights

Why do we specify the disk name like 'local' in Storage::disk('local')?

Because Laravel supports multiple disks configured in config/filesystems.php, specifying 'local' tells Laravel which disk driver and path to use. See execution_table step 1.

What happens if the file does not exist when calling get()?

Laravel throws an exception or returns false depending on method used. In our example, the file exists because we saved it in step 2, so get() returns content as shown in step 3.

Visual Quiz - 3 Questions

Look at the execution table, what is the content variable after step 3?

A "Hello Laravel"

B null

C "file.txt"

D "local"

💡 Hint

Check the 'content' column in execution_table row for step 3.

At which step is the file 'file.txt' created and saved?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the 'Action' and 'Result' columns in execution_table.

If we change Storage::disk('local') to Storage::disk('s3'), what changes in the execution?

A The content saved changes to uppercase.

B The file name changes automatically.

C The disk used changes to 's3' and files are stored on Amazon S3 instead of local disk.

D No change; 'local' and 's3' are the same.

💡 Hint

Refer to variable_tracker 'disk' variable and execution_table step 1.

Concept Snapshot

Laravel Filesystem Configuration:
- Configure disks in config/filesystems.php
- Use Storage::disk('name') to select disk
- Call put(), get(), delete() on disk instance
- Supports local, s3, ftp, and more
- Allows easy file storage abstraction

Full Transcript

Laravel filesystem configuration lets you define multiple storage disks in the config/filesystems.php file. When your app runs, Laravel reads this config and loads the disk driver you specify, like 'local' for local storage or 's3' for Amazon S3. You use the Storage facade with disk('name') to pick which disk to use. Then you can call methods like put() to save files and get() to read files. In the example, Storage::disk('local')->put('file.txt', 'Hello Laravel') saves a file locally, and get() reads it back. This abstraction helps you switch storage easily without changing your code logic. The execution table shows each step: creating disk instance, saving file, reading file, and finishing. Variables track the disk used, file name, and content over time. Common confusions include why specify disk name and what happens if file missing. Changing disk name changes storage location. This makes file handling simple and flexible in Laravel.

Practice

1. What is the purpose of the default key in Laravel's config/filesystems.php file?

easy

A. It sets the default storage disk Laravel uses for file operations.

B. It defines the maximum file size allowed for uploads.

C. It specifies the encryption method for stored files.

D. It lists all available storage disks in the application.

Solution

1. Step 1: Understand the role of the default key

   The default key in config/filesystems.php tells Laravel which disk to use when no specific disk is mentioned.

2. Step 2: Compare with other options

   Options A, B, and C describe unrelated settings. Only "It sets the default storage disk Laravel uses for file operations." correctly describes the default disk setting.

3. Final Answer:

   It sets the default storage disk Laravel uses for file operations. -> Option A

4. Quick Check:

   Default disk = storage location [OK]

Hint: Default disk means where files go if no disk specified [OK]

Common Mistakes:

• Confusing default disk with file size limits
• Thinking default sets encryption
• Assuming default lists all disks

2. Which of the following is the correct syntax to define a local disk in config/filesystems.php?

easy

A. 'local' => ['driver' => 'ftp', 'root' => storage_path('app')],

B. 'local' => ['driver' => 'local', 'root' => storage_path('app')],

C. 'local' => ['driver' => 's3', 'root' => storage_path('app')],

D. 'local' => ['driver' => 'local', 'root' => public_path('app')],

Solution

1. Step 1: Identify the correct driver for local disk

   The local disk uses the 'local' driver, so options with 'ftp' or 's3' are incorrect.

2. Step 2: Check the root path for local storage

   The root path for local disk is usually storage_path('app'), not public_path('app').

3. Final Answer:

   'local' => ['driver' => 'local', 'root' => storage_path('app')], -> Option B

4. Quick Check:

   Local driver + storage_path = correct syntax [OK]

Hint: Local disk uses 'local' driver and storage_path root [OK]

Common Mistakes:

• Using wrong driver like 'ftp' or 's3' for local disk
• Setting root to public_path instead of storage_path
• Mixing driver and root paths

3. Given this config/filesystems.php snippet:

'disks' => [
    's3' => [
        'driver' => 's3',
        'key' => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
        'region' => env('AWS_DEFAULT_REGION'),
        'bucket' => env('AWS_BUCKET'),
    ],
],
'default' => 's3',

What happens when you call Storage::put('file.txt', 'Hello') in your app?

medium

A. An error occurs because the local disk is not set.

B. The file is saved to the local storage folder.

C. The file is saved to the configured Amazon S3 bucket.

D. The file is saved to a temporary directory.

Solution

1. Step 1: Identify the default disk

   The default disk is set to 's3', so all Storage calls use the S3 disk unless specified otherwise.

2. Step 2: Understand Storage::put behavior

   Calling Storage::put saves the file to the default disk, which is the S3 bucket configured.

3. Final Answer:

   The file is saved to the configured Amazon S3 bucket. -> Option C

4. Quick Check:

   Default disk 's3' means files go to S3 [OK]

Hint: Default disk controls Storage::put location [OK]

Common Mistakes:

• Assuming file saves locally despite default 's3'
• Thinking missing local disk causes error
• Confusing temporary directory with storage

4. You added a new disk in config/filesystems.php but get an error when using it. Which of these is the most likely cause?

medium

A. You forgot to run php artisan config:cache after changing the config.

B. You used the wrong PHP version for Laravel.

C. You did not install the Laravel UI package.

D. You set the disk name to 'default' instead of a unique name.

Solution

1. Step 1: Understand Laravel config caching

   Laravel caches config files for performance. Changes in config files require clearing or caching again.

2. Step 2: Identify the common fix

   Running php artisan config:cache refreshes the cached config and applies new disk settings.

3. Final Answer:

   You forgot to run php artisan config:cache after changing the config. -> Option A

4. Quick Check:

   Config cache must refresh after edits [OK]

Hint: Run config:cache after config changes [OK]

Common Mistakes:

• Ignoring config cache after edits
• Blaming PHP version for config errors
• Confusing unrelated packages with filesystem config

5. You want to configure a new disk in config/filesystems.php that stores files on a remote FTP server. Which of these is the correct minimal configuration?

hard

A. 'ftp' => [ 'driver' => 's3', 'key' => env('FTP_KEY'), 'secret' => env('FTP_SECRET') ],

B. 'ftp' => [ 'driver' => 'local', 'root' => env('FTP_HOST') ],

C. 'ftp' => [ 'driver' => 'ftp', 'bucket' => env('FTP_BUCKET') ],

D. 'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD') ],

Solution

1. Step 1: Identify the correct driver for FTP

   The driver must be 'ftp' to connect to an FTP server, so options with 'local' or 's3' are incorrect.

2. Step 2: Check required connection details

   FTP requires host, username, and password. 'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD') ], includes these minimal required keys.

3. Final Answer:

   'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD') ], -> Option D

4. Quick Check:

   FTP driver + host, username, password needed [OK]

Hint: FTP disk needs driver 'ftp' and host, user, password [OK]

Common Mistakes:

• Using wrong driver like 'local' or 's3' for FTP
• Missing required host or credentials
• Confusing bucket with FTP config