composer.json added, folder structure changed

CHANGELOG.md

@@ -1,16 +1,23 @@
-Hinweise zur Benutzung und Konfiguration sind in der Metadata-Modulbeschreibung enthalten.
-Diese können nach Installation im Backend des OXID-Shops unter "Erweiterungen -> Module" eingesehen werden.
-
-=> 1.2.0.0
-- Dokuemntation ergänzt
-- Mail-Anzeige fordert zusätzlich Authentfikation mit einem Shopadmin-Konto
-- Seitenencoding definiert
-
-=> 1.1.0.0
-- Mailversand übers Shopframework wird blockiert oder
-- Mails werden an alternative Mailadresse umgeleitet
-
-=> 1.0.0.0
-- unterbindet das Löschen des Warenkorbs nach Bestellabschluss
-- Thankyou ist ohne Bestellabschluss aufrufbar (unter Angabe der Bestellnummer auch für eine bestimmte Bestellung)
-- Bestellbestätigungsmails und (sofern D3-Modul installiert) Anfragebestätigungsmails sind im Browser darstellbar (unter Angabe der Bestellnummer auch für eine bestimmte Bestellung)
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## Unreleased
+
+## 1.2.0.0
+### Added
+- Mail-Anzeige fordert zusätzlich Authentfikation mit einem Shopadmin-Konto
+- Seitenencoding definiert
+
+### Changed
+- Dokumentation ergänzt
+
+## 1.1.0.0
+### Added
+- Mailversand übers Shopframework wird blockiert oder
+- Mails werden an alternative Mailadresse umgeleitet
+
+## 1.0.0.0
+### Added
+- unterbindet das Löschen des Warenkorbs nach Bestellabschluss
+- Thankyou ist ohne Bestellabschluss aufrufbar (unter Angabe der Bestellnummer auch für eine bestimmte Bestellung)
+- Bestellbestätigungsmails und (sofern D3-Modul installiert) Anfragebestätigungsmails sind im Browser darstellbar (unter Angabe der Bestellnummer auch für eine bestimmte Bestellung)

README.md

