O Facade Design Pattern é um padrão estrutural que fornece uma interface simplificada para um conjunto complexo de classes, bibliotecas ou subsistemas. É usado para ocultar a complexidade dos sistemas e oferecer uma interface mais amigável e fácil de usar para os clientes.

Principais Objetivos

• Simplifique a interação: Ao criar uma interface única e simples, o padrão Facade facilita o uso de um sistema complexo sem expor toda a sua complexidade interna.
• Encapsulamento de subsistemas: As classes que compõem o subsistema podem ser complexas, mas a fachada atua como uma camada de abstração, permitindo ao cliente interagir apenas com métodos simples e coesos.
• Desacoplamento: O padrão ajuda a manter o cliente dissociado da implementação interna, tornando o sistema mais fácil de manter e expandir no futuro.

Exemplo usando PHPMailer e padrão Façade

Situação:

Imagine que temos um aplicativo que precisa enviar e-mails de forma simples. O processo de envio de e-mails pode envolver configurações de autenticação, servidores SMTP, configuração de remetente, destinatário, corpo do e-mail, anexos, etc. Em vez de expor todo esse processo complexo ao usuário final, podemos criar uma fachada para encapsular essas operações.

Instale o PHPMailer via Composer

composer require phpmailer/phpmailer

Sistema de diretório

?Facade
 ┣ ?src
 ┃ ┗ ?MailFacade.php
 ┣ ?vendor
 ┣ ?composer.json
 ┗ ?index.php

Carregamento automático

Primeiro, vamos ter certeza de que o Composer gerencia as dependências e carrega automaticamente as classes corretamente.

No arquivo compositor.json, podemos incluir o autoload das classes da pasta src e também adicionar a dependência do PHPMailer:

{
  "require": {
    "phpmailer/phpmailer": "^6.0"
  },
  "autoload": {
    "psr-4": {
      "App\\": "src/"
    }
  }
}

Class MailFacade

Agora vamos criar uma classe MailFacade que atuará como fachada para simplificar o processo de envio de emails para o usuário.

namespace App;

use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\Exception;

// Facade class
class MailFacade {
    private $mail;

    public function __construct() {
        $this->mail = new PHPMailer(true);  // Create a new instance of PHPMailer
        $this->mail->isSMTP();              // Set up to use SMTP
        $this->mail->Host = 'smtp.example.com';  // Set the SMTP server
        $this->mail->SMTPAuth = true;       // Enable SMTP authentication
        $this->mail->Username = '[email protected]'; // SMTP username
        $this->mail->Password = 'secret';   // SMTP password
        $this->mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS; // Enable TLS encryption
        $this->mail->Port = 587;            // SMTP server port
    }

}

Método sendEmail

// Method to send a simple email
public function sendEmail($to, $subject, $body) {
    try {
        // Set sender
        $this->mail->setFrom('[email protected]', 'Sender Name');

        // Set recipient
        $this->mail->addAddress($to);  // You can add more with $this->mail->addAddress('[email protected]');

        // Set email subject and body
        $this->mail->Subject = $subject;
        $this->mail->Body = $body;
        $this->mail->isHTML(true); // Set email body to accept HTML

        // Send email
        $this->mail->send();
        echo 'Email successfully sent!';
    } catch (Exception $e) {
        echo "Error sending email: {$this->mail->ErrorInfo}";
    }
}

Método sendEmailWithAttachment

// Method to send an email with an attachment
public function sendEmailWithAttachment($to, $subject, $body, $attachmentPath) {
    try {
        // Same basic configuration as in the previous method
        $this->mail->setFrom('[email protected]', 'Sender Name');
        $this->mail->addAddress($to);

        // Set subject and body
        $this->mail->Subject = $subject;
        $this->mail->Body = $body;
        $this->mail->isHTML(true);

        // Add the attachment
        $this->mail->addAttachment($attachmentPath);

        // Send the email
        $this->mail->send();
        echo 'Email with attachment successfully sent!';
    } catch (Exception $e) {
        echo "Error sending email: {$this->mail->ErrorInfo}";
    }
}

Teste

require 'vendor/autoload.php';

use App\MailFacade;

// Using the Facade
$mailFacade = new MailFacade();

// Sending a simple email
$mailFacade->sendEmail('[email protected]', 'Email Subject', 'Email body in HTML');

// Sending an email with an attachment
$mailFacade->sendEmailWithAttachment('[email protected]', 'Subject with Attachment', 'Here is your attachment', '/path/to/attachment.pdf');

Como funciona:

• MailFacade: Esta classe encapsula toda a lógica necessária para configurar e enviar um email, permitindo ao usuário da fachada simplesmente chamar um método para enviar o email.
• PHPMailer: A complexidade do PHPMailer (como configuração SMTP, autenticação, etc.) está oculta na fachada.

Benefícios:

• Simplicidade: O código do cliente (que usa MailFacade) não precisa saber detalhes como configuração do servidor, métodos PHPMailer, etc.
• Reutilizável: A fachada pode ser usada em diferentes partes da aplicação sem a necessidade de repetir código ou lógica.
• Sustentável: Se algo na implementação precisar mudar (por exemplo, trocar o servidor SMTP), você só precisará atualizá-lo dentro da classe MailFacade.

Este é um exemplo prático de como o padrão Facade pode simplificar interações com bibliotecas complexas como PHPMailer.