Exploring the Decorator Pattern in PHP

Welcome back! Having explored the Adapter and Composite Patterns, you are advancing in mastering structural design patterns in PHP. Today, we'll delve into the Decorator Pattern, a key structural design pattern that allows us to attach additional responsibilities to objects dynamically and transparently. This pattern is particularly useful when you want to extend the behavior of objects without altering the original code structure.

What You'll Learn

The Decorator Pattern enables you to wrap an object with additional behavior in a flexible and reusable manner. We'll guide you through using this pattern to extend the functionality of objects in a clean and maintainable way. Consider a basic coffee ordering system. By the end of this lesson, you'll be able to: Create a basic Coffee class. Implement decorators like MilkDecorator and SugarDecorator to enhance the features of the basic coffee. Here's a glimpse of the PHP code you'll be working with: We begin by defining a basic Coffee interface with a getDescription method for the retrieval of the coffee's name and a cost method for its price: PHPinterface Coffee { public function getDescription(): string; public function cost(): float; } class SimpleCoffee implements Coffee { public function getDescription(): string { return "Coffee"; } public function cost(): float { return 2.0; } } Next, we define a CoffeeDecorator class implementing the Coffee interface. This class holds a reference to a coffee object and serves as the base class for all decorators: class CoffeeDecorator implements Coffee { protected $decoratedCoffee; public function __construct(Coffee $coffee) { $this->decoratedCoffee = $coffee; } public function getDescription(): string { return $this->decoratedCoffee->getDescription(); } public function cost(): float { return $this->decoratedCoffee->cost(); } } Finally, we implement concrete decorators like MilkDecorator and SugarDecorator that add milk and sugar to the coffee, respectively. These decorators enrich the decorated coffee object with new features: class MilkDecorator extends CoffeeDecorator { public function getDescription(): string { return parent::getDescription() . ", Milk"; } public function cost(): float { return parent::cost() + 0.5; } } class SugarDecorator extends CoffeeDecorator { public function getDescription(): string { return parent::getDescription() . ", Sugar"; } public function cost(): float { return parent::cost() + 0.2; } } Here's how you can use these classes to create and customize coffee orders using the Decorator Pattern: $coffee = new SimpleCoffee(); echo "Description: " . $coffee->getDescription() . ", Cost: " . $coffee->cost() . "\n"; // Output: Description: Coffee, Cost: 2 $coffeeWithMilk = new MilkDecorator($coffee); echo "Description: " . $coffeeWithMilk->getDescription() . ", Cost: " . $coffeeWithMilk->cost() . "\n"; // Output: Description: Coffee, Milk, Cost: 2.5 $coffeeWithMilkAndSugar = new SugarDecorator($coffeeWithMilk); echo "Description: " . $coffeeWithMilkAndSugar->getDescription() . ", Cost: " . $coffeeWithMilkAndSugar->cost() . "\n"; // Output: Description: Coffee, Milk, Sugar, Cost: 2.7 Observe how decorators like MilkDecorator and SugarDecorator can be combined to create customized coffee orders. This enables adding new features to the coffee object at runtime without altering its inherent code.

Use Cases

Let's consider a few scenarios where the Decorator Pattern in PHP can be used effectively: Web Application Middleware : Enhance HTTP requests and responses in PHP web applications by wrapping different middleware functions around your application logic. Validation Systems : Add layers of validation to data objects, enabling flexible and combinatorial validation strategies. Content Management Systems : Extend features like SEO tags, caching, and analytics to posts dynamically, without altering the core system.

Pros and Cons

Let's explore the benefits and drawbacks of using the Decorator Pattern : Pros : Flexibility : Decorators allow dynamic and transparent addition of new features to objects. Open-Closed Principle : Supports the Open-Closed Principle, facilitating extending functionalities without modifying base code. Composability : Enables combining decorators to craft complex object configurations. Separation of Concerns : Promotes the separation of core functionalities from additional features, improving modularity and maintainability. Cons : Complexity : May result in numerous small classes if multiple decorators are created, increasing complexity. Ordering : The order of decorator application can impact behavior, necessitating careful design and testing.

Why It Matters

Mastering the Decorator Pattern is significant as it enables runtime functionality extension to objects without altering their structures. This implies more adaptable and maintainable code in PHP compared to subclassing for each new feature. In our coffee example, adding features like milk and sugar by layering decorators allows diverse combinations. Whether extending functionalities in web applications, validation systems, or content management systems, the Decorator Pattern offers an elegant solution in PHP contexts. Excited to apply this concept? Let's move on to the practice section, where you'll implement and extend the Decorator Pattern step-by-step in PHP.

Previous Lesson

Next Lesson: Applying PHP Structural Patterns in Real-World Applications

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

PHP

interface Coffee {
    public function getDescription(): string;
    public function cost(): float;
}

class SimpleCoffee implements Coffee {
    public function getDescription(): string {
        return "Coffee";
    }
    