@@ -1,35 +1,35 @@
-# TPL Development Helper
-### Entwicklungswerkzeug zur Kontrolle schwer zug<75>nglicher Shopinhalte
-
-Diese Tool soll bei t<>glichen Entwicklungsaufgaben im OXID eShop helfen, die (systembedingt) vom Shopsystem erschwert werden.
-
-* Mailversand (<28>bers Shopframework) <20>bers Shopframework wird blockiert __oder__
-* Mails (<28>bers Shopframework) werden an alternative Mailadresse umgeleitet
-    (Das Tool setzt direkt an der oxemail::_sendMail()-Methode an und kann damit __jeden__ Mailversand kontrollieren, der <20>bers Framework l<>uft. Man muss nicht X verschiedene Module <20>berwachen und hat auch Kontrolle <20>ber Mailerweiterungen, die keinen Stage-Einsatz vorsehen.)
-* unterbindet das L<>schen des Warenkorbs nach Bestellabschluss
-* Thankyou-Seite ist auch ohne Bestellabschluss aufrufbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
-* Bestellbest<73>tigungsmails und sind im Browser darstellbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
-
-__Da hiermit gezielt Mails der Shopbestellungen angezeigt werden k<>nnen, ist das Modul mit <20>u<EFBFBD>erster Vorsicht zu verwenden. Die H<>rden f<>r die Anzeige der Mails sind daher absichtlich sehr hoch gesetzt. Vor der Verwendung sind Einstellungen zu <20>ndern. Denken Sie unbedingt daran, diese Einstellungen im Anschluss wieder zur<75>ckzusetzen. Sonst sind Kunden- und Bestelldaten frei abrufbar. Wir <20>bernehmen f<>r daraus resultierenden Sch<63>den keine Haftung.__
-
-Um unser Tool verwenden zu k<>nnen, folgen Sie bitte diesen Schritten:
-
-1. Produktivmodus entfernen
-
-   ![Adminbereich -> Stammdaten -> Grundeinstellungen -> Haken bei Produktivmodus entfernen](step1.jpg "Produktivmodus entfernen")
-
-2. Modul aktivieren
-
-   ![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Aktivieren](step2.jpg "Modul aktivieren")
-   
-3. In den Einstellungen die gew<65>nschten Funktionen freischalten
-
-   ![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Einstell.](step3.jpg "gew<65>nschte Funktionen freischalten")
-   
-4. <20>ber die Links im Tab <20>Stamm<6D> k<>nnen Sie die betreffenden Seiten aufrufen. Vor der Darstellung wird ein Benutzername und Passwort abgefragt. Hierf<72>r verwenden Sie die Anmeldedaten des Abminbereichs Ihres Shops.
-
-5. An den E-Mail- und Thankyou-Links gibt es einen leeren Parameter, den Sie bei Bedarf mit einer Bestellnummer f<>llen k<>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.
-
+# TPL Development Helper
+### Entwicklungswerkzeug zur Kontrolle schwer zug<75>nglicher Shopinhalte
+
+Diese Tool soll bei t<>glichen Entwicklungsaufgaben im OXID eShop helfen, die (systembedingt) vom Shopsystem erschwert werden.
+
+* Mailversand (<28>bers Shopframework) <20>bers Shopframework wird blockiert __oder__
+* Mails (<28>bers Shopframework) werden an alternative Mailadresse umgeleitet
+    (Das Tool setzt direkt an der oxemail::_sendMail()-Methode an und kann damit __jeden__ Mailversand kontrollieren, der <20>bers Framework l<>uft. Man muss nicht X verschiedene Module <20>berwachen und hat auch Kontrolle <20>ber Mailerweiterungen, die keinen Stage-Einsatz vorsehen.)
+* unterbindet das L<>schen des Warenkorbs nach Bestellabschluss
+* Thankyou-Seite ist auch ohne Bestellabschluss aufrufbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
+* Bestellbest<73>tigungsmails und sind im Browser darstellbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
+
+__Da hiermit gezielt Mails der Shopbestellungen angezeigt werden k<>nnen, ist das Modul mit <20>u<EFBFBD>erster Vorsicht zu verwenden. Die H<>rden f<>r die Anzeige der Mails sind daher absichtlich sehr hoch gesetzt. Vor der Verwendung sind Einstellungen zu <20>ndern. Denken Sie unbedingt daran, diese Einstellungen im Anschluss wieder zur<75>ckzusetzen. Sonst sind Kunden- und Bestelldaten frei abrufbar. Wir <20>bernehmen f<>r daraus resultierenden Sch<63>den keine Haftung.__
+
+Um unser Tool verwenden zu k<>nnen, folgen Sie bitte diesen Schritten:
+
+1. Produktivmodus entfernen
+
+   ![Adminbereich -> Stammdaten -> Grundeinstellungen -> Haken bei Produktivmodus entfernen](step1.jpg "Produktivmodus entfernen")
+
+2. Modul aktivieren
+
+   ![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Aktivieren](step2.jpg "Modul aktivieren")
+   
+3. In den Einstellungen die gew<65>nschten Funktionen freischalten
+
+   ![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Einstell.](step3.jpg "gew<65>nschte Funktionen freischalten")
+   
+4. <20>ber die Links im Tab <20>Stamm<6D> k<>nnen Sie die betreffenden Seiten aufrufen. Vor der Darstellung wird ein Benutzername und Passwort abgefragt. Hierf<72>r verwenden Sie die Anmeldedaten des Abminbereichs Ihres Shops.
+
+5. An den E-Mail- und Thankyou-Links gibt es einen leeren Parameter, den Sie bei Bedarf mit einer Bestellnummer f<>llen k<>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<EFBFBD>cksichtigen Sie bei der Darstellung der E-Mails bitte, dass die Mailprogramme diese m<>glicherweise anders darstellen, als der Browser dies tut. Daher kann die Darstellung im Browser nur ein Anhaltspunkt sein.

composer.json

@@ -0,0 +1,41 @@
+{
+  "name": "d3/devhelper",
+  "description": "Manipulate shop standard processes for easier development",
+  "type": "oxideshop-module",
+  "keywords": [
+    "oxid",
+    "modules",
+    "eShop",
+    "d3",
+    "devhelper",
+    "developer",
+    "development",
+    "tools"
+  ],
+  "authors": [
+    {
+        "name": "D3 Data Development (Inh. Thomas Dartsch)",
+        "email": "info@shopmodule.com",
+        "homepage": "http://www.d3data.de"
+    }
+  ],
+  "homepage": "https://www.oxidmodule.com/",
+  "license": [
+    "proprietary"
+  ],
+  "extra": {
+    "oxideshop": {
+      "source-directory": "/src",
+      "target-directory": "d3/devhelper"
+    }
+  },
+  "require": {
+    "php": ">=5.6",
+    "oxid-esales/oxideshop-ce": "6.0 - 6.1",
+  },
+  "autoload": {
+    "psr-4": {
+      "D3\\Devhelper\\": "../../../source/modules/d3/devhelper"
+    }
+  }
+}

src/metadata.php

@@ -4,7 +4,7 @@ use OxidEsales\Eshop\Core\Registry;
 /**
  * Metadata version
  */
-$sMetadataVersion = '1.1';
+$sMetadataVersion = '2.0';
 
 $sStyle = class_exists('d3dev') ? "background-color: darkred; color: white; padding: 0 10px;" : "";
 
@@ -59,8 +59,8 @@ $aModule = array(
         'oxbasket'  => 'd3/d3dev/modules/models/d3_dev_oxbasket',
         'oxbasketitem'  => 'd3/d3dev/modules/models/d3_dev_oxbasketitem',
     ),
-    'files'       => array(
-        'd3dev'     => 'd3/d3dev/controllers/d3dev.php',
+    'controllers'       => array(
+        'd3dev'     => \D3\Devhelper\Application\Controller\d3dev,
     ),
     'templates'   => array(
     ),