Documentatie · Technische documentatie

Technische documentatie

Dit document is het startpunt voor de technische documentatie van de ADP Car Market Hub WordPress plugin. Het legt uit wat de technische sectie behandelt, voor wie deze is geschreven en hoe de afzonderlijke documenten samenhangen.

Wanneer u dit document moet gebruiken

Lees dit document als u een:

Ontwikkelaar bent die moet begrijpen hoe de plugin is gestructureerd voordat u templates, hooks of integraties aanpast.
Sitebeheerder bent die wil weten welke databasetabellen, opties en geplande taken de plugin gebruikt op een WordPress-installatie.
Integrator bent die een implementatie, een omgevingsbeoordeling of een beveiligingsbeoordeling van de plugin moet plannen.

Eindgebruikers die alleen voertuigadvertenties, leads of ontwerpopties willen beheren, moeten in plaats daarvan beginnen met de op de gebruiker gerichte secties van de documentatie.

Overzicht

ADP Car Market Hub is een WordPress plugin die voertuigadvertenties importeert uit de AutoScout24 API en deze publiceert op een WordPress site. De plugin is geïmplementeerd in PHP met behulp van WordPress core-API's (custom post types, taxonomieën, opties, WP-Cron, REST API, AJAX, transients en door dbDelta beheerde aangepaste tabellen).

De technische documentatie beschrijft:

De architectuur op hoog niveau en de verantwoordelijkheden van de belangrijkste PHP-klassen onder includes/.
De bootstrap-volgorde, activering, deactivering en verwijderingsstromen.
Het datamodel dat de basis vormt voor voertuigen, leads en functies voor bezoekers, zoals Zoekalerts en Analytics.
De aangepaste databasetabellen die zijn gemaakt via dbDelta en de postmeta-sleutels die in wp_postmeta behouden blijven voor achterwaartse compatibiliteit.
De integratie-oppervlakken (REST-endpoints, AJAX-acties, webhooks, shortcodes, template-overrides) waarop andere code kan voortbouwen.

De documenten in deze sectie zijn referentiemateriaal. Ze beschrijven gedrag dat zichtbaar is in de broncode van de plugin op het moment van schrijven. Verifieer het gedrag met de huidige plugin-versie voordat u hierop vertrouwt voor productiewerk.

Vereisten of randvoorwaarden

Voordat u de technische documenten leest, moet u beschikken over:

Een werkende WordPress ontwikkelomgeving die voldoet aan de verklaarde vereisten van de plugin: WordPress 6.2 of nieuwer en PHP 8.1 of nieuwer (zie de plugin-header in adp-car-market-hub.php en readme.txt).
Een algemeen begrip van WordPress plugin-ontwikkeling (hooks, custom post types, options API, WP-Cron en de REST API).
Basisbekendheid met de WordPress databaselaag ($wpdb, dbDelta, postmeta en transients).
Toegang tot de broncode van de plugin als u de klassen en constanten die in de documentatie worden genoemd, wilt kruisverwijzen.

Er zijn geen externe accounts vereist om de documentatie te lezen. Om de importfuncties in de praktijk te gebruiken, heeft u bovendien geldige AutoScout24 API-inloggegevens en ten minste één geconfigureerde verkoper nodig. De configuratie van die inloggegevens wordt behandeld in de op de gebruiker gerichte installatiedocumentatie.

Hoe deze sectie is georganiseerd

De technische documentatie is opgedeeld in gerichte documenten. De belangrijkste startpunten worden hieronder vermeld; raadpleeg de sectie-index voor de volledige lijst.

Architecture Overview — overzicht op hoog niveau van de belangrijkste klassen, namespaces en hoe functies tijdens runtime aan elkaar zijn gekoppeld.
Plugin Bootstrap And Lifecycle — volgorde van uitvoering vanaf het laden van de plugin tot activering, normale verwerking van verzoeken en deactivering.
Data Model — logische entiteiten (voertuigen, leads, zoekagenten, analytics-gebeurtenissen) en hoe ze worden toegewezen aan WordPress opslag.
Database Schema — de aangepaste door dbDelta beheerde tabellen die door de plugin zijn gemaakt, inclusief kolommen en indexen.

Volgende documenten gaan dieper in op specifieke subsystemen zoals de importer, de afbeeldingswachtrij, de REST API, AJAX-acties en het templatesysteem.

Conventies gebruikt in deze sectie

Klassennamen worden geschreven in hun volledig gekwalificeerde vorm met behulp van de AS24CI\ namespace (bijvoorbeeld AS24CI\Plugin, AS24CI\Vehicle_Repository).
Optiesleutels worden geciteerd als strings (bijvoorbeeld as24ci_db_version) en, waar van toepassing, wordt verwezen naar de AS24CI\Options constante die ze definieert.
Databasetabellen worden geschreven zonder het WordPress tabelvoorvoegsel (bijvoorbeeld as24_vehicles); de werkelijke tabelnaam op een bepaalde site is {$wpdb->prefix} gevolgd door het achtervoegsel.
Hooks worden aangeduid met hun action- of filter-tag (bijvoorbeeld as24ci_scheduled_import).

Wanneer gedrag configureerbaar is, vermeldt de documentatie de optie, filter of constante die dit regelt. Wanneer iets niet kan worden bevestigd uit de broncode, vermeldt de documentatie dit expliciet. Verifieer elk grensgeval in de huidige plugin-versie voordat u op basis daarvan advies aan klanten publiceert.

Operationele opmerkingen

De technische documentatie bevat geen inloggegevens, klantgegevens, interne URL's, Seller IDs of andere vertrouwelijke waarden. Voorbeeldwaarden in codefragmenten zijn rechtstreeks overgenomen uit de broncode van de plugin en dienen uitsluitend ter illustratie.
De plugin gebruikt een autoloader in PSR-4-stijl die is geregistreerd in adp-car-market-hub.php. Klassen onder de AS24CI\ namespace worden op aanvraag geladen vanuit includes/ en includes/admin/. Dit is relevant bij het toevoegen van aangepaste integraties die afhankelijk zijn van plugin-klassen.
Alle vertaalbare strings in de plugin gebruiken het adp-car-market-hub textdomain. De technische documentatie zelf is alleen in het Engels.

Probleemoplossing

Dit startdocument beschrijft geen specifieke fouten. Als u een probleem onderzoekt, begin dan met het document dat betrekking heeft op het betreffende subsysteem (bijvoorbeeld Cron Events And Scheduler voor problemen met de importplanning, of Database Schema voor tabelgerelateerde fouten). Elk subsysteemdocument bevat waar van toepassing zijn eigen opmerkingen over probleemoplossing.