Environment configuration in Laravel - Mini Project: Build & Apply

Laravel Environment Configuration

📖 Scenario: You are building a Laravel application that needs to connect to a database and send emails. To keep your settings safe and flexible, you will use Laravel's environment configuration system.

🎯 Goal: Set up environment variables in Laravel to configure the database connection and mail settings. Then, access these variables in the Laravel configuration files.

📋 What You'll Learn

Create environment variables in the .env file for database and mail settings

Add a configuration variable in config/database.php to use the environment variables

Add a configuration variable in config/mail.php to use the environment variables

Ensure the Laravel app reads the environment variables correctly

💡 Why This Matters

🌍 Real World

Most Laravel applications use environment variables to keep sensitive data like passwords and API keys safe and to easily switch settings between development and production.

💼 Career

Understanding environment configuration is essential for Laravel developers to build secure, maintainable, and flexible applications.

1

Create environment variables in .env

Open the .env file and add these exact lines to set the database and mail environment variables: DB_CONNECTION=mysql, DB_HOST=127.0.0.1, DB_PORT=3306, DB_DATABASE=laravel_db, DB_USERNAME=root, DB_PASSWORD=secret, MAIL_MAILER=smtp, MAIL_HOST=smtp.mailtrap.io, MAIL_PORT=2525, MAIL_USERNAME=null, MAIL_PASSWORD=null, MAIL_ENCRYPTION=null.

Laravel

# Add the exact environment variables for database and mail settings here
# Your code here

Hint

The .env file holds key-value pairs for configuration. Add each variable on its own line.

2

Configure database settings in config/database.php

Open config/database.php and set the 'mysql' connection array to use the environment variables by adding these lines: 'driver' => env('DB_CONNECTION', 'mysql'), 'host' => env('DB_HOST', '127.0.0.1'), 'port' => env('DB_PORT', '3306'), 'database' => env('DB_DATABASE', 'forge'), 'username' => env('DB_USERNAME', 'forge'), 'password' => env('DB_PASSWORD', '').

Laravel

 [
        'mysql' => [
            // Add environment variable usage here
            // Your code here
        ],
    ],
];

Hint

Use the env() helper function to read environment variables with a default fallback.

3

Configure mail settings in config/mail.php

Open config/mail.php and set the mail configuration array to use environment variables by adding these lines: 'mailer' => env('MAIL_MAILER', 'smtp'), 'host' => env('MAIL_HOST', 'smtp.mailtrap.io'), 'port' => env('MAIL_PORT', 2525), 'username' => env('MAIL_USERNAME'), 'password' => env('MAIL_PASSWORD'), 'encryption' => env('MAIL_ENCRYPTION').

Laravel

 env('MAIL_MAILER', 'smtp'),
    'host' => env('MAIL_HOST', 'smtp.mailtrap.io'),
    'port' => env('MAIL_PORT', 2525),
    'username' => env('MAIL_USERNAME'),
    'password' => env('MAIL_PASSWORD'),
    'encryption' => env('MAIL_ENCRYPTION'),
    // Your code here
];

Hint

Use the env() helper for mail settings just like for database settings.

4

Verify Laravel reads environment variables correctly

In routes/web.php, add a route /env-check that returns a JSON response with keys db_connection and mail_mailer set to env('DB_CONNECTION') and env('MAIL_MAILER') respectively.

Laravel

<?php

use Illuminate\Support\Facades\Route;

// Add a route to return environment variables as JSON
// Your code here

Hint

Use a closure route and response()->json() to return environment variables for testing.

Practice

1. What is the main purpose of the .env file in a Laravel project?

easy

A. To define routes and controllers

B. To write all application logic and functions

C. To store user data and session information

D. To store environment-specific configuration settings outside the code

Solution

1. Step 1: Understand the role of environment files

   The .env file is designed to keep configuration settings that can change between environments, like database credentials or API keys.

2. Step 2: Differentiate from other files

   Application logic, routes, and user data are handled elsewhere, not in .env.

3. Final Answer:

   To store environment-specific configuration settings outside the code -> Option D

4. Quick Check:

   Environment config = store settings outside code [OK]

Hint: Remember: .env holds settings, not code or data [OK]

