Update 4.0.1.1 ionCube 5.6+7.1 Update Documentation

d3datadevelopment · Feb 4, 2019 · 49cbc3d · 49cbc3d
1 parent dcd10fe
commit 49cbc3d
Show file tree

Hide file tree

Showing 105 changed files with 10,855 additions and 0 deletions.
diff --git a/docs/daux/_index.md b/docs/daux/_index.md
@@ -0,0 +1,2 @@
+Weitere Informationen zum Modul **{$modulename}** finden Sie in unserem Shop:
+[https://www.oxidmodule.com/OXID-eShop/Module/Artikelgutschein-fuer-Oxid-PE.html](https://www.oxidmodule.com/OXID-eShop/Module/Artikelgutschein-fuer-Oxid-PE.html)
diff --git a/docs/daux/changelog/010_Changelog.md b/docs/daux/changelog/010_Changelog.md
@@ -0,0 +1,66 @@
+---
+title: Changelog
+---
+
+##4.0.1.1
+- Einheitliche Schreibweise für d3articlevoucher geändert
+
+##4.0.1.0
+- Anpassung auf Installation via Composer (Metadata Version 2.0)
+- Umstellung der Dokumentation
+
+##4.0.0.1
+- Typo im Sprachbaustein
+- Fehlerhafer Prüfung der Zeitsteuerung an den Rabatten
+- Bug im Zusammenhang mit weiteren Gutscheinen
+
+##4.0.0.0
+- flow-theme Unterstützung
+- Migration auf Oxid eShop 6.0.0
+- Support für 4.10.x/5.3.x eingestellt
+
+##3.1.1.3
+- Bereitstellung für ionCube
+- Verarbeitung von inkonsistenten Daten an Bestellungen (fehlende Zahlungsart/Versandart/Artikelzugriffe)
+
+##3.1.1.2
+- Apache 2.4 - Groß-Kleinschreibung korrigiert
+
+##3.1.1.1
+- Unterstützung für Apache 2.4 (ohne Kompatibilitätsmodus) hergestellt
+
+##3.1.1.0
+- add: Oxid-Flow Themeunterstützung
+- Support für 4.7.x / 5.0.x eingestellt
+
+##3.1.0.0
+- offiziell Verfügbar bis PHP 5.6
+- Integration des Mobile-Themes
+- moduleigene Sprachdateien optimiert sowie quelloffen dem Modul beigelegt
+- kleinere Performanceoptimierungen
+- Update der Installationsanleitung und Vorabprüfung (d3precheck)
+- fix: Aktivprüfung innerhalb der Modulblöcke überarbeitet
+- fix: beim abrufen älterer Bestellbestätigungen standen Selectlisten nicht zur Verfügung
+- add: Einstellung für eine individuelle Pfadangabe
+
+##3.0.0.0
+- Bestellbestätigungsmails können nachträglich generiert werden
+- Umstrukturierung von Moduldateien
+- Benamung des Modulverzeichnisses an die Id des Modules angepasst
+- Umstellung der automatischen Installation auf Modul-Connector basierende Methoden
+- Templates für 5.2.x / 4.9.x hinzugefügt
+- Update precheck
+
+##2.0.0.1
+- Templates für EE 5.0.x und 5.1.x
+- Templates für PE 4.8.x
+- Kompatibilität mit PHP 5.4 hergestellt
+
+##2.0.0.0
+- für OXID 4.7 angepasst
+- integration der automatischen installation
+
+##1.1.1.0
+- metadata.php + picture added
+- ab Version 4.6.0 neuer ordner out\'themeName'\tpl\custom
+- Ordnerstruktur für Datei 'email_order_cust_print.tpl' angepasst
diff --git a/docs/daux/config.json b/docs/daux/config.json
@@ -0,0 +1,78 @@
+{
+    "title": "<i class='fab fa-d3 d3fa-color-blue'></i> Artikelgutscheine",
+    "moduleversion": "4.0.1.1",
+    "titledesc": "für den Oxid eShop",
+    "author": "D³ Data Development",
+    "moduledate": "04.02.2019",
+    "editors": "SK/MG",
+    "tagline": "",
+    "image": "",
+    "ignore": {
+        "files": [],
+        "folders": [".idea"]
+    },
+    "live": {
+        "clean_urls": true
+    },
+    "html": {
+        "theme": "d3",
+        "breadcrumbs": true,
+        "breadcrumb_separator": "Chevrons",
+        "toggle_code": false,
+        "date_modified": true,
+        "date_modified_format": "d.m.Y",
+        "float": false,
+        "inherit_index": true,
+        "auto_landing": true,
+
+        "links": {
+            "Shop": "https://www.oxidmodule.com",
+            "Blog": "https://blog.oxidmodule.com",
+            "Dokumentationen": "https://docs.oxidmodule.com/",
+            "FAQ": "https://faq.oxidmodule.com",
+            "D³ Support-Center": "https://support.shopmodule.com/",
+            "Kontakt": "https://www.oxidmodule.com/kontakt",
+            "Impressum": "https://www.oxidmodule.com/impressum"
+        },
+
+        "powered_by": ""
+    },
+    "languages": {
+        "installation": "Installation",
+        "manual": "Handbuch",
+        "changelog": "Changelog",
+        "support": "Support"
+    },
+    "processor": "d3processor",
+    "language": "de",
+    "strings": {
+        "de": {
+            "CodeBlocks_title": "Code-Blöcke",
+            "CodeBlocks_hide": "Aus",
+            "CodeBlocks_below": "Unterhalb",
+            "CodeBlocks_inline": "Linear",
+            "CodeBlocks_show": "Code-Blöcke anzeigen",
+            "Search_placeholder": "Suchen...",
+            "Link_previous": "Zurück",
+            "Link_next": "Weiter",
+            "Edit_on": "Bearbeiten bei :name:",
+            "View_on_github": "Bei GitHub anzeigen",
+            "View_documentation": "Dokumentation anzeigen",
+            "Table_of_contents": "Inhaltsverzeichnis",
+            "author": "Autor",
+            "moduledate": "Stand",
+            "version": "Version",
+            "editors": "Bearbeiter",
+            "selectversion": "Version wechseln"
+        }
+    },
+    "variables": {
+        "modulename"    : "<i class='fab fa-d3 d3fa-color-blue'></i> Artikelgutscheine",
+        "menutitle"     : "<i class='fab fa-d3 d3fa-color-blue'></i> Artikelgutscheine",
+        "modulefolder"  : "articlevoucher",
+        "modcfgident"   : "d3articlevoucher",
+        "composerident" : "d3/articlevoucher"
+    },
+    "versionselector": false,
+    "versiondirectoryindex": 2
+}
diff --git a/docs/daux/installation/010_Anforderungen/010_Systemanforderungen.md b/docs/daux/installation/010_Anforderungen/010_Systemanforderungen.md
@@ -0,0 +1,22 @@
+---
+title: Systemanforderungen
+---
+
+* PHP Version
+    * 5.6.x bis 7.2.x
+* PHP Decoder
+    * installierter ionCube Loader
+* Shopversionen / -editionen
+    * OXID eShop Professional Edition in Compilation Version 
+        * 6.0.x
+        * 6.1.x
+    * oder OXID eShop Enterprise Edition in Compilation Version 
+        * 6.0.x
+        * 6.1.x
+* D3 Modul-Connector ([kostenfrei bei D3 erhältlich](https://www.oxidmodule.com/connector/)) ab Version 5.1.0.0 
+* Installation via [Composer](https://getcomposer.org)
+* mindestens ein freier Cronjob zur automatischen Ausführung der angelegten Aufgaben
+
+Beachten Sie, dass die Ihnen vorliegende Modulversion entsprechend für **PHP 5.6**, **PHP 7.0**, **PHP 7.1** oder **PHP 7.2** sowie dem auf Ihrem Server vorhandenen Decoder (**ionCube Loader**) kompatibel ist. Im Zweifelsfall kontaktieren Sie uns und nennen den für Ihren Shop genutzten Decoder und die PHP-Version.
+
+Kontrollieren Sie bitte auch, ob diese Modulversion für die von Ihnen eingesetzte Shopedition (Professional Edition (PE) oder Enterprise Edition (EE)) ausgelegt ist. 
diff --git a/docs/daux/installation/010_Anforderungen/050_Vorbereitungen.md b/docs/daux/installation/010_Anforderungen/050_Vorbereitungen.md
@@ -0,0 +1,9 @@
+---
+title: Vorbereitungen
+---
+
+Installieren Sie bitte zuerst unseren Modul-Connector in der erforderlichen Version.
+Ob dies evtl. schon geschehen ist, können Sie im Adminbereich Ihres Shops prüfen. Existiert der Punkt [ D3 Module ] -> [ Modul-Connector ], können Sie die installierte Version unter [ Bibliotheksverwaltung ] ablesen. Fehlt dieser Eintrag, installieren Sie den kostenfreien Connector. 
+Informationen zu dessen Installation finden Sie auf unserer [Homepage](https://www.oxidmodule.com/Connector/).
+
+Klicken Sie auf den Reiter [ Downloads ] und wählen dort das für Ihre Installation passende Paket.
diff --git a/docs/daux/installation/020_Neuinstallation/005_Vorbereitung.md b/docs/daux/installation/020_Neuinstallation/005_Vorbereitung.md
@@ -0,0 +1,9 @@
+---
+title: Vorbereitungen
+---
+
+Installieren Sie bitte zuerst unseren Modul-Connector in der erforderlichen Version. Ob dies evtl. schon geschehen ist, können Sie im Adminbereich Ihres Shops prüfen. 
+Existiert der Punkt [ D3 Module ] -> [ Modul-Connector ], können Sie die installierte Version unter [ Bibliotheksverwaltung ] ablesen. 
+Fehlt dieser Eintrag, laden Sie den Connector kostenfrei von unserer Homepage http://www.oxidmodule.com/Connector/.
+
+Klicken Sie auf den Reiter [ Download ] und dort auf den Link [ Download Erstinstallation Modul-Connector ].
diff --git a/docs/daux/installation/020_Neuinstallation/010_Paketquelle_hinzufuegen.md b/docs/daux/installation/020_Neuinstallation/010_Paketquelle_hinzufuegen.md
@@ -0,0 +1,13 @@
+---
+title: Paketquelle hinzufügen
+---
+
+Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Senden Sie dort diesen Befehl ab:
+
+```bash
+php composer config repositories.d3 composer https://satis.oxidmodule.com
+``` 
+
+> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete.
+   
+> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require).
diff --git a/docs/daux/installation/020_Neuinstallation/020_Modul_hinzufuegen.md b/docs/daux/installation/020_Neuinstallation/020_Modul_hinzufuegen.md
@@ -0,0 +1,11 @@
+---
+title: Modul zur Installation hinzufügen
+---
+
+Führen Sie in der Konsole im selben Verzeichnis diesen Befehl aus, um das Modul **{$modulename}** zur Installation hinzuzufügen:
+
+```bash
+php composer require {$composerident} --update-no-dev
+``` 
+
+> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require).
diff --git a/docs/daux/installation/020_Neuinstallation/030_Verwendung_eigener_Themes.md b/docs/daux/installation/020_Neuinstallation/030_Verwendung_eigener_Themes.md
@@ -0,0 +1,15 @@
+---
+title: Verwendung eigener Themes
+---
+
+Das Modul ist für die Verwendung mit den folgenden OXID-Themes vorbereitet:
+
+* Flow
+* Azure
++ Admin
+
+Verwenden Sie in Ihrem Shop ein angepasstes Verzeichnis für Ihre Templates (neues Theme oder CustomTheme), kopieren Sie die Templates  und / oder die CSS-Dateien in die neuen Ordner. 
+
+Ähnelt Ihr neues Theme technisch einem der OXID-Originale, können Sie dieses darauf umleiten. Childs von originalen OXID- Themes benötigen keine Umleitung.
+
+Weitere Informationen zur Umleitung finden Sie in unserer [FAQ](http://faq.oxidmodule.com/Modulinstallation/Modulanpassungen/themespezifische-Templatebloecke-fuer-eigenes-Theme-verwenden.html).
diff --git a/docs/daux/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md b/docs/daux/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md
@@ -0,0 +1,7 @@
+---
+title: Modul im Shop aktivieren
+---
+
+Aktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ].
+
+> [!] **Enterprise Editon**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen.
diff --git a/docs/daux/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md b/docs/daux/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md
@@ -0,0 +1,11 @@
+---
+title: Shopanpassungen installieren
+---
+
+Direkt nach der Modulaktivierung startet der Assistent, der Sie durch die Shopanpassung führt. Darin können Sie verschiedene Optionen der Installation wählen.
+
+Den Installationsassistenten finden Sie auch unter den Menüpunkten [ Admin ] -> [ D3 Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ].
+
+Bei tiefgreifenden Änderungen an Ihrem Shop (z.B. Hinzufügen weiterer Sprachen oder Mandanten) rufen Sie den Installationsassistenten bitte erneut auf, um dann eventuell notwendige Nacharbeiten für das Modul ausführen zu lassen.
+
+Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen.
diff --git a/docs/daux/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md b/docs/daux/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md
@@ -0,0 +1,9 @@
+---
+title: TMP-Ordner leeren
+---
+
+Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ D3 Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. 
+
+Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
+
+> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
diff --git a/docs/daux/installation/020_Neuinstallation/080_Lizenz_eintragen.md b/docs/daux/installation/020_Neuinstallation/080_Lizenz_eintragen.md
@@ -0,0 +1,7 @@
+---
+title: Lizenzschlüssel eintragen
+---
+
+Das Modul verwendet Lizenzschlüssel, um die Lizenzverwaltung für Sie und auch für uns einfacher zu gestalten. Hierbei haben Sie je nach Modul die Wahl zwischen einer kostenfreien Testlizenz und einer Lizenz für den Einsatz im Livebetrieb.
+
+Rufen Sie zum Anfordern des Lizenzschlüssels die Modulverwaltung im Adminbereich unter [ D3 Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] auf. Klappen Sie den Eintrag des jeweiligen Moduls aus. Sofern erforderlich, können Sie hier den Lizenzassistenten starten, der schnell und einfach ihr Modul aktiviert.
diff --git a/docs/daux/installation/020_Neuinstallation/095_Konfiguration_einstellen.md b/docs/daux/installation/020_Neuinstallation/095_Konfiguration_einstellen.md
@@ -0,0 +1,12 @@
+---
+title: Konfiguration einstellen
+---
+
+### Backend
+
+*  Bestellstatus der Gutscheinartikel anpassen:
+
+    [ Erweiterungen ] -> [ Module ] -> [ {$menutitle} ] -> [Tab: Einstell.] -> [Option: Bestellstatus der Gutscheinartikel]
+
+
+*  Führen Sie die weitere Konfiguration wie beschrieben im Handbuch durch: [manual/Konfiguration.html](manual/Konfiguration.html)
diff --git a/docs/daux/installation/020_Neuinstallation/100_Updatefaehigkeit.md b/docs/daux/installation/020_Neuinstallation/100_Updatefaehigkeit.md
@@ -0,0 +1,7 @@
+---
+title: Updatefähigkeit
+---
+
+Bei individuellen Änderungen von Moduldateien empfehlen wir, jeweils die Überladungsmöglichkeiten des Shops dafür zu verwenden. So brauchen Sie die originalen Moduldateien nicht verändern und erhalten sich so die Updatefähigkeit des Shops und des Moduls. Beachten Sie, dass Moduldateien bei Updateinstallationen überschrieben werden.
+
+Weitere Informationen zu den Überladungsmöglichkeiten verschiedener Dateien finden Sie in unserer [FAQ](http://faq.oxidmodule.com/Modulinstallation/Modulanpassungen/).
diff --git a/docs/daux/installation/020_Neuinstallation/_index.md b/docs/daux/installation/020_Neuinstallation/_index.md
@@ -0,0 +1,13 @@
+---
+Title: Schnellstart per Composer
+---
+
+## Schnellstart per Composer
+
+```bash
+php composer config repositories.d3 composer https://satis.oxidmodule.com
+
+php composer require {$composerident} –-update-no-dev
+```
+
+Detailliertere Angaben zur Installation entnehmen Sie bitte den folgenden Schritten.
diff --git a/docs/daux/installation/030_Update/010_Modul_deaktivieren.md b/docs/daux/installation/030_Update/010_Modul_deaktivieren.md
@@ -0,0 +1,5 @@
+---
+title: Modul deaktivieren
+---
+
+Deaktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ].
diff --git a/docs/daux/installation/030_Update/020_Dateien_erneuern.md b/docs/daux/installation/030_Update/020_Dateien_erneuern.md
@@ -0,0 +1,14 @@
+---
+title: Dateien erneuern
+---
+
+Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres 
+Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Führen Sie dort diesen Befehl aus:
+
+```bash
+php composer update {$composerident} --no-dev
+```
+
+> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete.
+
+> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require).
diff --git a/docs/daux/installation/030_Update/040_Modulinformationen_aktualisieren.md b/docs/daux/installation/030_Update/040_Modulinformationen_aktualisieren.md
@@ -0,0 +1,5 @@
+---
+title: Modulinformationen aktualisieren
+---
+
+Wechseln Sie im Adminbereich zu [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ].
diff --git a/docs/daux/installation/030_Update/050_Shopanpassungen_installieren.md b/docs/daux/installation/030_Update/050_Shopanpassungen_installieren.md
@@ -0,0 +1,11 @@
+---
+title: Shopanpassungen installierren
+---
+
+Ob Shopanpassungen notwendig sind, ist von der Versionsänderung des Moduls abhängig.
+
+Möglicherweise sehen Sie nach dem Neuaktivieren des Moduls den Installationsassistent, der Sie durch die Änderungen führt. Folgen Sie dann den einzelnen Schritten. Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen.
+
+Wird der Assistent nicht gezeigt (Sie sehen wieder die Modulübersicht), waren keine Anpassungen am Shop notwendig.
+
+Ob erforderliche Updates ausgeführt werden sollen, können Sie jederzeit im Adminbereich unter [ D3 Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ] prüfen.
diff --git a/docs/daux/installation/030_Update/060_TMP-Ordner_leeren.md b/docs/daux/installation/030_Update/060_TMP-Ordner_leeren.md
@@ -0,0 +1,9 @@
+---
+title: TMP-Ordner leeren
+---
+
+Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ D3 Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. 
+
+Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
+
+> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
diff --git a/docs/daux/installation/030_Update/070_Lizenzschluessel_aktualisieren.md b/docs/daux/installation/030_Update/070_Lizenzschluessel_aktualisieren.md
@@ -0,0 +1,5 @@
+---
+title: Lizenzschlüssel aktualisieren
+---
+
+Wird für die neue Modulversion ein aktualisierter Lizenzschlüssel benötigt, tragen Sie diesen im Adminbereich unter [ D3 Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] ein. Klappen Sie dazu den Eintrag des jeweiligen Moduls aus und starten den Lizenzassistent.
diff --git a/docs/daux/installation/030_Update/080_Erweiterungen_anpassen.md b/docs/daux/installation/030_Update/080_Erweiterungen_anpassen.md
@@ -0,0 +1,5 @@
+---
+title: Erweiterungen anpassen
+---
+
+Haben Sie für dieses Modul eigene Erweiterung entwickelt, gleichen Sie dies bitte mit der neuen Fassung des Moduls ab.