Composer autoload mechanism in PHP - Mini Project: Build & Apply

Composer autoload mechanism

📖 Scenario: You are building a simple PHP project that uses Composer to autoload classes automatically. This helps you avoid manually including each class file.

🎯 Goal: Create a PHP project with a class, configure Composer's autoload, and use the autoloaded class in your script.

📋 What You'll Learn

Create a PHP class file in the src folder

Create a composer.json file with PSR-4 autoload configuration

Run Composer to generate the autoload files

Write a PHP script that uses the autoloaded class without manual includes

💡 Why This Matters

🌍 Real World

Composer autoloading is used in almost all modern PHP projects to load classes automatically, saving time and avoiding errors from manual includes.

💼 Career

Understanding Composer autoload is essential for PHP developers working on frameworks, libraries, or any professional PHP applications.

1

Create a PHP class file

Create a folder named src and inside it create a PHP file named Greeting.php. In this file, define a class called Greeting inside the namespace App. The class should have a public method sayHello() that returns the string "Hello from Composer autoload!".

PHP

<?php

namespace App;

// Your code here

Hint

Remember to declare the namespace at the top and define the class with the method returning the exact string.

2

Create composer.json with PSR-4 autoload

Create a composer.json file in your project root with a autoload section using PSR-4. Map the namespace App\\ to the src/ directory.

PHP

<?php

namespace App;

class Greeting {
    public function sayHello() {
        return "Hello from Composer autoload!";
    }
}

// Your code here

Hint

The composer.json file must have an autoload section with psr-4 mapping App\\ to src/.

3

Run Composer to generate autoload files

Run the Composer command composer dump-autoload in your project root to generate the autoload files based on your composer.json configuration.

PHP

// Run 'composer dump-autoload' in your terminal
// Your code here

Hint

Open your terminal and run composer dump-autoload to create the vendor/autoload.php file.

4

Use the autoloaded class in a PHP script

Create a PHP script named index.php in your project root. Include the Composer autoload file vendor/autoload.php. Then create an instance of App\Greeting and print the result of calling its sayHello() method.

PHP

<?php
require __DIR__ . '/vendor/autoload.php';

// Your code here

Hint

Use require __DIR__ . '/vendor/autoload.php'; to load Composer's autoloader. Then create new Greeting() and print the message.

Practice

1. What is the main purpose of Composer's autoload mechanism in PHP?

easy

A. To automatically load PHP classes without manual includes

B. To compile PHP code into binary files

C. To create database connections automatically

D. To minify PHP scripts for faster loading

Solution

1. Step 1: Understand Composer's role

   Composer manages dependencies and helps load classes automatically.

2. Step 2: Identify autoload mechanism purpose

   Autoloading means PHP classes are loaded when needed without manual includes.

3. Final Answer:

   To automatically load PHP classes without manual includes -> Option A

4. Quick Check:

   Autoload = automatic class loading [OK]

Hint: Autoload means no manual includes needed [OK]

Common Mistakes:

• Thinking autoload compiles code
• Confusing autoload with database tasks
• Assuming autoload minifies scripts

2. Which file must you include in your PHP script to use Composer's autoload feature?

easy

A. autoload_classmap.php

B. composer.json

C. vendor/autoload.php

D. composer.lock

Solution

1. Step 1: Identify the autoload file

   Composer generates vendor/autoload.php to load all classes automatically.

2. Step 2: Differentiate from other files

   composer.json and composer.lock manage dependencies but don't autoload classes directly.

3. Final Answer:

   vendor/autoload.php -> Option C

4. Quick Check:

   Include vendor/autoload.php to autoload classes [OK]

Hint: Always include vendor/autoload.php for autoloading [OK]

Common Mistakes:

• Including composer.json instead of autoload.php
• Trying to include composer.lock file
• Confusing autoload_classmap.php as main include

3. Given the following PHP code, what will be the output if Composer's autoload is correctly set up and the class App\Utils\Helper exists?

require 'vendor/autoload.php';
use App\Utils\Helper;
$helper = new Helper();
echo $helper->greet();

medium

A. Fatal error: Class 'App\Utils\Helper' not found

B. Hello from Helper!

C. Parse error: syntax error

D. Nothing will be printed

Solution

1. Step 1: Check autoload inclusion

   The code includes vendor/autoload.php, enabling class autoloading.

2. Step 2: Confirm class usage and method call

   The class App\Utils\Helper is used and instantiated, then greet() is called.

3. Final Answer:

   Hello from Helper! -> Option B

4. Quick Check:

   Autoload loads class, greet() outputs greeting [OK]

Hint: If autoload works, class methods run as expected [OK]

Common Mistakes:

• Forgetting to include vendor/autoload.php
• Misspelling the namespace or class name
• Assuming no output without checking method

4. What is the error in this PHP code snippet using Composer autoload?

require 'vendor/autoload.php';
use App\Services\Mailer;
$mailer = new Mailer();
$mailer->sendEmail('[e-mail]');

Assuming the class App\Services\Mailer exists but the code throws a fatal error.

medium

A. The namespace or class name is misspelled

B. The sendEmail method does not exist in Mailer class

C. vendor/autoload.php file is missing or not included

D. The Mailer class is not autoloaded because composer dump-autoload was not run

Solution

1. Step 1: Check autoload file inclusion

   If vendor/autoload.php is missing or path is wrong, classes won't load.

2. Step 2: Understand fatal error cause

   Fatal error usually means class not found, often due to missing autoload file or autoload not updated.

3. Final Answer:

   The Mailer class is not autoloaded because composer dump-autoload was not run -> Option D

4. Quick Check:

   Not running composer dump-autoload causes class not found error [OK]

Hint: Check vendor/autoload.php inclusion first on fatal errors [OK]

Common Mistakes:

• Assuming method missing without checking class load
• Ignoring autoload file path correctness
• Blaming namespace spelling without verifying autoload

5. You want to autoload your own PHP classes located in the src/ folder using Composer. Which step correctly configures Composer to autoload these classes using PSR-4 standard?

hard

A. Add "autoload": {"psr-4": {"App\\": "src/"}} in composer.json and run composer dump-autoload

B. Add "autoload": {"classmap": ["src/"]} in composer.json and run composer install

C. Manually include all files in src/ in your PHP scripts

D. Add "autoload": {"files": ["src/"]} in composer.json and run composer update

Solution

1. Step 1: Understand PSR-4 autoloading

   PSR-4 maps namespaces to folder paths, e.g., "App\\" to "src/".

2. Step 2: Configure composer.json and regenerate autoload files

   Add the correct autoload section and run composer dump-autoload to update.

3. Final Answer:

   Add "autoload": {"psr-4": {"App\\": "src/"}} in composer.json and run composer dump-autoload -> Option A

4. Quick Check:

   PSR-4 + composer dump-autoload = correct autoload setup [OK]

Hint: Use PSR-4 in composer.json and run dump-autoload [OK]

Common Mistakes:

• Using classmap or files instead of PSR-4 for namespaces
• Forgetting to run composer dump-autoload after changes
• Manually including files instead of using autoload