Common Mistakes:

• Thinking .env contains code logic
• Confusing .env with database or session storage
• Assuming .env stores user data

2. Which of the following is the correct syntax to access an environment variable named APP_NAME in Laravel code?

easy

A. env('APP_NAME')

B. config('APP_NAME')

C. getenv('APP_NAME')

D. $_ENV['APP_NAME']

Solution

1. Step 1: Identify Laravel's helper function for env variables

   Laravel provides the env() helper to access environment variables directly.

2. Step 2: Compare other options

   config() accesses config files, getenv() is PHP native but less used in Laravel, and $_ENV is a PHP superglobal but not recommended.

3. Final Answer:

   env('APP_NAME') -> Option A

4. Quick Check:

   Use env() helper for .env variables [OK]

Hint: Use env('KEY') to get .env values in Laravel [OK]

Common Mistakes:

• Using config() instead of env() for .env variables
• Using PHP native getenv() without Laravel context
• Trying to access $_ENV directly

3. Given the following .env content:

APP_DEBUG=true
APP_NAME=MyApp

What will be the output of this Laravel code?

echo env('APP_DEBUG') ? 'Debug is ON' : 'Debug is OFF';

medium

A. Debug is ON

B. Debug is OFF

C. true

D. false

Solution

1. Step 1: Understand env() returns string values

   The env('APP_DEBUG') returns the string "true" from the .env file, which is truthy in PHP.

2. Step 2: Evaluate the ternary condition

   Since "true" as a string is truthy, the condition is true, so it echoes 'Debug is ON'.

3. Final Answer:

   Debug is ON -> Option A

4. Quick Check:

   env('APP_DEBUG') = 'true' (truthy) [OK]

Hint: env() returns strings; 'true' string is truthy in PHP [OK]

Common Mistakes:

• Assuming env('APP_DEBUG') returns boolean true
• Expecting 'Debug is OFF' because of string type
• Confusing string 'true' with boolean false

4. You wrote this code to get the database host:

$dbHost = env('DB_HOST', 'localhost');

But it always returns 'localhost' even though DB_HOST is set in .env. What is the most likely cause?

medium

A. The env() function does not accept default values

B. Laravel caches config and needs cache cleared

C. The DB_HOST key is misspelled in the code

D. The .env file is missing or not loaded properly

Solution

1. Step 1: Understand Laravel config caching behavior

   Laravel caches configuration for performance. If config cache is not cleared after changing .env, env() may return old values or defaults.

2. Step 2: Identify the fix

   Running php artisan config:clear clears the cache and loads updated .env values.

3. Final Answer:

   Laravel caches config and needs cache cleared -> Option B

4. Quick Check:

   Clear config cache to update env() values [OK]

Hint: Clear config cache after .env changes with artisan command [OK]

Common Mistakes:

• Assuming env() ignores default values
• Not clearing config cache after .env edits
• Misspelling env key without checking

5. You want to set a default timezone in your Laravel app using environment variables. You add APP_TIMEZONE=Europe/Paris to your .env file. How should you correctly apply this setting in config/app.php so the app uses the env value but falls back to 'UTC' if missing?

hard

A. 'timezone' => getenv('APP_TIMEZONE') ?: 'UTC',

B. 'timezone' => config('APP_TIMEZONE', 'UTC'),

C. 'timezone' => env('APP_TIMEZONE', 'UTC'),

D. 'timezone' => 'APP_TIMEZONE' ?? 'UTC',

Solution

1. Step 1: Use env() with default in config file

   In config/app.php, use env('APP_TIMEZONE', 'UTC') to get the env value or fallback to 'UTC'.

2. Step 2: Understand why other options are incorrect

   config() reads config files, not env variables; getenv() is less preferred; and 'APP_TIMEZONE' ?? 'UTC' is a string literal, not a variable.

3. Final Answer:

   'timezone' => env('APP_TIMEZONE', 'UTC'), -> Option C

4. Quick Check:

   Use env() with default in config files [OK]

Hint: In config, use env('KEY', 'default') for env with fallback [OK]

Common Mistakes:

• Using config() instead of env() for .env values
• Using string literals instead of env() calls
• Using getenv() which is less Laravel idiomatic