Padrão Template Method

Parte da seção Programação Orientada a Objetos do Journey de PHP da Coddy. Lição 78 de 91.

O Template Method Pattern é um padrão de projeto comportamental que define o esqueleto de um algoritmo em uma classe base, permitindo que as subclasses substituam etapas específicas sem alterar a estrutura geral. A classe base controla o fluxo de trabalho, enquanto as subclasses personalizam partes individuais.

Considere criar diferentes tipos de documentos.

Todo documento segue o mesmo processo: criar o cabeçalho, adicionar o conteúdo, criar o rodapé. Mas os detalhes de cada etapa variam de acordo com o tipo de documento. O método template define essa sequência, enquanto as subclasses implementam os detalhes.

<?php
abstract class DocumentGenerator {
    // O método template - define a estrutura do algoritmo
    public final function generate(): string {
        $output = $this->createHeader();
        $output .= $this->createContent();
        $output .= $this->createFooter();
        return $output;
    }
    
    // Passos a serem implementados pelas subclasses
    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();

Saída:

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

Observe a palavra-chave final no método de modelo. Isso impede que as subclasses alterem a estrutura do algoritmo. O padrão é ideal quando você tem várias classes que seguem o mesmo fluxo de trabalho, mas diferem nos detalhes de implementação. Adicionar um novo tipo de documento significa criar uma nova subclasse sem alterar o código existente.

Desafio

Fácil

Vamos criar um sistema de geração de relatórios usando o Padrão Template Method. Diferentes tipos de relatórios seguem a mesma estrutura — uma seção de título, uma seção de dados e uma seção de resumo —, mas cada tipo de relatório formata essas seções de maneira diferente. O método template definirá esse fluxo de trabalho, enquanto as subclasses personalizarão cada etapa.

Você organizará seu código em quatro arquivos:

ReportGenerator.php: Crie uma classe abstrata ReportGenerator que define o esqueleto do algoritmo de geração de relatórios. Sua classe deve:
- Aceitar um título de relatório em seu construtor (use a promoção de construtor)
- Ter um método público final generate(): string que chama três etapas na ordem: createTitle(), createBody() e createSummary(), concatenando seus resultados
- Declarar três métodos protegidos abstratos que as subclasses devem implementar: createTitle(): string, createBody(): string e createSummary(): string
HtmlReport.php: Inclua o arquivo ReportGenerator e crie uma classe HtmlReport que o estenda. Esse relatório formata a saída como HTML:
- createTitle() retorna "<h1>[title]</h1>"
- createBody() retorna "<p>Report data goes here</p>"
- createSummary() retorna "<footer>End of report</footer>"
PlainTextReport.php: Inclua o arquivo ReportGenerator e crie uma classe PlainTextReport que o estenda. Esse relatório usa uma formatação de texto simples:
- createTitle() retorna "### [title] ###\n"
- createBody() retorna "Report data goes here\n"
- createSummary() retorna "--- End of report ---"
main.php: Inclua os dois arquivos de relatório. Você receberá duas entradas: um tipo de relatório ("html" ou "text") e um título de relatório.
Com base no tipo de relatório, crie o gerador de relatórios apropriado com o título fornecido. Chame generate() e imprima o relatório completo.

O Padrão Template Method garante que todos os relatórios sigam a mesma estrutura de três etapas, permitindo que cada tipo de relatório formate suas seções de maneira exclusiva. A palavra-chave final em generate() impede que as subclasses alterem a sequência do algoritmo. Elas só podem personalizar etapas individuais.

Experimente você mesmo

<?php

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

// Ler entrada
$reportType = trim(fgets(STDIN));
$reportTitle = trim(fgets(STDIN));

// TODO: Com base no tipo de relatório ("html" ou "text"),
// crie o gerador de relatório apropriado com o título fornecido

// TODO: Chame generate() e imprima o relatório completo

?>