Welcome to the final lesson of the "Applying Clean Code Principles in PHP" course! Throughout this course, we've covered vital principles such as DRY (Don't Repeat Yourself), KISS (Keep It Simple, Stupid), and the Law of Demeter, all of which are foundational to writing clean and efficient code. In this culminating lesson, we'll explore the SOLID Principles, a set of design principles introduced by Robert C. Martin, commonly known as "Uncle Bob." Understanding SOLID is crucial for creating software that is flexible, scalable, and easy to maintain. Let's dive in and explore these principles together.

To start off, here's a quick overview of the SOLID Principles and their purposes:

• Single Responsibility Principle (SRP): Each class or module should only have one reason to change, meaning it should have only one job or responsibility.
• Open/Closed Principle (OCP): Software entities should be open for extension but closed for modification.
• Liskov Substitution Principle (LSP): Objects of a superclass should be replaceable with objects of its subclasses without affecting the correctness of the program.
• Interface Segregation Principle (ISP): No client should be forced to depend on methods it does not use.
• Dependency Inversion Principle (DIP): High-level modules should not depend on low-level modules. Both should depend on abstractions.

These principles are guidelines that help programmers write code that is easier to understand and more flexible to change, leading to cleaner and more maintainable codebases. Let's explore each principle in detail.

The Single Responsibility Principle states that each class should have only one reason to change, meaning it should only have one job or responsibility. This helps in reducing the complexity and enhancing the readability and maintainability of the code. Consider the following:

php
Copy to clipboard
1class User {
2    public function printUserInfo(): void {
3        // Print user information
4    }
5
6    public function storeUserData(): void {
7        // Store user data in the database
8    }
9}

In the above code, the User class has two responsibilities: printing user information and storing user data. This violates the Single Responsibility Principle by taking on more than one responsibility. Let's refactor:

php
Copy to clipboard
1class User {
2    // User-related attributes and methods
3}
4
5class UserPrinter {
6    public function printUserInfo(User $user): void {
7        // Print user information
8    }
9}
10
11class UserDataStore {
12    public function storeUserData(User $user): void {
13        // Store user data in the database
14    }
15}

In the refactored code, we have three classes, each handling a specific responsibility. This makes the code cleaner and easier to manage.

The Open/Closed Principle advises that software entities should be open for extension but closed for modification. This allows for enhancing and extending functionalities without altering existing code, reducing errors, and ensuring stable systems. Consider this example:

php
Copy to clipboard
1class Rectangle {
2    public float $width;
3    public float $height;
4}
5
6class AreaCalculator {
7    public function calculateRectangleArea(Rectangle $rectangle): float {
8        return $rectangle->width * $rectangle->height;
9    }
10}

In this setup, if we want to add a new shape like Circle, we need to modify the AreaCalculator class, violating the Open/Closed Principle. Here is an improved version using polymorphism:

php
Copy to clipboard
1interface Shape {
2    public function calculateArea(): float;
3}
4
5class Rectangle implements Shape {
6    private float $width;
7    private float $height;
8
9    public function __construct(float $width, float $height) {
10        $this->width = $width;
11        $this->height = $height;
12    }
13
14    public function calculateArea(): float {
15        return $this->width * $this->height;
16    }
17}
18
19class Circle implements Shape {
20    private float $radius;
21
22    public function __construct(float $radius) {
23        $this->radius = $radius;
24    }
25
26    public function calculateArea(): float {
27        return pi() * pow($this->radius, 2);
28    }
29}
30
31class AreaCalculator {
32    public function calculateArea(Shape $shape): float {
33        return $shape->calculateArea();
34    }
35}

Now, new shapes can be added without altering AreaCalculator. This setup adheres to the Open/Closed Principle by leaving the original code unchanged when extending functionalities.

The Liskov Substitution Principle ensures that objects of a subclass should be able to replace objects of a superclass without altering the functionality or causing any errors in the program.

php
Copy to clipboard
1class Bird {
2    public function fly(): void {
3        echo "Flying";
4    }
5}
6
7class Ostrich extends Bird {
8    public function fly(): void {
9        throw new Exception("Ostrich can't fly");
10    }
11}

