complete readme

README.md

@@ -8,6 +8,53 @@ Auf der Konsole im Shoproot (oberhalb von source und vendor) folgenden Befehl au
 php composer require d3/datawizard:"dev-rel_1.x"
 ``` 
 
+# Funktion
+
+Das Modul `DataWizard` bietet ein Framework zur einfachen Integration von Exporten über den Adminbereich des OXID Shops.
+
+Die Exporte werden über Datenbankabfragen oder fertige Datenlisten definiert. Es stehen verschiedene Exportformate zur Verfügung. Die Generierung ist jederzeit und immer wiederkehrend möglich (im Rahmen der Systemgrenzen). Diese werden im Browser als Download angeboten.
+
+Alle Exporte sind für eine bessere Übersichtlichkeit in Gruppen zusammengefasst.
+
+Im Lieferumfang sind Beispielexporte enthalten. Diese sollen als Implementierungsreferenz für individuelle Exporte dienen. Die Anzeige der Beispielexporte kann in den Modulgrundeinstellungen deaktiviert werden.
+
+# Erweiterbarkeit
+
+Das Modul stellt das technische Grundgerüst der Exporte dar und erhebt keinen Anspruch auf Vollständigkeit. Um den Umfang an die individuellen Anforderungen anzupassen, sind folgende Erweiterungen vorbereitet:
+
+- Exporte hinzufügen
+- Verwendung bestehender und neuer Gruppen
+- Exportformate ergänzen
+
+Unabhängig dessen stehen alle Erweiterungsmöglichkeiten zur Verfügung, die der OXID Shop für Module bereitstellt.
+
+## Exporte hinzufügen
+
+### Export definieren
+
+Jeder Export wird in einer separaten Klasse definiert. Diese Exportklasse muss die Klasse `D3\DataWizard\Application\Model\ExportBase` erweitern. Darin sind alle nötigen Funktionen vordefiniert. Folgende Methoden stehen hierbei zur Verfügung:
+
+#### verpflichtende Methodenaufrufe:
+- getTitle() - definiert den Titel im Adminbereich und die Basis des späteren Exportdateinamens
+- getQuery() - enthält den Abfragequery als prepared statement, der die zu exportierenden Daten definiert
+
+#### optionale Methodenaufrufe:
+- getDescription() - enthält eine kurze zusätzliche Beschreibung des Exports, dieser wird im Adminbereich gezeigt
+- getButtonText() - definiert den Text des Absenden-Buttons im Adminbereich
+- getExportFilenameBase() - definiert die Basis des späteren Exportdateinamens
+- executeQuery() - liefert die zusammengestellten Exportdaten
+- weitere Methoden, deren Anpassung jedoch zum geänderten Modulverhalten führen können und daher nur mit Vorsicht zu verändern sind
+
+### Exporte registrieren
+
+Um den erstellten Export auch im Modul verwenden zu können, muss dieser noch registriert werden. Hierzu gibt des die Klasse `D3\DataWizard\Application\Model\Configuration`. Diese ist mit den Möglichkeiten des OXID Shops zu überladen und die darin enthaltene Methode `configure()` zu ergänzen. Für die Registrierung eines Exportes steht Ihnen dazu folgender Aufruf zur Verfügung:
+
+```
+$this->registerExport(self::GROUP_CATEGORY, oxNew(myCustomExport::class));
+```
+
+Der erste Parameter enthält den Sprachident für die Exportgruppe. In Konstanten der configuration-Klasse sind schon typische Idents vorbereitet. Als 2. Parameter wird die Instanz der Exportklasse erwartet.
+
 # Lizenzen
 
 ### league/csv [MIT]