PSR-4 directory mapping in PHP

Introduction

PSR-4 directory mapping helps PHP find your classes automatically by linking namespaces to folders. This makes your code organized and easy to load.

When you want to organize your PHP classes in folders that match their namespaces.

When you use Composer to autoload your PHP classes without manually including files.

When you build a PHP project with many classes and want to keep code clean and easy to maintain.

Syntax

PHP

"psr-4": {
    "Namespace\\": "path/to/folder/"
}

The left side is the namespace prefix with double backslashes escaped.

The right side is the folder path where classes for that namespace live.

Examples

This maps the namespace App\ to the src/ folder.

PHP

"psr-4": {
    "App\\": "src/"
}

This maps the namespace MyProject\Utils\ to the lib/utils/ folder.

PHP

"psr-4": {
    "MyProject\\Utils\\": "lib/utils/"
}

Sample Program

This example shows a class Hello inside the App namespace mapped to the src/ folder. Composer autoloads the class automatically.

PHP

<?php
// File: src/Hello.php
namespace App;

class Hello {
    public function say() {
        return "Hello from App\\Hello!";
    }
}

// File: test.php
require 'vendor/autoload.php';

use App\Hello;

$greet = new Hello();
echo $greet->say();

Important Notes

Make sure the folder path ends with a slash /.

Namespace and folder structure must match exactly for autoloading to work.

Composer's autoload section in composer.json is where you set PSR-4 mapping.

Summary

PSR-4 maps namespaces to folders for automatic class loading.

It keeps your PHP code organized and easy to maintain.

Use Composer to set up and use PSR-4 autoloading in your projects.

Practice

1. What is the main purpose of PSR-4 in PHP?
PSR-4 helps with:

easy

A. Mapping namespaces to directory paths for autoloading classes

B. Defining coding style rules for PHP files

C. Encrypting PHP source code for security

D. Managing database connections automatically

Solution

1. Step 1: Understand PSR-4 role

   PSR-4 is a standard that maps PHP namespaces to folder paths to load classes automatically.

2. Step 2: Compare options

   Only Mapping namespaces to directory paths for autoloading classes describes this mapping and autoloading purpose correctly.

3. Final Answer:

   Mapping namespaces to directory paths for autoloading classes -> Option A

4. Quick Check:

   PSR-4 = Namespace to folder mapping [OK]

Hint: PSR-4 links namespaces to folders for autoloading [OK]

Common Mistakes:

• Confusing PSR-4 with coding style rules
• Thinking PSR-4 encrypts code
• Assuming PSR-4 manages databases

2. Which of the following is the correct way to define a PSR-4 autoload entry in composer.json?

easy

A. "autoload": { "psr-4": { "App": "src" } }

B. "autoload": { "psr-4": { "App/": "src\\" } }

C. "autoload": { "psr-4": { "App\\": "src/" } }

D. "autoload": { "psr-4": { "App\\": "src\\" } }

Solution

1. Step 1: Check PSR-4 syntax in composer.json

   PSR-4 keys use double backslashes for namespace separator and forward slashes for folder paths.

2. Step 2: Validate each option

   "autoload": { "psr-4": { "App\\": "src/" } } correctly uses "App\\" for namespace and "src/" for directory path.

3. Final Answer:

   "autoload": { "psr-4": { "App\\": "src/" } } -> Option C

4. Quick Check:

   Namespace ends with \\ and folder path uses / [OK]

Hint: Use double backslashes for namespaces, forward slashes for folders [OK]

Common Mistakes:

• Using single backslash in JSON string
• Mixing slashes in folder paths
• Omitting trailing backslash in namespace

3. Given this composer.json snippet:

{
  "autoload": {
    "psr-4": {
      "MyApp\\": "app/"
    }
  }
}

Where should the class MyApp\Controllers\HomeController be located?

medium

A. app/Controllers/HomeController.class.php

B. app/MyApp/Controllers/HomeController.php

C. src/Controllers/HomeController.php

D. app/Controllers/HomeController.php

Solution

1. Step 1: Understand PSR-4 mapping

   The namespace prefix "MyApp\\" maps to folder "app/". The rest of the namespace after prefix maps to subfolders.

2. Step 2: Map class namespace to file path

   Class "MyApp\\Controllers\\HomeController" maps to "app/Controllers/HomeController.php".

3. Final Answer:

   app/Controllers/HomeController.php -> Option D

4. Quick Check:

   Namespace after prefix = Controllers/HomeController.php [OK]

Hint: Namespace after prefix = folder path + class name.php [OK]

Common Mistakes:

• Adding namespace prefix folder again
• Using wrong base folder like src/
• Wrong file extension

4. You have this composer.json autoload section:

{
  "autoload": {
    "psr-4": {
      "Lib\\": "lib/"
    }
  }
}

But when you try to use Lib\Utils\Helper, PHP cannot find the class. What is the likely problem?

medium

A. Composer dump-autoload was not run after adding the class

B. The class file is not located at lib/Utils/Helper.php

C. The namespace prefix "Lib\\" should not have trailing backslash

D. The folder path should be "lib\\" with double backslashes

Solution

1. Step 1: Check common PSR-4 issues

   Folder path uses forward slashes, trailing backslash in namespace prefix is correct, so options C and D are wrong.

2. Step 2: Verify autoload update

   After adding new classes, you must run composer dump-autoload to update the autoloader.

3. Final Answer:

   Composer dump-autoload was not run after adding the class -> Option A

4. Quick Check:

   Run dump-autoload after changes [OK]

Hint: Always run composer dump-autoload after adding classes [OK]

Common Mistakes:

• Changing folder slashes incorrectly
• Removing trailing backslash in namespace prefix
• Forgetting to update autoloader

5. You want to autoload two separate namespaces in your project:
"App\\": "src/", "Vendor\\Package\\": "vendor/package/src/"
Which composer.json snippet correctly sets this up?

hard

A. "autoload": { "psr-4": { "App/": "src/", "Vendor/Package/": "vendor/package/src/" } }

B. "autoload": { "psr-4": { "App\\": "src/", "Vendor\\Package\\": "vendor/package/src/" } }

C. "autoload": { "psr-4": { "App\\": "src/", "Vendor\\Package": "vendor/package/src" } }

D. "autoload": { "psr-4": { "App": "src", "Vendor\\Package\\": "vendor/package/src/" } }

Solution

1. Step 1: Check namespace keys format

   Namespace keys must end with double backslashes to separate namespaces properly.

2. Step 2: Check folder paths format

   Folder paths use forward slashes and end with a slash for directories.

3. Step 3: Validate each option

   "autoload": { "psr-4": { "App\\": "src/", "Vendor\\Package\\": "vendor/package/src/" } } correctly uses double backslashes for both namespaces and trailing slashes for folders.

4. Final Answer:

   "autoload": { "psr-4": { "App\\": "src/", "Vendor\\Package\\": "vendor/package/src/" } } -> Option B

5. Quick Check:

   Double backslashes + trailing slash folder paths [OK]

Hint: Use double backslashes for namespaces and trailing slash for folders [OK]

Common Mistakes:

• Omitting trailing backslash in namespace keys
• Using forward slashes in namespace keys
• Missing trailing slash in folder paths