=======================================
Systemvorraussetzungen und Installation
=======================================

Systemvorraussetzungen
======================

#. Mindestens PHP 7.4.0
#. OXID Shop Community oder Professional 6.1.0 - 6.5.0

Im Zweifelsfall kontaktieren Sie uns und nennen Sie uns die eingesetzte Shopversion sowie die genutzte PHP-Version.

Erstinstallation
================

1. Lokales Repository anlegen

Erstellen Sie den Verzeichnispfad "packages/ysquare" in der selben Verzeichnisebene, in der die Ordner "source" und "vendor" liegen.
Entpacken Sie die heruntergeladenen ZIP Dateien dort.


2. Composer Installation

Führen Sie anschließend folgende Befehle aus dem Hauptverzeichnis des Shopsystems aus:

   - composer config repositories.ysquare '{"type":"path", "url": "./packages/ysquare/*"}'
   - composer require --update-no-dev ysquare/ys_giftcert


3. Modul im Shop aktivieren

Aktivieren Sie das Modul über den Shopadmin unter **Erweiterungen** --> **Module**.


4. tmp-Ordner leeren

Leeren Sie nach dem Aktivieren des Moduls das Verzeichnis *tmp* und *tmp/smarty* auf Ihrem Server. Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies ebenfalls durch.


5. Modulkonfiguration

Im Admin-Bereich des OXID eShops können Sie direkt im Modul spezifische Einstellungen machen, die sich an Ihren Anforderungen orientieren.


6. Updatefähigkeit

Sollten Sie individuelle Änderungen an den Moduldateien vornehmen, empfehlen wir die Überladungsmöglichkeiten des Shops dafür zu verwenden, damit die originalen Moduldateien nicht verändert werden und Sie die Updatefähigkeit des Moduls erhalten.
Dies gilt auch für die Variablen Teile, wie das Template für die PDF Generierung. Ein Beispiel wie dies funktioniert finden Sie im Kapitel Konfiguration.

.. note::  Bei der Modulinstallation werden zusätzliche Datenbanktabellen/Felder angelegt. Eine Übersicht der Zusatzfelder können wir bei Bedarf gerne zukommen lassen.




Einrichtung cronjobs
--------------------

Über die cronjobs werden zeitlich gesteuerte Aufgaben angestoßen. Die Einrichtung der cronjobs unterscheidet sich ggfs. bei den einzelnen Providern. Wie dies bei Ihrem Provider funktioniert, erfragen Sie bitte direkt dort.

Ein Beispiel für einen Cron-Task finden Sie in der Datei *executeCronTasks.php* im Hauptverzeichnis. Wann Sie einen Cronjob benötigen und wofür dieser genutzt wird, wird im Kapitel *Konfiguration* beschrieben.


Update
======

1. Backup und Modul im Shop deaktivieren

Erstellen Sie eine Backup-Datei des bereits installierten Moduls.
Deaktivieren Sie das Modul über den Shopadmin unter **Erweiterungen** --> **Module**.
Wählen Sie das Gutschein-Modul an und klicken Sie anschließend auf **Deaktivieren**.-

2. Aktualisieren der Modul-Dateien

Legen Sie die neuen Moduldateien im packages/ysquare Ordner ab (siehe Erstinstallation).
Aktualisieren Sie den Eintrag in der composer.json mit der neuen Versionsnummer.
Führen Sie 'composer update --no-dev ysquare/ys_giftcert' aus und beantworten Sie die Frage ob das Modul überschrieben werden soll mit 'Ja'.

3. Aktivieren des neuen Moduls

Aktivieren Sie das Modul über den Shopadmin unter **Erweiterungen** --> **Module** oder über die Konsolen-Komanndos, wie in der OXID-Dokumentation beschrieben.

4. Konfiguration

Überprüfen Sie die Konfiguration in den Moduleinstellungen. Sollte es neue Konfigurations-Parameter geben, werden diese auch in den Release Notes erwähnt. Setzen Sie die für Sie und Ihren Shop relevanten Konfigurationswerte und speichern Sie die Konfiguration ab.

5. Cache leeren

Löschen Sie den Inhalt der Verzeichnisse *tmp* und *tmp/smarty* und generieren Sie im Backend die Views neu.