    public function cost(): float {
        return 2.0;
    }
}

PHP

class CoffeeDecorator implements Coffee {
    protected $decoratedCoffee;
    
    public function __construct(Coffee $coffee) {
        $this->decoratedCoffee = $coffee;
    }
    
    public function getDescription(): string {
        return $this->decoratedCoffee->getDescription();
    }
    
    public function cost(): float {
        return $this->decoratedCoffee->cost();
    }
}

class CoffeeDecorator implements Coffee {
    protected $decoratedCoffee;
    
    public function __construct(Coffee $coffee) {
        $this->decoratedCoffee = $coffee;
    }
    
    public function getDescription(): string {
        return $this->decoratedCoffee->getDescription();
    }
    
    public function cost(): float {
        return $this->decoratedCoffee->cost();
    }
}

PHP

class MilkDecorator extends CoffeeDecorator {
    public function getDescription(): string {
        return parent::getDescription() . ", Milk";
    }
    
    public function cost(): float {
        return parent::cost() + 0.5;
    }
}

class SugarDecorator extends CoffeeDecorator {
    public function getDescription(): string {
        return parent::getDescription() . ", Sugar";
    }
    
    public function cost(): float {
        return parent::cost() + 0.2;
    }
}

class MilkDecorator extends CoffeeDecorator {
    public function getDescription(): string {
        return parent::getDescription() . ", Milk";
    }
    
    public function cost(): float {
        return parent::cost() + 0.5;
    }
}

class SugarDecorator extends CoffeeDecorator {
    public function getDescription(): string {
        return parent::getDescription() . ", Sugar";
    }
    
    public function cost(): float {
        return parent::cost() + 0.2;
    }
}

PHP

$coffee = new SimpleCoffee();
echo "Description: " . $coffee->getDescription() . ", Cost: " . $coffee->cost() . "\n"; 
// Output: Description: Coffee, Cost: 2

$coffeeWithMilk = new MilkDecorator($coffee);
echo "Description: " . $coffeeWithMilk->getDescription() . ", Cost: " . $coffeeWithMilk->cost() . "\n"; 
// Output: Description: Coffee, Milk, Cost: 2.5

$coffeeWithMilkAndSugar = new SugarDecorator($coffeeWithMilk);
echo "Description: " . $coffeeWithMilkAndSugar->getDescription() . ", Cost: " . $coffeeWithMilkAndSugar->cost() . "\n"; 
// Output: Description: Coffee, Milk, Sugar, Cost: 2.7

$coffee = new SimpleCoffee();
echo "Description: " . $coffee->getDescription() . ", Cost: " . $coffee->cost() . "\n"; 
// Output: Description: Coffee, Cost: 2

$coffeeWithMilk = new MilkDecorator($coffee);
echo "Description: " . $coffeeWithMilk->getDescription() . ", Cost: " . $coffeeWithMilk->cost() . "\n"; 
// Output: Description: Coffee, Milk, Cost: 2.5

$coffeeWithMilkAndSugar = new SugarDecorator($coffeeWithMilk);
echo "Description: " . $coffeeWithMilkAndSugar->getDescription() . ", Cost: " . $coffeeWithMilkAndSugar->cost() . "\n"; 
// Output: Description: Coffee, Milk, Sugar, Cost: 2.7

PHP

class CoffeeDecorator implements Coffee {
    protected $decoratedCoffee;
    
    public function __construct(Coffee $coffee) {
        $this->decoratedCoffee = $coffee;
    }
    
    public function getDescription(): string {
        return $this->decoratedCoffee->getDescription();
    }
    
    public function cost(): float {
        return $this->decoratedCoffee->cost();
    }
}

PHP

class MilkDecorator extends CoffeeDecorator {
    public function getDescription(): string {
        return parent::getDescription() . ", Milk";
    }
    
    public function cost(): float {
        return parent::cost() + 0.5;
    }
}

class SugarDecorator extends CoffeeDecorator {
    public function getDescription(): string {
        return parent::getDescription() . ", Sugar";
    }
    
    public function cost(): float {
        return parent::cost() + 0.2;
    }
}

PHP

$coffee = new SimpleCoffee();
echo "Description: " . $coffee->getDescription() . ", Cost: " . $coffee->cost() . "\n"; 
// Output: Description: Coffee, Cost: 2

$coffeeWithMilk = new MilkDecorator($coffee);
echo "Description: " . $coffeeWithMilk->getDescription() . ", Cost: " . $coffeeWithMilk->cost() . "\n"; 
// Output: Description: Coffee, Milk, Cost: 2.5

$coffeeWithMilkAndSugar = new SugarDecorator($coffeeWithMilk);
echo "Description: " . $coffeeWithMilkAndSugar->getDescription() . ", Cost: " . $coffeeWithMilkAndSugar->cost() . "\n"; 
// Output: Description: Coffee, Milk, Sugar, Cost: 2.7