Here, substituting an instance of Bird with Ostrich causes an issue because Ostrich cannot fly, leading to an exception. Let's refactor:

php
Copy to clipboard
1class Bird {
2    // Common behaviors for all birds
3}
4
5class FlyingBird extends Bird {
6    public function fly(): void {
7        echo "Flying";
8    }
9}
10
11class Ostrich extends Bird {
12    // Specific behaviors for ostriches
13}

By introducing FlyingBird and having only birds that can actually fly inherit from it, we can substitute Bird with Ostrich without errors, adhering to Liskov’s Substitution Principle.

The Interface Segregation Principle states that no client should be forced to depend on methods it does not use. Interfaces should be split into smaller, more specific entities so that clients only implement the methods they need:

php
Copy to clipboard
1interface Worker {
2    public function work(): void;
3    public function eat(): void;
4}
5
6class Robot implements Worker {
7    public function work(): void {
8        // Robot work functions
9    }
10
11    public function eat(): void {
12        // Robots don't eat, but must implement this method
13    }
14}

Robot being forced to implement eat() violates the Interface Segregation Principle. Here's the refactored version:

php
Copy to clipboard
1interface Workable {
2    public function work(): void;
3}
4
5interface Eatable {
6    public function eat(): void;
7}
8
9class Robot implements Workable {
10    public function work(): void {
11        // Robot work functions
12    }
13}

Now, Robot only implements the Workable interface, adhering to the Interface Segregation Principle.

The Dependency Inversion Principle dictates that high-level modules should not depend on low-level modules, but both should depend on abstractions. Here's an example:

php
Copy to clipboard
1class LightBulb {
2    private bool turnedOn = false;
3
4    public function turnOn(): void {
5        echo "LightBulb turned on";
6        $this->turnedOn = true;
7    }
8
9    public function turnOff(): void {
10        echo "LightBulb turned off";
11        $this->turnedOn = false;
12    }
13
14    public function isOn(): bool {
15        return $this->turnedOn;
16    }
17}
18
19class Switch {
20    private LightBulb $lightBulb;
21
22    public function __construct() {
23        $this->lightBulb = new LightBulb();
24    }
25
26    public function operate(): void {
27        if($this->lightBulb.isOn()) {
28            $this->lightBulb->turnOff();
29        } else {
30            $this->lightBulb->turnOn();
31        }
32    }
33}
34
35// Usage example:
36$switch = new Switch();
37$switch->operate();

Here, Switch directly depends on LightBulb, making it hard to extend the system with new devices without modifying Switch. To adhere to the Dependency Inversion Principle, we introduce an abstraction:

php
Copy to clipboard
1interface Switchable {
2    public function turnOn(): void;
3    public function turnOff(): void;
4    public function isOn(): bool;
5}
6
7class LightBulb implements Switchable {
8    private bool turnedOn = false;
9
10    public function turnOn(): void {
11        echo "LightBulb turned on";
12        $this->turnedOn = true;
13    }
14
15    public function turnOff(): void {
16        echo "LightBulb turned off";
17        $this->turnedOn = false;
18    }
19
20    public function isOn(): bool {
21        return $this->turnedOn;
22    }
23}
24
25class Switch {
26    private Switchable $client;
27
28    public function __construct(Switchable $client) {
29        $this->client = $client;
30    }
31
32    public function operate(): void {
33        if ($this->client->isOn()) {
34            $this->client->turnOff();
35        } else {
36            $this->client->turnOn();
37        }
38    }
39}
40
41// Usage example
42$lightBulb = new LightBulb()
43$switch = new Switch($lightBulb);
44$switch->operate();

Now Switch uses the Switchable interface, which can be implemented by any switchable device. This setup allows the Switch class to remain unchanged when introducing new devices, thus following the Dependency Inversion Principle by depending on an abstraction and reducing the system's rigidity.

In this lesson, we delved into the SOLID Principles — Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, and Dependency Inversion. These principles guide developers to create code that is maintainable, scalable, and easy to extend or modify. As you prepare for the upcoming practice exercises, remember that applying these principles in real-world scenarios will significantly enhance your coding skills and codebase quality. Good luck, and happy coding! 🎓