نمط طريقة القالب

جزء من قسم البرمجة كائنية التوجه في رحلة PHP على Coddy. الدرس 78 من 91.

إن نمط Template Method هو نمط تصميم سلوكي يعرّف الهيكل الأساسي لخوارزمية في صنف أساسي، مما يسمح للأصناف الفرعية بتجاوز خطوات محددة دون تغيير البنية العامة. يتحكم الصنف الأساسي في سير العمل، بينما تخصّص الأصناف الفرعية الأجزاء الفردية.

ضع في اعتبارك إنشاء أنواع مختلفة من المستندات.

يتبع كل مستند العملية نفسها: create ترويسة، إضافة محتوى، create footer. تحدد method القالب هذا التسلسل، بينما تنفذ الفئات الفرعية التفاصيل.

<?php
abstract class DocumentGenerator {
    // طريقة القالب - تحدد بنية الخوارزمية
    public final function generate(): string {
        $output = $this->createHeader();
        $output .= $this->createContent();
        $output .= $this->createFooter();
        return $output;
    }
    
    // خطوات يجب تنفيذها بواسطة الفئات الفرعية
    abstract protected function createHeader(): string;
    abstract protected function createContent(): string;
    abstract protected function createFooter(): string;
}

class HtmlDocument extends DocumentGenerator {
    protected function createHeader(): string {
        return "<html><head></head><body>";
    }
    
    protected function createContent(): string {
        return "<p>Hello World</p>";
    }
    
    protected function createFooter(): string {
        return "</body></html>";
    }
}

class TextDocument extends DocumentGenerator {
    protected function createHeader(): string {
        return "=== DOCUMENT ===\n";
    }
    
    protected function createContent(): string {
        return "Hello World\n";
    }
    
    protected function createFooter(): string {
        return "=== END ===";
    }
}

$html = new HtmlDocument();
echo $html->generate() . "\n";

$text = new TextDocument();
echo $text->generate();

المخرجات:

<html><head></head><body><p>Hello World</p></body></html>
=== DOCUMENT ===
Hello World
=== END ===

لاحظ الكلمة المفتاحية final في method القالب. فهذا يمنع الفئات الفرعية من تغيير بنية algorithm. يكون هذا النمط مثاليًا عندما تتوفر لديك فئات متعددة تتبع سير العمل نفسه، لكنها تختلف في تفاصيل التنفيذ. تعني إضافة نوع مستند جديد إنشاء فئة فرعية جديدة دون المساس بالشفرة الموجودة.

التحدي

سهل

لنبنِ نظامًا لإنشاء التقارير باستخدام نمط Template method. تتبع الأنواع المختلفة من التقارير البنية نفسها، وهي قسم العنوان وقسم البيانات وقسم الملخص، لكن كل نوع من التقارير ينسّق هذه الأقسام بطريقة مختلفة. ستعرّف طريقة القالب سير العمل هذا، بينما تخصّص الفئات الفرعية كل خطوة.

ستنظّم الشيفرة عبر أربعة ملفات:

ReportGenerator.php: أنشئ فئة مجردة باسم ReportGenerator تعرّف الهيكل الأساسي لخوارزمية إنشاء التقرير. يجب أن تكون فئتك:
- تقبل عنوان التقرير في constructor الخاص بها (استخدم constructor promotion)
- تحتوي على method عامة final باسم generate(): string تستدعي ثلاث خطوات بالترتيب: createTitle() وcreateBody() وcreateSummary()، مع تسلسل نتائجها
- تعلن عن ثلاث methods مجردة محمية يجب على الفئات الفرعية implement لها: createTitle(): string وcreateBody(): string وcreateSummary(): string
HtmlReport.php: أدرج ملف ReportGenerator وأنشئ فئة HtmlReport تمتد منه. ينسّق هذا التقرير output بصيغة HTML:
- تعيد createTitle() القيمة "<h1>[title]</h1>"
- تعيد createBody() القيمة "<p>Report data goes here</p>"
- تعيد createSummary() القيمة "<footer>End of report</footer>"
PlainTextReport.php: أدرج ملف ReportGenerator وأنشئ فئة PlainTextReport تمتد منه. يستخدم هذا التقرير تنسيقًا نصيًا بسيطًا:
- تعيد createTitle() القيمة "### [title] ###\n"
- تعيد createBody() القيمة "Report data goes here\n"
- تعيد createSummary() القيمة "--- End of report ---"
main.php: أدرج ملفي التقرير. ستتلقى مدخلين: نوع التقرير ("html" أو "text") وعنوان التقرير.
بناءً على نوع التقرير، أنشئ generator مناسبًا للتقرير باستخدام العنوان given. استدعِ generate() واطبع التقرير complete.

يضمن نمط Template method أن تتبع جميع التقارير البنية نفسها المكوّنة من ثلاث خطوات، مع السماح لكل نوع تقرير بتنسيق أقسامه بطريقة فريدة. تمنع الكلمة المفتاحية final في generate() الفئات الفرعية من تغيير تسلسل algorithm. ولا يمكنها سوى تخصيص الخطوات الفردية.

جرّب بنفسك

<?php

require_once 'HtmlReport.php';
require_once 'PlainTextReport.php';

// قراءة المدخلات
$reportType = trim(fgets(STDIN));
$reportTitle = trim(fgets(STDIN));

// TODO: بناءً على نوع التقرير ("html" أو "text")،
// أنشئ مولّد التقرير المناسب بالعنوان المعطى

// TODO: استدعِ generate() واطبع التقرير الكامل

?>