Dokumentation · Technische Dokumentation

Technische Dokumentation

Dieses Dokument ist der Einstieg in die technische Dokumentation für das ADP Car Market Hub WordPress Plugin. Es erklärt, was der technische Bereich abdeckt, für wen er geschrieben wurde und wie die einzelnen Dokumente zueinander in Beziehung stehen.

Wann Sie dieses Dokument verwenden sollten

Lesen Sie dieses Dokument, wenn Sie:

Ein Entwickler sind, der verstehen muss, wie das Plugin strukturiert ist, bevor er Templates, Hooks oder Integrationen anpasst.
Ein Website-Administrator sind, der wissen möchte, welche Datenbanktabellen, Optionen und geplanten Events das Plugin auf einer WordPress-Installation verwendet.
Ein Integrator sind, der ein Deployment, eine Umgebungsprüfung oder eine Sicherheitsüberprüfung des Plugins planen muss.

Endbenutzer, die lediglich Fahrzeugbestände, Leads oder Designoptionen verwalten möchten, sollten stattdessen mit den benutzerorientierten Bereichen der Dokumentation beginnen.

Übersicht

ADP Car Market Hub ist ein WordPress Plugin, das Fahrzeugbestände von der AutoScout24 API importiert und auf einer WordPress-Website veröffentlicht. Das Plugin ist in PHP unter Verwendung von WordPress-Core-APIs implementiert (Custom Post Types, Taxonomien, Optionen, WP-Cron, REST-API, AJAX, Transients und von dbDelta verwaltete benutzerdefinierte Tabellen).

Die technische Dokumentation beschreibt:

Die übergeordnete Architektur und die Zuständigkeiten der wichtigsten PHP-Klassen unter includes/.
Die Bootstrap-Sequenz, Aktivierungs-, Deaktivierungs- und Deinstallations-Flows.
Das Datenmodell, das Fahrzeugen, Leads und besucherseitigen Funktionen wie Suchaufträgen und Analytics zugrunde liegt.
Die benutzerdefinierten Datenbanktabellen, die über dbDelta erstellt wurden, und die Postmeta-Keys, die aus Gründen der Abwärtskompatibilität in wp_postmeta verbleiben.
Die Integrationsflächen (REST-Endpunkte, AJAX-Aktionen, Webhooks, Shortcodes, Template-Overrides), auf denen anderer Code aufbauen kann.

Die Dokumente in diesem Bereich sind Referenzmaterial. Sie beschreiben das Verhalten, das im Plugin-Quellcode zum Zeitpunkt der Erstellung sichtbar ist. Überprüfen Sie das Verhalten anhand der aktuellen Plugin-Version, bevor Sie sich bei produktiven Arbeiten darauf verlassen.

Anforderungen oder Voraussetzungen

Bevor Sie die technischen Dokumente lesen, sollten Sie über Folgendes verfügen:

Eine funktionierende WordPress-Entwicklungsumgebung, die die deklarierten Anforderungen des Plugins erfüllt: WordPress 6.2 oder neuer und PHP 8.1 oder neuer (siehe Plugin-Header in adp-car-market-hub.php und readme.txt).
Ein allgemeines Verständnis der WordPress-Plugin-Entwicklung (Hooks, Custom Post Types, Options-API, WP-Cron und die REST-API).
Grundlegende Vertrautheit mit der WordPress-Datenbankschicht ($wpdb, dbDelta, Postmeta und Transients).
Zugriff auf den Plugin-Quellcode-Baum, wenn Sie die in der Dokumentation erwähnten Klassen und Konstanten abgleichen möchten.

Es sind keine externen Konten erforderlich, um die Dokumentation zu lesen. Um die Importfunktionen in der Praxis zu nutzen, benötigen Sie zusätzlich gültige AutoScout24 API-Zugangsdaten und mindestens einen konfigurierten Händler. Die Konfiguration dieser Zugangsdaten wird in der benutzerorientierten Einrichtungsdokumentation behandelt.

Wie dieser Bereich organisiert ist

Die technische Dokumentation ist in zielgerichtete Dokumente unterteilt. Die wichtigsten Einstiegspunkte sind unten aufgeführt; die vollständige Liste finden Sie im Bereichsverzeichnis.

Architektur-Übersicht — übergeordnete Übersicht der wichtigsten Klassen, Namespaces und wie Funktionen zur Laufzeit miteinander verknüpft sind.
Plugin-Bootstrap und Lebenszyklus — Ausführungsreihenfolge vom Laden des Plugins über die Aktivierung, die normale Anfrageverarbeitung und die Deaktivierung.
Datenmodell — logische Entitäten (Fahrzeuge, Leads, Suchagenten, Analytics-Events) und wie sie dem WordPress-Speicher zugeordnet werden.
Datenbankschema — die vom Plugin erstellten, benutzerdefinierten und von dbDelta verwalteten Tabellen, einschließlich Spalten und Indizes.

Nachfolgende Dokumente befassen sich eingehender mit spezifischen Subsystemen wie dem Importer, der Bildwarteschlange, der REST-API, AJAX-Aktionen und dem Template-System.

In diesem Bereich verwendete Konventionen

Klassennamen werden in ihrer vollqualifizierten Form unter Verwendung des AS24CI\-Namespaces geschrieben (zum Beispiel AS24CI\Plugin, AS24CI\Vehicle_Repository).
Option-Keys werden als Strings in Anführungszeichen gesetzt (zum Beispiel as24ci_db_version) und, falls zutreffend, wird auf die AS24CI\Options-Konstante verwiesen, die sie definiert.
Datenbanktabellen werden ohne das WordPress-Tabellenpräfix geschrieben (zum Beispiel as24_vehicles); der tatsächliche Tabellenname auf einer bestimmten Website ist {$wpdb->prefix} gefolgt vom Suffix.
Hooks werden durch ihr Action- oder Filter-Tag referenziert (zum Beispiel as24ci_scheduled_import).

Wenn ein Verhalten konfigurierbar ist, nennt die Dokumentation die Option, den Filter oder die Konstante, die es steuert. Wenn etwas aus dem Quellcode nicht bestätigt werden kann, wird dies in der Dokumentation explizit erwähnt. Überprüfen Sie jeden Grenzfall in der aktuellen Plugin-Version, bevor Sie darauf basierende Richtlinien für Kunden veröffentlichen.

Betriebliche Hinweise

Die technische Dokumentation enthält keine Zugangsdaten, Kundendaten, internen URLs, Händler-IDs oder andere vertrauliche Werte. In Codebeispielen gezeigte Beispielwerte stammen direkt aus der Plugin-Quelle und dienen nur zur Veranschaulichung.
Das Plugin verwendet einen in adp-car-market-hub.php registrierten Autoloader im PSR-4-Stil. Klassen unter dem Namespace AS24CI\ werden bei Bedarf aus includes/ und includes/admin/ geladen. Dies ist relevant, wenn benutzerdefinierte Integrationen hinzugefügt werden, die von Plugin-Klassen abhängen.
Alle übersetzbaren Strings im Plugin verwenden die Textdomäne adp-car-market-hub. Die technische Dokumentation selbst ist in englischer Sprache verfasst.

Fehlerbehebung

Dieses Einstiegsdokument beschreibt keine spezifischen Fehler. Wenn Sie ein Problem untersuchen, beginnen Sie mit dem Dokument, das das betroffene Subsystem abdeckt (z. B. Cron-Events und Scheduler bei Problemen mit der Importplanung oder Datenbankschema bei tabellenbezogenen Fehlern). Jedes Subsystem-Dokument enthält gegebenenfalls eigene Hinweise zur Fehlerbehebung.