From 5541acaab0e75a0fb2d8f8ba4f307926823bef64 Mon Sep 17 00:00:00 2001 From: Daniel Seifert Date: Fri, 3 Jul 2020 20:04:21 +0200 Subject: [PATCH] change small syntax issues --- .../Controller/orderOverviewPdfGenerator.php | 6 -- .../AbstractClasses/pdfdocumentsGeneric.php | 22 ++++-- .../AbstractClasses/pdfdocumentsOrder.php | 15 ++-- .../Model/Documents/deliverynotePdf.php | 2 +- .../Documents/deliverynotewithoutlogoPdf.php | 2 +- Application/Model/Documents/invoicePdf.php | 4 +- .../Model/Documents/invoicewithoutlogoPdf.php | 2 +- .../Model/Registries/registryAbstract.php | 1 + .../translations/de/pdfdocuments_lang.php | 2 + .../translations/en/pdfdocuments_lang.php | 2 + .../views/admin/de/pdfdocuments_lang.php | 8 +++ .../views/admin/en/pdfdocuments_lang.php | 8 +++ .../views/tpl/admin/orderoverview_pdfform.tpl | 24 +++---- .../d3_overview_controller_pdfdocuments.php | 69 +++++++++++-------- metadata.php | 2 - out/src/css/pdfStyling.css | 1 + 16 files changed, 96 insertions(+), 74 deletions(-) diff --git a/Application/Controller/orderOverviewPdfGenerator.php b/Application/Controller/orderOverviewPdfGenerator.php index a529b3b..fe9b9bc 100644 --- a/Application/Controller/orderOverviewPdfGenerator.php +++ b/Application/Controller/orderOverviewPdfGenerator.php @@ -15,9 +15,7 @@ namespace D3\PdfDocuments\Application\Controller; -use D3\PdfDocuments\Application\Model\Exceptions\noBaseObjectSetException; use D3\PdfDocuments\Application\Model\Exceptions\noPdfHandlerFoundException; -use D3\PdfDocuments\Application\Model\Exceptions\pdfGeneratorExceptionAbstract; use D3\PdfDocuments\Application\Model\Interfaces\pdfdocumentsOrderInterface; use D3\PdfDocuments\Application\Model\Registries\registryOrderoverview; use OxidEsales\Eshop\Application\Model\Order; @@ -27,12 +25,8 @@ class orderOverviewPdfGenerator { /** * @param Order $order - * @param $sFilename * @param int $iSelLang - * @param string $target * @throws noPdfHandlerFoundException - * @throws noBaseObjectSetException - * @throws pdfGeneratorExceptionAbstract */ public function generatePdf(Order $order, $iSelLang = 0) { diff --git a/Application/Model/AbstractClasses/pdfdocumentsGeneric.php b/Application/Model/AbstractClasses/pdfdocumentsGeneric.php index 23bb70b..c4ba93e 100644 --- a/Application/Model/AbstractClasses/pdfdocumentsGeneric.php +++ b/Application/Model/AbstractClasses/pdfdocumentsGeneric.php @@ -58,11 +58,10 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface } /** - * @param $sFilename - * @param int $iSelLang + * @param $sFilename + * @param int $iSelLang * @param string $target - * - * @return mixed|string + * @return mixed|string|null * @throws Html2PdfException */ public function genPdf($sFilename, $iSelLang = 0, $target = self::PDF_DESTINATION_STDOUT) @@ -80,6 +79,7 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface /** * @param int $iLanguage + * @throws Html2PdfException */ public function downloadPdf($iLanguage = 0) { @@ -204,8 +204,6 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface } /** - * @param string $sFilename - * * @return string */ public function getFilename() @@ -265,6 +263,14 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface return false; } + /** + * @param Html2Pdf $oPdf + * @param $sFilename + * @param $target + * @param $html + * @return string|null + * @throws Html2PdfException + */ public function output(Html2Pdf $oPdf, $sFilename, $target, $html) { if ((bool) Registry::getConfig()->getConfigParam('d3PdfDocumentsbDev') === true) { @@ -279,7 +285,7 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface * @param $sFilename * @param $target * @param $html - * @return mixed + * @return null */ public function outputDev(Html2Pdf $oPdf, $sFilename, $target, $html) { @@ -350,5 +356,7 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface $oPdf->pdf->Error('Incorrect output destination: '.$target); } } + + return null; } } \ No newline at end of file diff --git a/Application/Model/AbstractClasses/pdfdocumentsOrder.php b/Application/Model/AbstractClasses/pdfdocumentsOrder.php index d920c9b..a17fc6d 100644 --- a/Application/Model/AbstractClasses/pdfdocumentsOrder.php +++ b/Application/Model/AbstractClasses/pdfdocumentsOrder.php @@ -23,7 +23,6 @@ use \OxidEsales\Eshop\Application\Model\Order; use OxidEsales\Eshop\Application\Model\Payment; use OxidEsales\Eshop\Application\Model\User; use OxidEsales\Eshop\Core\Registry; -use Spipu\Html2Pdf\Exception\Html2PdfException; abstract class pdfdocumentsOrder extends pdfdocumentsGeneric implements orderInterface { @@ -65,8 +64,6 @@ abstract class pdfdocumentsOrder extends pdfdocumentsGeneric implements orderInt } /** - * @param string $sFilename - * * @return string */ public function getFilename() @@ -97,19 +94,15 @@ abstract class pdfdocumentsOrder extends pdfdocumentsGeneric implements orderInt } /** - * @param $sFilename - * @param int $iSelLang + * @param $sFilename + * @param int $iSelLang * @param string $target - * - * @return mixed|string|void - * @throws Html2PdfException - * @throws noBaseObjectSetException + * @return mixed|string|null */ public function genPdf($sFilename, $iSelLang = 0, $target = 'I') { if (false == $this->getOrder()) { - $e = oxNew(noBaseObjectSetException::class); - throw $e; + throw oxNew(noBaseObjectSetException::class); } return parent::genPdf($sFilename, $iSelLang, $target); diff --git a/Application/Model/Documents/deliverynotePdf.php b/Application/Model/Documents/deliverynotePdf.php index 5af3b11..e435628 100644 --- a/Application/Model/Documents/deliverynotePdf.php +++ b/Application/Model/Documents/deliverynotePdf.php @@ -34,7 +34,7 @@ class deliverynotePdf extends pdfdocumentsOrder */ public function getTitleIdent() { - return "ORDER_OVERVIEW_PDF_DNOTE"; + return "D3_PDFDOCUMENTS_DELIVERYNOTE"; } /** diff --git a/Application/Model/Documents/deliverynotewithoutlogoPdf.php b/Application/Model/Documents/deliverynotewithoutlogoPdf.php index d348b2e..deb81e8 100644 --- a/Application/Model/Documents/deliverynotewithoutlogoPdf.php +++ b/Application/Model/Documents/deliverynotewithoutlogoPdf.php @@ -32,7 +32,7 @@ class deliverynotewithoutlogoPdf extends deliverynotePdf */ public function getTitleIdent() { - return "ORDER_OVERVIEW_PDF_DNOTE_WITHOUT_LOGO"; + return "D3_PDFDOCUMENTS_DELIVERYNOTE_WITHOUT_LOGO"; } /** diff --git a/Application/Model/Documents/invoicePdf.php b/Application/Model/Documents/invoicePdf.php index 1761067..4cc26ce 100644 --- a/Application/Model/Documents/invoicePdf.php +++ b/Application/Model/Documents/invoicePdf.php @@ -40,7 +40,7 @@ class invoicePdf extends pdfdocumentsOrder implements pdfdocumentsOrderinvoiceIn */ public function getTitleIdent() { - return "ORDER_OVERVIEW_PDF_STANDART"; + return "D3_PDFDOCUMENTS_INVOICE"; } /** @@ -103,8 +103,6 @@ class invoicePdf extends pdfdocumentsOrder implements pdfdocumentsOrderinvoiceIn } /** - * @param string $sFilename - * * @return string */ public function getFilename() diff --git a/Application/Model/Documents/invoicewithoutlogoPdf.php b/Application/Model/Documents/invoicewithoutlogoPdf.php index 9a09606..1f2e266 100644 --- a/Application/Model/Documents/invoicewithoutlogoPdf.php +++ b/Application/Model/Documents/invoicewithoutlogoPdf.php @@ -33,7 +33,7 @@ class invoicewithoutlogoPdf extends invoicePdf */ public function getTitleIdent() { - return "ORDER_OVERVIEW_PDF_STANDART_WITHOUT_LOGO"; + return "D3_PDFDOCUMENTS_INVOICE_WITHOUT_LOGO"; } /** diff --git a/Application/Model/Registries/registryAbstract.php b/Application/Model/Registries/registryAbstract.php index 1742afd..5d2f924 100644 --- a/Application/Model/Registries/registryAbstract.php +++ b/Application/Model/Registries/registryAbstract.php @@ -75,6 +75,7 @@ abstract class registryAbstract implements registryGenericInterface /** * @param $className * generator fully qualified class name + * @return bool */ public function hasGenerator($className) { diff --git a/Application/translations/de/pdfdocuments_lang.php b/Application/translations/de/pdfdocuments_lang.php index c36bbfb..50e7cf6 100644 --- a/Application/translations/de/pdfdocuments_lang.php +++ b/Application/translations/de/pdfdocuments_lang.php @@ -38,7 +38,9 @@ $aLang = array( 'D3_PDFDOCUMENTS_DELIVERYADDRESS' => 'Lieferadresse', 'D3_PDFDOCUMENTS_INVOICE' => 'Rechnung', + 'D3_PDFDOCUMENTS_INVOICE_WITHOUT_LOGO' => 'Rechnung ohne Logo', 'D3_PDFDOCUMENTS_DELIVERYNOTE' => 'Lieferschein', + 'D3_PDFDOCUMENTS_DELIVERYNOTE_WITHOUT_LOGO' => 'Lieferschein ohne Logo', 'D3_PDFDOCUMENTS_ORDERNR' => 'Bestellnr.', 'D3_PDFDOCUMENTS_ORDER_FROM_AT' => 'Ihre Bestellung vom %1$s bei "%2$s"', diff --git a/Application/translations/en/pdfdocuments_lang.php b/Application/translations/en/pdfdocuments_lang.php index 3d2f93c..f6e7ec5 100644 --- a/Application/translations/en/pdfdocuments_lang.php +++ b/Application/translations/en/pdfdocuments_lang.php @@ -37,7 +37,9 @@ $aLang = array( 'D3_PDFDOCUMENTS_DELIVERYADDRESS' => 'Shipping Address', 'D3_PDFDOCUMENTS_INVOICE' => 'Invoice', + 'D3_PDFDOCUMENTS_INVOICE_WITHOUT_LOGO' => 'Invoice without logo', 'D3_PDFDOCUMENTS_DELIVERYNOTE' => 'Deliverynote', + 'D3_PDFDOCUMENTS_DELIVERYNOTE_WITHOUT_LOGO' => 'Deliverynote without logo', 'D3_PDFDOCUMENTS_ORDERNR' => 'Order No.', 'D3_PDFDOCUMENTS_ORDER_FROM_AT' => 'Your order from %1$s at "%2$s"', diff --git a/Application/views/admin/de/pdfdocuments_lang.php b/Application/views/admin/de/pdfdocuments_lang.php index 2109978..5dfdecb 100644 --- a/Application/views/admin/de/pdfdocuments_lang.php +++ b/Application/views/admin/de/pdfdocuments_lang.php @@ -18,4 +18,12 @@ $aLang = array( 'SHOP_MODULE_GROUP_d3PdfDocumentsmain' => 'Grundeinstellungen', 'SHOP_MODULE_d3PdfDocumentsbDev' => 'Entwicklermodus', + + 'D3_PDFDOCUMENTS_INVOICE' => 'Rechnung', + 'D3_PDFDOCUMENTS_INVOICE_WITHOUT_LOGO' => 'Rechnung ohne Logo', + 'D3_PDFDOCUMENTS_DELIVERYNOTE' => 'Lieferschein', + 'D3_PDFDOCUMENTS_DELIVERYNOTE_WITHOUT_LOGO' => 'Lieferschein ohne Logo', + + 'D3_PDFDOCUMENTS_PDF_TYPE' => 'PDF Typ', + 'D3_PDFDOCUMENTS_PDF_GENERATE' => 'PDF ausgeben', ); diff --git a/Application/views/admin/en/pdfdocuments_lang.php b/Application/views/admin/en/pdfdocuments_lang.php index 98d7682..fd47a0f 100644 --- a/Application/views/admin/en/pdfdocuments_lang.php +++ b/Application/views/admin/en/pdfdocuments_lang.php @@ -18,4 +18,12 @@ $aLang = array( 'SHOP_MODULE_GROUP_d3PdfDocumentsmain' => 'Basic settings', 'SHOP_MODULE_d3PdfDocumentsbDev' => 'Developer mode', + + 'D3_PDFDOCUMENTS_INVOICE' => 'Invoice', + 'D3_PDFDOCUMENTS_INVOICE_WITHOUT_LOGO' => 'Invoice without logo', + 'D3_PDFDOCUMENTS_DELIVERYNOTE' => 'Deliverynote', + 'D3_PDFDOCUMENTS_DELIVERYNOTE_WITHOUT_LOGO' => 'Deliverynote without logo', + + 'D3_PDFDOCUMENTS_PDF_TYPE' => 'PDF Type', + 'D3_PDFDOCUMENTS_PDF_GENERATE' => 'Create PDF', ); diff --git a/Application/views/tpl/admin/orderoverview_pdfform.tpl b/Application/views/tpl/admin/orderoverview_pdfform.tpl index 27e8ff0..7ab0cd7 100644 --- a/Application/views/tpl/admin/orderoverview_pdfform.tpl +++ b/Application/views/tpl/admin/orderoverview_pdfform.tpl @@ -1,18 +1,18 @@ -[{if $edit && $oView->canExport()}] +[{if $edit && $oView->d3CanExport()}]
[{$oViewConf->getHiddenSid()}] - + - - -
- + - [{oxmultilang ident="ORDER_OVERVIEW_PDF_TYPE"}]:  - + :  +
- [{oxmultilang ident="GENERAL_LANGUAGE"}] - + +

- - +
+ +
diff --git a/Modules/Application/Controller/d3_overview_controller_pdfdocuments.php b/Modules/Application/Controller/d3_overview_controller_pdfdocuments.php index 874154f..34a7757 100644 --- a/Modules/Application/Controller/d3_overview_controller_pdfdocuments.php +++ b/Modules/Application/Controller/d3_overview_controller_pdfdocuments.php @@ -18,50 +18,59 @@ namespace D3\PdfDocuments\Modules\Application\Controller; use D3\PdfDocuments\Application\Controller\orderOverviewPdfGenerator; +use D3\PdfDocuments\Application\Model\Exceptions\noBaseObjectSetException; +use D3\PdfDocuments\Application\Model\Exceptions\noPdfHandlerFoundException; use D3\PdfDocuments\Application\Model\Exceptions\pdfGeneratorExceptionAbstract; use D3\PdfDocuments\Application\Model\Registries\registryOrderoverview; use D3\PdfDocuments\Modules\Application\Model\d3_Order_PdfDocuments; use OxidEsales\Eshop\Application\Model\Order; use OxidEsales\Eshop\Core\DatabaseProvider; +use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException; use OxidEsales\Eshop\Core\Registry; use OxidEsales\Eshop\Core\TableViewNameGenerator; -use OxidEsales\Eshop\Core\UtilsView; class d3_overview_controller_pdfdocuments extends d3_overview_controller_pdfdocuments_parent { - public function canExport() - { - // We force reading from master to prevent issues with slow replications or open transactions (see ESDEV-3804). - $masterDb = DatabaseProvider::getMaster(); - $sOrderId = $this->getEditObjectId(); + /** + * @return bool + * @throws DatabaseConnectionException + */ + public function d3CanExport() + { + // We force reading from master to prevent issues with slow replications or open transactions (see ESDEV-3804). + $masterDb = DatabaseProvider::getMaster(); + $sOrderId = $this->getEditObjectId(); - $viewNameGenerator = Registry::get(TableViewNameGenerator::class); - $sTable = $viewNameGenerator->getViewName("oxorderarticles"); + $viewNameGenerator = Registry::get(TableViewNameGenerator::class); + $sTable = $viewNameGenerator->getViewName("oxorderarticles"); - $sQ = "select count(oxid) from {$sTable} where oxorderid = " . $masterDb->quote($sOrderId) . " and oxstorno = 0"; - $blCan = (bool) $masterDb->getOne($sQ); - - return $blCan; - } - - public function createPDF() - { - $soxId = $this->getEditObjectId(); - if ($soxId != "-1" && isset($soxId)) { - /** @var d3_Order_PdfDocuments $oOrder */ - $oOrder = oxNew(Order::class); - if ($oOrder->load($soxId)) { - $generator = oxNew( orderOverviewPdfGenerator::class ); - $generator->generatePdf($oOrder, Registry::getRequest()->getRequestEscapedParameter("pdflanguage")); - } + $sQ = "select count(oxid) from {$sTable} where oxorderid = " . $masterDb->quote($sOrderId) . " and oxstorno = 0"; + return (bool) $masterDb->getOne($sQ); } - } /** - * @return registryOrderoverview + * @throws noBaseObjectSetException + * @throws noPdfHandlerFoundException + * @throws pdfGeneratorExceptionAbstract */ - public function d3getGeneratorList() - { - return oxNew(registryOrderoverview::class); - } + public function d3CreatePDF() + { + $soxId = $this->getEditObjectId(); + if ($soxId != "-1" && isset($soxId)) { + /** @var d3_Order_PdfDocuments $oOrder */ + $oOrder = oxNew(Order::class); + if ($oOrder->load($soxId)) { + $generator = oxNew( orderOverviewPdfGenerator::class ); + $generator->generatePdf($oOrder, Registry::getRequest()->getRequestEscapedParameter("pdflanguage")); + } + } + } + + /** + * @return registryOrderoverview + */ + public function d3getGeneratorList() + { + return oxNew(registryOrderoverview::class); + } } \ No newline at end of file diff --git a/metadata.php b/metadata.php index 20454e4..0c91685 100644 --- a/metadata.php +++ b/metadata.php @@ -16,9 +16,7 @@ */ use D3\PdfDocuments\Modules\Application\Controller\d3_overview_controller_pdfdocuments; -use D3\PdfDocuments\Modules\Application\Model\d3_Order_PdfDocuments as d3_pdfdocs_OrderModel; use OxidEsales\Eshop\Application\Controller\Admin\OrderOverview; -use OxidEsales\Eshop\Application\Model as OxidModel; /** * Metadata version diff --git a/out/src/css/pdfStyling.css b/out/src/css/pdfStyling.css index 97f079c..cee2a78 100644 --- a/out/src/css/pdfStyling.css +++ b/out/src/css/pdfStyling.css @@ -79,6 +79,7 @@ table{ } .salutation .documenttype { font-weight: bold; + margin-bottom: 5mm; } .article_table,