Config files and access in Laravel

Introduction

Config files store settings for your Laravel app in one place. This helps you change app behavior without editing code everywhere.

You want to set database connection details like host and username.

You need to change app settings like timezone or locale.

You want to store API keys or service credentials safely.

You want to toggle features on or off without changing code.

You want to organize settings for mail, cache, or queue services.

Syntax

Laravel

<?php

return [
    'key' => 'value',
    'nested' => [
        'subkey' => 'subvalue',
    ],
];

Config files are PHP files that return an array of settings.

Each config file is stored in the config/ folder.

Examples

A simple config file with app name and debug mode.

Laravel

<?php

return [
    'app_name' => 'My Laravel App',
    'debug' => true,
];

Nested array for database settings.

Laravel

<?php

return [
    'database' => [
        'host' => '127.0.0.1',
        'port' => 3306,
    ],
];

Using env() to get sensitive info from environment variables.

Laravel

<?php

return [
    'services' => [
        'mailgun' => [
            'domain' => env('MAILGUN_DOMAIN'),
            'secret' => env('MAILGUN_SECRET'),
        ],
    ],
];

Sample Program

This example shows a config file example.php with two keys. The route /greet reads these values using Config::get() and returns a greeting message.

Laravel

<?php

// config/example.php
return [
    'greeting' => 'Hello',
    'audience' => 'World',
];

// In a Laravel controller or route closure
use Illuminate\Support\Facades\Config;

Route::get('/greet', function () {
    $greeting = Config::get('example.greeting');
    $audience = Config::get('example.audience');
    return "$greeting, $audience!";
});

Important Notes

Use Config::get('file.key') to read config values anywhere in your app.

Use env() in config files to keep secrets out of code and use environment variables instead.

After changing config files, you may need to clear config cache with php artisan config:clear.

Summary

Config files hold app settings in config/ as PHP arrays.

Access config values with Config::get('file.key').

Use environment variables for sensitive info with env().

Practice

1. What is the primary purpose of config files in a Laravel application?

easy

A. To define routes for the application

B. To write database queries

C. To create user interface components

D. To store application settings as PHP arrays

Solution

1. Step 1: Understand config file role

   Config files in Laravel are PHP files that return arrays holding settings.

2. Step 2: Identify correct purpose

   They store app settings like database, mail, and cache configurations.

3. Final Answer:

   To store application settings as PHP arrays -> Option D

4. Quick Check:

   Config files = app settings [OK]

Hint: Config files hold settings, not code or UI [OK]

Common Mistakes:

• Confusing config files with route or view files
• Thinking config files contain SQL queries
• Assuming config files define UI elements

2. Which of the following is the correct syntax to access the 'timezone' setting from the 'app' config file in Laravel?

easy

A. config('app.timezone')

B. config('app->timezone')

C. Config::get('timezone.app')

D. Config::get('app.timezone')

Solution

1. Step 1: Recall Laravel config access syntax

   Laravel uses the helper function config('file.key') to get config values.

2. Step 2: Identify correct syntax

   config('app.timezone') uses the correct helper function and dot notation for 'app.timezone'.

3. Final Answer:

   config('app.timezone') -> Option A

4. Quick Check:

   Use config('file.key') for access [OK]

Hint: Use config() helper with dot notation for keys [OK]

Common Mistakes:

• Using arrow (->) instead of dot (.) in key
• Using Config::get() without importing facade
• Swapping file and key order

3. Given the config file config/mail.php contains:

return [
  'driver' => env('MAIL_DRIVER', 'smtp'),
  'host' => env('MAIL_HOST', 'smtp.mailtrap.io'),
];

And the environment variable MAIL_DRIVER is set to sendmail, what will config('mail.driver') return?

medium

A. "smtp"

B. "sendmail"

C. null

D. "smtp.mailtrap.io"

Solution

1. Step 1: Understand env() usage in config

   The config uses env('MAIL_DRIVER', 'smtp'), which returns the environment variable if set, else 'smtp'.

2. Step 2: Check environment variable value

   Since MAIL_DRIVER is set to 'sendmail', env('MAIL_DRIVER', 'smtp') returns 'sendmail'.

3. Final Answer:

   "sendmail" -> Option B

4. Quick Check:

   env() returns env var if set, else default [OK]

Hint: env() returns env var first, default second [OK]

Common Mistakes:

• Assuming default value always returns
• Confusing config key with env variable name
• Ignoring environment variable settings

4. What is wrong with this code snippet to access a config value?

use Illuminate\Support\Facades\Config;

$value = Config::get('database.connections.mysql.host');

medium

A. The config key should use underscores instead of dots

B. The config key is too long and invalid

C. Nothing is wrong; this is correct syntax

D. The Config facade is not imported correctly

Solution

1. Step 1: Check import statement

   The code imports Config facade correctly with use Illuminate\Support\Facades\Config;.

2. Step 2: Verify config key syntax

   The key 'database.connections.mysql.host' uses correct dot notation to access nested config arrays.

3. Final Answer:

   Nothing is wrong; this is correct syntax -> Option C

4. Quick Check:

   Config::get() with dot keys and correct import is valid [OK]

Hint: Dot notation accesses nested config keys correctly [OK]

Common Mistakes:

• Using underscores instead of dots in keys
• Forgetting to import Config facade
• Assuming key length causes errors

5. You want to create a new config file config/payment.php with a key gateway that uses an environment variable PAYMENT_GATEWAY defaulting to 'stripe'. How should you write the config file to access this value correctly in Laravel?

hard

A. env('PAYMENT_GATEWAY', 'stripe')];

B. config('PAYMENT_GATEWAY', 'stripe')];

C. 'PAYMENT_GATEWAY' ?? 'stripe'];

D. getenv('PAYMENT_GATEWAY', 'stripe')];

Solution

1. Step 1: Use env() to read environment variables in config

   Laravel config files use env('VAR_NAME', 'default') to get env vars with defaults.

2. Step 2: Write correct PHP array return

   Return an array with key 'gateway' set to env('PAYMENT_GATEWAY', 'stripe').

3. Final Answer:

   <?php return ['gateway' => env('PAYMENT_GATEWAY', 'stripe')]; -> Option A

4. Quick Check:

   Use env() in config files for env vars [OK]

Hint: Use env() with default inside config files [OK]

Common Mistakes:

• Using config() inside config files instead of env()
• Using getenv() without fallback default
• Using PHP null coalescing incorrectly