Config files and access in Laravel - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of config files in Laravel?

Config files store settings and options for your Laravel app, like database info or app name. They help keep code clean and easy to change.

beginner

Where are Laravel config files stored?

All config files are in the config/ folder at the root of your Laravel project.

beginner

How do you access a config value in Laravel code?

Use the config() helper function with dot notation. For example, config('app.timezone') gets the timezone setting from config/app.php.

intermediate

What happens if you try to access a config key that does not exist?

Laravel returns null by default. You can provide a default value as a second argument to config() to avoid nulls.

intermediate

Why should sensitive data like passwords be stored in environment files instead of config files?

Environment files (.env) keep secrets out of code and config files. This helps keep sensitive info safe and makes it easy to change per environment.

Where do you find Laravel's config files?

A In the <code>config/</code> folder

B In the <code>resources/</code> folder

C In the <code>app/</code> folder

D In the <code>storage/</code> folder

Laravel stores all configuration files inside the config/ directory.

How do you get the app name from config in Laravel?

A config('name.app')

B getConfig('app.name')

C config('app.name')

D app()->config('name')

Use config('app.name') to access the app name from the config/app.php file.

What does Laravel return if a config key is missing and no default is given?

A null

B empty string

C false

D throws an error

Laravel returns null if the config key does not exist and no default value is provided.

Where should you store sensitive info like passwords in Laravel?

A In <code>config/app.php</code>

B In the <code>.env</code> file

C In <code>routes/web.php</code>

D In <code>public/</code> folder

Sensitive data should be stored in the .env file to keep it secure and separate from code.

How can you provide a default value when accessing a config key?

A config('key')->default('value')

B config('key').default('value')

C config('key').or('default')

D config('key', 'default')

You can pass a second argument to config() as a default value if the key is missing.

Explain how Laravel config files work and how you access their values in code.

Think about where settings live and how you read them.

Why is it important to keep sensitive data in environment files instead of config files in Laravel?

Consider safety and changing settings for different servers.

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