Das Adapter Design Pattern ist ein Strukturmuster, das die Zusammenarbeit von Objekten mit inkompatiblen Schnittstellen ermöglicht. Es fungiert als Vermittler (oder Adapter) zwischen zwei Objekten und wandelt die Schnittstelle eines Objekts in die vom anderen Objekt erwartete Schnittstelle um. Dadurch können Klassen, die ansonsten inkompatibel wären, weil sie unterschiedliche Schnittstellen haben, ohne Änderungen an ihrem ursprünglichen Code zusammenarbeiten.

Adapterstruktur

Das Adaptermuster besteht im Allgemeinen aus drei Hauptelementen:

• Client: Die Klasse, die mit Objekten einer bestimmten Schnittstelle arbeiten soll.
• Adaptee: Die Klasse, die über eine Schnittstelle verfügt, die mit dem Client nicht kompatibel ist, deren Funktionalitäten jedoch erforderlich sind.
• Adapter: Die Klasse, die die vom Client erwartete Schnittstelle implementiert und Aufrufe in die Adaptee-Schnittstelle konvertiert.

Typen von Adaptern

1. Objektadapter: Kompositionsbasiert. Der Adapter enthält eine Instanz der Klasse, die er anpasst.
2. Klassenadapter: Vererbungsbasiert (normalerweise in Sprachen, die Mehrfachvererbung unterstützen).

Wann sollte der Adapter verwendet werden?

• Wenn Sie eine vorhandene Klasse verwenden möchten, deren Schnittstelle jedoch nicht den Erwartungen des Clients entspricht.
• Um neue Funktionalität in ein Altsystem zu integrieren, ohne den alten Code ändern zu müssen.

Dieses Muster ist nützlich in Systemen, die mit externen Bibliotheken oder APIs arbeiten müssen, sodass Sie deren Funktionalität anpassen können, ohne den Code dieser Bibliotheken zu ändern.

Beispiel mit PHPMailer

Hier ist ein Beispiel dafür, wie Sie das Adapter Design Pattern verwenden, um PHPMailer mit einer benutzerdefinierten Schnittstelle zu integrieren.

Situation:

Angenommen, Ihr System erwartet, dass jede E-Mail-Versandklasse eine Schnittstelle namens IMailer implementiert, aber PHPMailer folgt dieser Schnittstelle nicht direkt. Der Adapter wird verwendet, um PHPMailer an die vom System erwartete Schnittstelle anzupassen.

PHPMailer über Composer installieren

composer require phpmailer/phpmailer

Verzeichnissystem

?Adapter
 ┣ ?src
 ┃ ┣ ?Interfaces
 ┃ ┃ ┗ ?IMailer.php
 ┃ ┣ ?Adapters
 ┃ ┃ ┗ ?PHPMailerAdapter.php
 ┃ ┗ ?Services
 ┃   ┗ ?ServicoDeEmail.php
 ┣ ?vendor
 ┣ ?composer.json
 ┗ ?index.php

Autoload

Fügen Sie in der Datei „composer.json“ (im Stammverzeichnis des Projekts) den App-Namespace hinzu, um die Klassen automatisch zu laden:

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

Schnittstelle IMailer

namespace App\Interfaces;

interface IMailer {
    public function send($to, $subject, $message);
}

Klasse PHPMailerAdapter

namespace App\Adapters;

use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\Exception;
use App\Interfaces\IMailer;

class PHPMailerAdapter implements IMailer {
    private $phpMailer;

    public function __construct() {
        $this->phpMailer = new PHPMailer(true);

        // Basic PHPMailer configuration
        $this->phpMailer->isSMTP();
        $this->phpMailer->Host = 'smtp.example.com';
        $this->phpMailer->SMTPAuth = true;
        $this->phpMailer->Username = '[email protected]';
        $this->phpMailer->Password = 'password';
        $this->phpMailer->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
        $this->phpMailer->Port = 587;
        $this->phpMailer->setFrom('[email protected]', 'Your Name');
    }
}

• Methode senden

public function send($to, $subject, $message) {
    try {
        $this->phpMailer->addAddress($to);
        $this->phpMailer->Subject = $subject;
        $this->phpMailer->Body = $message;
        $this->phpMailer->send();
        echo 'Email sent successfully!';
    } catch (Exception $e) {
        echo "Failed to send email: {$this->phpMailer->ErrorInfo}";
    }
}

Klasse EmailService

namespace App\Services;

use App\Interfaces\IMailer;

class EmailService {
    private $mailer;

    public function __construct(IMailer $mailer) {
        $this->mailer = $mailer;
    }
}

• Methode sendEmailToClient

public function sendEmailToClient($to, $subject, $message) {
    $this->mailer->send($to, $subject, $message);
}

Datei index.php

require 'vendor/autoload.php';

use App\Adapters\PHPMailerAdapter;
use App\Services\EmailService;

// Creating the PHPMailer Adapter
$mailer = new PHPMailerAdapter();

// Using the email service with the IMailer interface
$emailService = new EmailService($mailer);

// Sending an email
$emailService->sendEmailToClient('[email protected]', 'Email Subject', 'Message content.');

Erläuterung der Struktur

• IMailer.php: Definiert die IMailer-Schnittstelle, die jedes E-Mail-System implementieren sollte.
• PHPMailerAdapter.php: Passt PHPMailer an die IMailer-Schnittstelle an.
• EmailService.php: E-Mail-Dienst, der die IMailer-Schnittstelle zum Versenden von E-Mails verwendet.
• index.php: Hauptdatei, die den E-Mail-Dienst zum Senden einer Nachricht verwendet.