devhelper/README.md

53 lines
5.9 KiB
Markdown
Raw Normal View History

2019-10-18 22:13:16 +02:00
<EFBFBD><EFBFBD># TPL Development Helper
2020-11-12 08:55:37 +01:00
## Versions<00>bersicht:
2021-04-28 15:58:16 +02:00
* 3.x - OXID 6.2 bis 6.3
2020-11-12 08:55:37 +01:00
* 2.x - OXID 6.0 bis 6.1
* 1.x - bis OXID 4.10 / 5.3
2019-10-18 22:13:16 +02:00
## Installation
2020-11-12 08:50:36 +01:00
composer require d3/devhelper:"^3.0"
2019-10-18 22:13:16 +02:00
## Features
### Entwicklungswerkzeug zur Kontrolle schwer zug<00>nglicher Shopinhalte
Diese Tool soll bei t<00>glichen Entwicklungsaufgaben im OXID eShop helfen, die (systembedingt) vom Shopsystem erschwert werden.
* Mailversand (<00>bers Shopframework) <00>bers Shopframework wird blockiert __oder__
* Mails (<00>bers Shopframework) werden an alternative Mailadresse umgeleitet
(Das Tool setzt direkt an der oxemail::_sendMail()-Methode an und kann damit __jeden__ Mailversand kontrollieren, der <00>bers Framework l<00>uft. Man muss nicht X verschiedene Module <00>berwachen und hat auch Kontrolle <00>ber Mailerweiterungen, die keinen Stage-Einsatz vorsehen.)
* unterbindet das L<00>schen des Warenkorbs nach Bestellabschluss
* Thankyou-Seite ist auch ohne Bestellabschluss aufrufbar (unter Angabe der Bestellnummer auch f<00>r eine bestimmte Bestellung)
* Bestellbest<00>tigungsmails und sind im Browser darstellbar (unter Angabe der Bestellnummer auch f<00>r eine bestimmte Bestellung)
## Sicherheitshinweis
Da hiermit gezielt Mails der Shopbestellungen angezeigt werden k<00>nnen, ist das Modul mit entsprechender Vorsicht zu verwenden. Die H<00>rden f<00>r die Anzeige der Mails sind daher absichtlich sehr hoch gesetzt. Vor der Verwendung sind Einstellungen zu <00>ndern. Denken Sie unbedingt daran, diese Einstellungen im Anschluss wieder zur<00>ckzusetzen. Sonst sind Kunden- und Bestelldaten frei abrufbar. Wir <00>bernehmen f<00>r daraus resultierenden Sch<00>den keine Haftung.
## Verwendung
Um unser Tool verwenden zu k<00>nnen, folgen Sie bitte diesen Schritten:
1. Produktivmodus entfernen
![Adminbereich -> Stammdaten -> Grundeinstellungen -> Haken bei Produktivmodus entfernen](docs/step1.jpg "Produktivmodus entfernen")
2. Modul aktivieren
![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Aktivieren](docs/step2.jpg "Modul aktivieren")
3. In den Einstellungen die gew<00>nschten Funktionen freischalten
![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Einstell.](docs/step3.jpg "gew<00>nschte Funktionen freischalten")
2019-10-21 08:56:21 +02:00
4. <00>ber die Links im Tab "Stamm" k<00>nnen Sie die betreffenden Seiten aufrufen. Vor der Darstellung wird ein Benutzername und Passwort abgefragt. Hierf<00>r verwenden Sie die Anmeldedaten des Adminbereichs Ihres Shops.
2019-10-18 22:13:16 +02:00
5. An den E-Mail- und Thankyou-Links gibt es einen leeren Parameter, den Sie bei Bedarf mit einer Bestellnummer f<00>llen k<00>nnen. Dann wird statt der letzten Bestellung ganz gezielt eine andere Bestellung zur Darstellung verwendet.
6. Beachten Sie unbedingt, dass Sie nach der Verwendung unbedingt das Modul wieder deaktivieren und den Produktivmodus wieder anschalten.
Ber<00>cksichtigen Sie bei der Darstellung der E-Mails bitte, dass die Mailprogramme diese m<00>glicherweise anders darstellen, als der Browser dies tut. Daher kann die Darstellung im Browser nur ein Anhaltspunkt sein.