PDF-Rechnungen: Installation

Installation des PDF-Rechnungen Moduls für OXID eShop 7.x per Composer, Aktivierung, Verzeichnisrechte, Update und Verhalten bei Deaktivierung.

English Version

Zurück zur Übersicht

PDF-Rechnungen: Installation

Live Demo: Teste dieses und weitere Plugins live — ohne Installation, ohne Risiko: demo.markus-michalski.net

Diese Dokumentation bezieht sich immer auf die aktuellste veröffentlichte Version.

Voraussetzungen

Anforderung	Hinweis
OXID eShop	7.x (`oxid-esales/oxideshop-ce` ^7.0)
PHP	8.2 oder neuer
PDF-Bibliothek	Dompdf (`dompdf/dompdf` ^2.0), wird von Composer automatisch mitinstalliert

Installation über Composer

Das Modul hängt von Dompdf ab und nutzt den Composer-Autoloader. Es wird deshalb über Composer installiert.

Private Repositories werden über Packeton verwaltet. Zugangsdaten erhältst du nach dem Lizenzkauf.

1. Private Repository hinzufügen:

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://packeton.markus-michalski.net"
        }
    ]
}

2. Modul installieren:

composer require mmd/oxid7-pdf-invoice

Beim Abruf fragt Composer nach den Zugangsdaten deiner Lizenz. Das Modul landet im Verzeichnis source/modules/mmd/pdf-invoice.

3. Modul aktivieren:

vendor/bin/oe-console oe:module:install-configuration source/modules/mmd/pdf-invoice
vendor/bin/oe-console oe:module:activate mmd_pdfinvoice
vendor/bin/oe-console oe:cache:clear

Alternativ aktivierst du das Modul im OXID Admin unter Erweiterungen > Module.

Was bei der Aktivierung passiert

Die Tabellen mmd_pdfinvoice und mmd_pdfinvoice_seq werden angelegt, falls sie noch nicht existieren.
Das Verzeichnis export/invoices wird im Shop-Verzeichnis (source/) angelegt. Darin liegt eine .htaccess mit Deny from all.
Der Rechnungszähler für das aktuelle Jahr wird für Shop 1 angelegt. Für weitere Shops und Jahre entsteht der Zähler bei der ersten Rechnung.

Verzeichnisrechte

Der Webserver-Benutzer braucht Schreibrechte auf:

Verzeichnis	Zweck
`source/export/invoices` (bzw. dein eigener Speicherpfad)	Ablage der PDF-Rechnungen
`source/tmp/dompdf`	Schrift-Cache von Dompdf, wird bei der ersten PDF-Erzeugung angelegt

Update

composer update mmd/oxid7-pdf-invoice
vendor/bin/oe-console oe:cache:clear

Vorhandene Rechnungen, Zähler und PDF-Dateien bleiben beim Update erhalten. Hast du das Template angepasst, siehe den Hinweis auf der Seite Template und Variablen.

Deaktivieren und Entfernen

Beim Deaktivieren des Moduls werden weder Tabellen noch PDF-Dateien gelöscht. Auch ein Entfernen des Moduls über Composer löscht die Tabellen und die Dateien im Speicherpfad nicht. Möchtest du die Daten entfernen, musst du Tabellen und Dateien selbst löschen. Beachte dabei die Aufbewahrungsfristen für Rechnungen.

Nächste Schritte

Konfiguration: Einstellungen und Admin-Bereich
Template und Variablen: Rechnungslayout anpassen