diff --git a/README.md b/README.md index f45b3ba..14e08c0 100644 --- a/README.md +++ b/README.md @@ -34,33 +34,32 @@ Gibt es in Ihrem Shop reguläre Steuersätze mit 16% oder 5%, werden diese beim ## Systemanforderung -- installierter OXID eShop in Version 6 und dessen Anforderungen +- installierter OXID eShop in Version 4.10 (CE, PE) oder 5.3 (EE) und dessen Anforderungen + +Ein Einsatz in älteren Shopversionen ist vor dem Livebetrieb zwingend auf Verwendbarkeit zu testen. ## Installation -Während Installation werden noch keine Shopeinstellungen geändert. Führen Sie diesen Befehl im Shophauptverzeichnis aus: +Kopieren Sie den Inhalt des `copy_this`-Ordners in Ihren Shopordner. Achten Sie darauf, auch die verborgene .htaccess mitzukopieren, dass die Scripte nicht über den Browser von außen erreichbar sind. - -``` -composer require d3/taxratesadjustment:"^2.0" --no-dev -``` +Vergeben Sie den beiden Scripten im Ordner `_taxRates/bin` Ausführungsrechte. ## Ausführung -- Bitte führen Sie die Umstellung rechtzeitig vorab in einer Testinstallation durch und prüfen Ihren Shop, um Fehler im Livebetrieb zu vermeiden. Zum Übergehen der Datumsprüfung können Sie den folgenden Befehlen einfach den Parameter `-d` anhängen: z.B. `[ Shoppfad ]/vendor/bin/reduceTaxRate -d`. Für den Livebetrieb soll der Parameter nicht verwendet werden. +- Bitte führen Sie die Umstellung rechtzeitig vorab in einer Testinstallation durch und prüfen Ihren Shop, um Fehler im Livebetrieb zu vermeiden. Zum Übergehen der Datumsprüfung können Sie den folgenden Befehlen einfach den Parameter `-d` anhängen: z.B. `[ Shoppfad ]/_taxRates/bin/reduceTaxRate -d`. Für den Livebetrieb soll der Parameter nicht verwendet werden. - Legen Sie sich unbedingt vor jeder Ausführung eine Datensicherung an. Die Software wird nach bestem Wissen erstellt. Durch die Vielzahl an möglichen Shopkonstellationen können wir jedoch keine Gewährleistung für die richtige Ausführung und eventuelle Folgen übernehmen. Richten Sie einen ersten Cronjob ein, der idealerweise am 01.07.2020 um 00:00 folgendes Script startet, um die Steuersätze zu senken. Alternativ führen Sie dieses Script zum passenden Zeitpunkt manuell aus: ``` -[ Shoppfad ]/vendor/bin/reduceTaxRate +[ Shoppfad ]/_taxRates/bin/reduceTaxRate ``` Richten Sie einen zweiten Cronjob ein, der idealerweise am 01.01.2021 um 00:00 folgendes Script startet, um die Steuersätze zurückzusetzen. Alternativ führen Sie dieses Script zum passenden Zeitpunkt manuell aus: ``` -[ Shoppfad ]/vendor/bin/raiseTaxRate +[ Shoppfad ]/_taxRates/bin/raiseTaxRate ``` Bei Fragen zur Einrichtung der Cronjobs kontaktieren Sie bitte Ihren Hostingprovider. @@ -73,18 +72,13 @@ Zur Definition, welche Subshops bearbeitet werden sollen, kann der Parameter `-s Entfernen Sie die eingerichteten Cronjobs nach den beiden Ausführungszeitpunkten, um versehentliche spätere Auslösungen zu vermeiden. -Nach heutigem Stand werden die Scripte nach dem Zurücksetzen der Steuersätze nicht mehr benötigt. Dann kann dieses Paket mit folgendem Befehl wieder aus der Installation entfernt werden: - -``` -composer remove d3/taxratesadjustment --no-dev -``` +Nach heutigem Stand werden die Scripte nach dem Zurücksetzen der Steuersätze nicht mehr benötigt. Dann kann der Ordner `_taxRates` wieder komplett aus der Installation entfernt werden. ## Änderungshistorie -- 2.0.0: +- 1.0.0: - scriptgesteuertes Ändern der Steuersätze (generell und artikelspezifisch) reduzierend und erhöhend für jeden Subshop - per Argument übersteuerbare Ausführungsbeschränkung -- 2.1.0 - Subshopfilter eingefügt ## Support diff --git a/composer.json b/composer.json deleted file mode 100644 index ad426ee..0000000 --- a/composer.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "name": "d3/taxratesadjustment", - "description": "adjusts the tax rates for the German economic stimulus package 2020 / 2021", - "type": "library", - "require": { - "oxid-esales/oxideshop-ce": "^6.0" - }, - "license": "GPL-3.0", - "authors": [ - { - "name": "D3 Data Development (Inh. Thomas Dartsch)", - "email": "info@shopmodule.com", - "homepage": "https://www.d3data.de" - } - ], - "autoload": { - "psr-4": { - "D3\\TaxRatesAdjustment\\": "" - } - }, - "bin": [ - "bin/reduceTaxRate", - "bin/raiseTaxRate" - ] -} diff --git a/copy_this/_taxRates/.htaccess b/copy_this/_taxRates/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/copy_this/_taxRates/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/Models/raiseTaxRate.php b/copy_this/_taxRates/Models/raiseTaxRate.php similarity index 94% rename from Models/raiseTaxRate.php rename to copy_this/_taxRates/Models/raiseTaxRate.php index b1110be..23bb9c9 100644 --- a/Models/raiseTaxRate.php +++ b/copy_this/_taxRates/Models/raiseTaxRate.php @@ -13,11 +13,9 @@ * @link http://www.oxidmodule.com */ -// ShopId - namespace D3\TaxRatesAdjustment\Models; -use OxidEsales\Eshop\Core\Registry; +require 'taxRateAbstract.php'; class raiseTaxRate extends taxRateAbstract { diff --git a/Models/reduceTaxRate.php b/copy_this/_taxRates/Models/reduceTaxRate.php similarity index 94% rename from Models/reduceTaxRate.php rename to copy_this/_taxRates/Models/reduceTaxRate.php index 59ea47b..f68d20b 100644 --- a/Models/reduceTaxRate.php +++ b/copy_this/_taxRates/Models/reduceTaxRate.php @@ -15,7 +15,7 @@ namespace D3\TaxRatesAdjustment\Models; -use OxidEsales\Eshop\Core\Registry; +require 'taxRateAbstract.php'; class reduceTaxRate extends taxRateAbstract { diff --git a/Models/taxRateAbstract.php b/copy_this/_taxRates/Models/taxRateAbstract.php similarity index 66% rename from Models/taxRateAbstract.php rename to copy_this/_taxRates/Models/taxRateAbstract.php index 230a01f..a294df2 100644 --- a/Models/taxRateAbstract.php +++ b/copy_this/_taxRates/Models/taxRateAbstract.php @@ -15,12 +15,11 @@ namespace D3\TaxRatesAdjustment\Models; -use OxidEsales\Eshop\Application\Model\Article; -use OxidEsales\Eshop\Application\Model\Shop; -use OxidEsales\Eshop\Core\Config; -use OxidEsales\Eshop\Core\DatabaseProvider; -use OxidEsales\Eshop\Core\Exception\StandardException; -use OxidEsales\Eshop\Core\Registry; +use oxArticle; +use oxConfig; +use oxDb; +use oxRegistry; +use oxShop; abstract class taxRateAbstract { @@ -50,10 +49,6 @@ abstract class taxRateAbstract return (time() > strtotime($from)) && (time() < strtotime($to)); } - /** - * @throws \OxidEsales\Eshop\Core\Exception\DatabaseConnectionException - * @throws \OxidEsales\Eshop\Core\Exception\DatabaseErrorException - */ public function run() { if (false === $this->isInExecutableTimeRange()) { @@ -64,27 +59,23 @@ abstract class taxRateAbstract $this->changeTaxRates(); } - /** - * @throws \OxidEsales\Eshop\Core\Exception\DatabaseConnectionException - * @throws \OxidEsales\Eshop\Core\Exception\DatabaseErrorException - */ public function changeTaxRates() { - $shop = new Shop(); + $shop = new oxShop(); // use shop list, when parameter -d is set $opts = getopt("s:"); $where = isset($opts['s']) ? "oxid IN (".implode(', ', array_map( - function ($a) {return DatabaseProvider::getDb()->quote(trim($a));}, + function ($a) {return oxDb::getDb()->quote(trim($a));}, explode(',', $opts['s'])) ).")" : "1"; $q = "SELECT oxid FROM " . $shop->getCoreTableName() . " WHERE ".$where ; - foreach ( DatabaseProvider::getDb( DatabaseProvider::FETCH_MODE_ASSOC )->getAll( $q ) as $record ) { + foreach (oxDb::getDb(oxDb::FETCH_MODE_ASSOC )->getAll( $q ) as $record ) { $shopId = (int) $record["oxid"]; $this->switchToShop($shopId); $this->changeDefaultTaxRate( $shopId ); @@ -99,18 +90,18 @@ abstract class taxRateAbstract */ public function switchToShop($id) { - if (Registry::getConfig()->isMall() - && $id != Registry::getConfig()->getActiveShop()->getId() + if (oxRegistry::getConfig()->isMall() + && $id != oxRegistry::getConfig()->getActiveShop()->getId() ) { - /** @var Config $oNewConf */ - $oNewConf = new Config(); + /** @var oxConfig $oNewConf */ + $oNewConf = new oxConfig(); $oNewConf->setShopId($id); $oNewConf->init(); - Registry::getConfig()->onShopChange(); - Registry::getSession()->setVariable('actshop', $id); - Registry::getSession()->setVariable('currentadminshop', $id); - Registry::getConfig()->setShopId($id); + oxRegistry::getConfig()->onShopChange(); + oxRegistry::getSession()->setVariable('actshop', $id); + oxRegistry::getSession()->setVariable('currentadminshop', $id); + oxRegistry::getConfig()->setShopId($id); } } @@ -119,7 +110,7 @@ abstract class taxRateAbstract */ public function changeDefaultTaxRate($shopId) { - $oCurrConfig = new Config(); + $oCurrConfig = new oxConfig(); $newVat = $this->rateChanges[(int) $oCurrConfig->getConfigParam('dDefaultVAT')]; if ($newVat) { @@ -132,21 +123,18 @@ abstract class taxRateAbstract /** * @param int $shopId - * - * @throws \OxidEsales\Eshop\Core\Exception\DatabaseConnectionException - * @throws \OxidEsales\Eshop\Core\Exception\DatabaseErrorException */ public function changeArticlesTaxRate($shopId) { - $article = oxNew(Article::class); + $article = oxNew(oxArticle::class); $q = "SELECT oxid FROM ".$article->getCoreTableName()." WHERE oxvat IN (".implode(', ', array_keys($this->rateChanges)).") - AND oxshopid = ".DatabaseProvider::getDb()->quote($shopId); + AND oxshopid = ". oxDb::getDb()->quote($shopId); $counter = 0; - foreach (DatabaseProvider::getDb(DatabaseProvider::FETCH_MODE_ASSOC)->getAll($q) as $articleRecord) { + foreach (oxDb::getDb(oxDb::FETCH_MODE_ASSOC)->getAll($q) as $articleRecord) { $articleId = $articleRecord['oxid']; - $article = oxNew(Article::class); + $article = oxNew(oxArticle::class); $article->load($articleId); $article->assign( [ @@ -163,9 +151,9 @@ abstract class taxRateAbstract $q = "SELECT count(*) FROM ".$article->getCoreTableName()." WHERE oxvat IN (".implode(', ', array_keys($this->rateChanges)).") - AND oxshopid = ".DatabaseProvider::getDb()->quote($shopId); + AND oxshopid = ". oxDb::getDb()->quote($shopId); - if ($counter = DatabaseProvider::getDb()->getOne($q)) { + if ($counter = oxDb::getDb()->getOne($q)) { echo "the tax rate update for " . $counter . " article(s) was failed in shop " . $shopId . PHP_EOL; } } diff --git a/bin/raiseTaxRate b/copy_this/_taxRates/bin/raiseTaxRate old mode 100644 new mode 100755 similarity index 85% rename from bin/raiseTaxRate rename to copy_this/_taxRates/bin/raiseTaxRate index 81b8fbd..94fd2a4 --- a/bin/raiseTaxRate +++ b/copy_this/_taxRates/bin/raiseTaxRate @@ -6,8 +6,10 @@ $currentDirectory = __DIR__ . '/'; $filePath = $currentDirectory . $filePath; require($filePath); +require(__DIR__.'/../Models/raiseTaxRate.php'); $change = new \D3\TaxRatesAdjustment\Models\raiseTaxRate(); + try { $change->run(); } catch ( \Exception $e) { diff --git a/bin/reduceTaxRate b/copy_this/_taxRates/bin/reduceTaxRate old mode 100644 new mode 100755 similarity index 85% rename from bin/reduceTaxRate rename to copy_this/_taxRates/bin/reduceTaxRate index 0e47ebc..7730f30 --- a/bin/reduceTaxRate +++ b/copy_this/_taxRates/bin/reduceTaxRate @@ -6,6 +6,7 @@ $currentDirectory = __DIR__ . '/'; $filePath = $currentDirectory . $filePath; require($filePath); +require(__DIR__.'/../Models/reduceTaxRate.php'); $change = new \D3\TaxRatesAdjustment\Models\reduceTaxRate(); try { diff --git a/bootstrap.php b/copy_this/_taxRates/bootstrap.php similarity index 95% rename from bootstrap.php rename to copy_this/_taxRates/bootstrap.php index 753f9fa..155a048 100644 --- a/bootstrap.php +++ b/copy_this/_taxRates/bootstrap.php @@ -5,7 +5,7 @@ if (!empty($bootstrapFileName)) { $bootstrapFileName = realpath(trim(getenv('ESHOP_BOOTSTRAP_PATH'))); } else { $count = 0; - $bootstrapFileName = '../../source/bootstrap.php'; + $bootstrapFileName = '../bootstrap.php'; $currentDirectory = __DIR__ . '/'; while ($count < 5) { $count++;