Basis-Modul

Modulbeschreibung

Dieses Modul wird als Basis für diverse digidesk-Module verwendet und bietet und verschiedene Programmiertechnische Grundfunktionen wie z.B. erleichterte Handhabung der Konfigurations-Funktionen, Versions- und Updatemanagement, eine Basis für Cronjobs oder Vorlagen für die Backend Ansichten. Außerdem bietet es eine einfache Möglichkeit die Caches des Shops zu leeren.

Das Modul ist kostenfrei erhältlich unter https://www.digidesk.de/produkte/basis-modul/

Systemvoraussetzungen

PHP-Version OXID 6

• PHP 7.4 - 8.1 (OXID 6.5.x)

PHP-Version OXID 7

• PHP 8.0 - 8.1 (OXID 7.0.x - 7.1.x)

• PHP 8.2 (OXID 7.1.x)

• PHP 8.3 (OXID 7.2.x)

Webserver-Konfiguration

• IonCube Loader (mind. v5.0)

Kompatibel mit den Themes

• Flow (OXID 6)

• RoxIVE (OXID 6)

• Wave (OXID 6 und 7.0)

• Apex ab OXID 7.0

Kompatibel mit den OXID Versionen

• OXID CE/PE/EE 6.5.x

• OXID CE/PE/EE 7.0.x bis 7.2.x

Installation

Ab OXID 6 / 7

In der Modulversion 3.0.0 - 3.0.7 für OXID 7 wird das Modul für die Template-Engines "Smarty" und "Twig" unterschiedlich ausgeliefert. Bitte verwenden Sie daher die Zip-Datei (Dateiname beachten) entsprechend der in Ihrem Shop verwendeten Template-Engine.

1. Erstellen Sie den Verzeichnispfad "packages/digidesk" in der selben Verzeichnisebene, in der die Ordner "source" und "vendor" liegen.

2. Für das Basis-Modul erstellen Sie nun einen weiteren Unterordner "base", in den die heruntergeladene Zip-Datei entpackt wird.

3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus:

   composer config repositories.digidesk '{"type":"path", "url": "./packages/digidesk/*"}' 
   composer require digidesk/base

4. Nun kann das Modul im OXID eShop Admin aktiviert werden.

5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren.

6. Bitte fahren Sie nun mit der Einrichtung des Moduls fort.

Update

Ab OXID 6 / 7

In der Modulversion 3.0.0 - 3.0.7 für OXID 7 wird das Modul für die Template-Engines "Smarty" und "Twig" unterschiedlich ausgeliefert. Bitte verwenden Sie daher die Zip-Datei (Dateiname beachten) entsprechend der in Ihrem Shop verwendeten Template-Engine.

1. Entpacken Sie die neue Modulversion in den Ordner "packages/digidesk/base".

2. Deaktivieren Sie das Modul im OXID eShop Admin.

3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus:

   composer update digidesk/base

4. Die Frage, ob Dateien des Pakets überschrieben werden sollen, bestätigen Sie bitte mit "Y".

5. Aktivieren Sie das Modul im OXID eShop Admin.

6. Ggf. Tmp-Verzeichnis leeren und Views neu generieren.

Backend-Einstellungen

1. Wechseln Sie im Backend-Bereich zu "Erweiterungen" und klicken Sie auf "Module".

2. Es öffnet sich ein Fenster, wo Ihre Module aktiviert und deaktiviert werden können.

3. Gehen Sie auf das Basis-Modul. Dort befindet sich der Reiter "Einstell." in dem Sie alle Einstellungsmöglichkeiten des Basis Moduls finden.

• Mediendateien shopabhängig verwenden (nur für OXID 6): Wenn diese Option aktiviert ist, werden die Mediendateien die über die Mediathek hochgeladen werden nicht zwischen den Mandanten geteilt. Diese Einstellung hat nur dann einen Effekt, wenn Sie eine Enterprise oder B2B Edition von OXID verwenden.

• Benutzerdefinierte Theme-ID: In verschiedenen Templates unserer Module werden 4 Grund-Themes unterschiedlich behandelt: Azure, Flow, Wave und Roxive. Falls Sie Ihr eigenes Theme einsetzen, welches wie eines der 4 Hauptthemes behandelt werden soll - können Sie Ihre eigene Theme-ID hier eintragen und bei "Theme nachahmen" ein Eltern-Theme zuweisen. Die Theme-ID sollte aus mindestens 2 Zeichen bestehen.

• Theme nachahmen: Falls Sie Ihr eigenes Theme einsetzen, welches wie eines der 4 Hauptthemes behandelt werden soll, wählen Sie das passende Elterntheme hier aus. Die ID Ihres Themes sollte im oberen Feld "Benutzerdefinierte Theme-ID" eingetragen werden und sollte aus mindestens 2 Zeichen bestehen.

• Cronjob Schlüssel: In diesem Feld wird standardmäßig eine zufällig generierte Zeichenfolge erstellt und gespeichert. Dieser Schlüssel wird zum Aufruf von Cronjobs die mit Hilfe der neuen Cronjob-Grundfunktionen aus dem Basis Modul erstellt wurden benötigt. Wenn Sie diesen Cronjob Schlüssel benötigen, werden Sie darauf im Bereich Cronjob der Dokumentation des jeweiligen Moduls hingewiesen.

• Cache Clear: Wählen Sie hier die Caches aus, die gelöscht werden sollen, wenn Sie den "Alle Caches leeren"-Button in der linken Navigation oben des Backends klicken.

• jQuery Einbindung im Frontend (ab v3.0.5) Über die Moduloption kann ausgewählt werden, ob jQuery aus dem Basismodul im Frontend eingebunden werden soll. Bei aktivierter Option wird jQuery v3.7.1 mit jQuery Migrate v3.5.0 im Frontend geladen.

"Alle Caches leeren" - Button

Dieser Button ermöglicht es Ihnen im Backend den Shop-Cache mit nur einem Klick zu leeren. Dieser Schritt ist in der Regel nach jeder Modulinstallation und jedem Modulupdate notwendig.

Welche Caches dieser Button löscht, können Sie wie unter "Backend-Einstellungen" beschrieben selbst entscheiden. Standardmäßig werden der Sprach-Cache, der Datenbank-Cache, der Smarty-Cache sowie der Seo-Cache gelöscht. Optional kann über die Moduleinstellungen die Option "tmp-Verzeichnis" hinzugefügt werden. Mit dieser Option wird das tmp-Verzeichnis des Shops komplett geleert. Bei Bedarf kann mit dem Dreieck im rechten Bereich des Buttons ein einzelner Cache zum Leeren ausgewählt und mit einem weiteren Klick auf den Button geleert werden.

Nach einer Cache Leerung ist es vollkommen normal, wenn die Unterseiten Ihres Shops beim ersten Aufruf länger laden, da der gelöschte Cache erst wieder aufgebaut werden muss.

Hilfe & Support

Haben Sie Fragen oder benötigen Sie Hilfe bei der Installation? Gerne bieten wir Ihnen auch einen Installationsservice an. Kontaktieren Sie uns einfach!

• E-Mail: [email protected]

• Telefon: [phone]

• Kontaktformular: https://www.digidesk.de/kontakt