fix reused capture content in Smarty

cleanup
fix template renderer
2025-01-21 11:01:58 +01:00 · 2025-01-21 10:57:38 +01:00 · 2025-01-21 10:31:03 +01:00
--- a/Application/Controller/orderOverviewPdfGenerator.php
+++ b/Application/Controller/orderOverviewPdfGenerator.php
@ -11,6 +11,7 @@
 namespace D3\PdfDocuments\Application\Controller;

 use D3\PdfDocuments\Application\Model\Exceptions\noPdfHandlerFoundException;
+use D3\PdfDocuments\Application\Model\Exceptions\wrongPdfGeneratorInterface;
 use D3\PdfDocuments\Application\Model\Interfaces\pdfdocumentsOrderInterface;
 use D3\PdfDocuments\Application\Model\Registries\registryOrderoverview;
 use OxidEsales\Eshop\Application\Model\Order;
@ -22,6 +23,7 @@ class orderOverviewPdfGenerator
     * @param Order $order
     * @param int $iSelLang
     * @throws noPdfHandlerFoundException
+     * @throws wrongPdfGeneratorInterface
     */
    public function generatePdf(Order $order, int $iSelLang = 0)
    {
@ -34,6 +36,7 @@ class orderOverviewPdfGenerator
    /**
     * @return pdfdocumentsOrderInterface
     * @throws noPdfHandlerFoundException
+     * @throws wrongPdfGeneratorInterface
     */
    public function getPdfClass()
    {
--- a/Application/Model/AbstractClasses/pdfdocumentsGeneric.php
+++ b/Application/Model/AbstractClasses/pdfdocumentsGeneric.php
@ -12,7 +12,6 @@ namespace D3\PdfDocuments\Application\Model\AbstractClasses;

 use Assert\InvalidArgumentException;
 use D3\PdfDocuments\Application\Model\Constants;
-use D3\PdfDocuments\Application\Model\Exceptions\pdfGeneratorExceptionAbstract;
 use D3\PdfDocuments\Application\Model\Interfaces\pdfdocumentsGenericInterface as genericInterface;
 use OxidEsales\Eshop\Core\Base;
 use OxidEsales\Eshop\Core\Exception\StandardException;
@ -20,7 +19,7 @@ use OxidEsales\Eshop\Core\Registry;
 use OxidEsales\Eshop\Core\UtilsView;
 use OxidEsales\EshopCommunity\Internal\Container\ContainerFactory;
 use OxidEsales\EshopCommunity\Internal\Framework\Module\Facade\ModuleSettingServiceInterface;
-use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateEngineInterface;
+use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateRenderer;
 use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateRendererBridgeInterface;
 use OxidEsales\Twig\Resolver\TemplateChain\TemplateNotInChainException;
 use Psr\Container\ContainerExceptionInterface;
@ -43,38 +42,9 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface

    public $filenameExtension = 'pdf';

-    /** @var TemplateEngineInterface  */
-    public $oTemplateEngine;
-
    /** @var string */
    public $filename;

-    /**
-     * pdfDocumentsGeneric constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-	    
-	    $this->oTemplateEngine =  $this->d3GetTemplateEngine();
-    }
-
-	public function d3GetTemplateEngine() :TemplateEngineInterface
-	{
-		$renderer = $this->d3GetTemplateRendererBridge()->getTemplateRenderer();
-		return $renderer->getTemplateEngine();
-	}
-	
-	/**
-	 * @throws ContainerExceptionInterface
-	 * @throws NotFoundExceptionInterface
-	 */
-	public function d3GetTemplateRendererBridge(): TemplateRendererBridgeInterface
-	{
-		return ContainerFactory::getInstance()->getContainer()
-			->get(TemplateRendererBridgeInterface::class);
-	}
-	
    public function runPreAction()
    {
    }
@ -84,11 +54,14 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
    }

    /**
-     * @param $sFilename
+     * @param string $sFilename
     * @param int $iSelLang
     * @param string $target
+     *
     * @return string|null
+     * @throws ContainerExceptionInterface
     * @throws Html2PdfException
+     * @throws NotFoundExceptionInterface
     */
    public function genPdf($sFilename, $iSelLang = 0, $target = self::PDF_DESTINATION_STDOUT)
    {
@ -96,10 +69,10 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
        $oPdf->setTestIsImage(false);
        $htmlContent = $this->getHTMLContent($iSelLang);
        $oPdf->writeHTML($htmlContent);
-        $oPdf->pdf->SetAuthor(Registry::getConfig()->getActiveShop()->getFieldData('oxname'));
-        $oPdf->pdf->SetTitle(Registry::getLang()->translateString($this->getTitleIdent()));
-        $oPdf->pdf->SetCreator('D³ PDF Documents for OXID eShop');
-        $oPdf->pdf->SetSubject(NULL);
+        $oPdf->pdf->setAuthor( Registry::getConfig()->getActiveShop()->getFieldData( 'oxname'));
+        $oPdf->pdf->setTitle( Registry::getLang()->translateString( $this->getTitleIdent()));
+        $oPdf->pdf->setCreator( 'D³ PDF Documents for OXID eShop');
+        $oPdf->pdf->setSubject( NULL);
        return $this->output($oPdf, $sFilename, $target, $htmlContent);
    }

@ -107,6 +80,15 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
     * @param int $iLanguage
     * @throws Html2PdfException
     */
+
+    /**
+     * @param $iLanguage
+     *
+     * @return void
+     * @throws ContainerExceptionInterface
+     * @throws Html2PdfException
+     * @throws NotFoundExceptionInterface
+     */
    public function downloadPdf($iLanguage = 0)
    {
        try {
@ -115,17 +97,20 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
            $this->genPdf($sFilename, $iLanguage, self::PDF_DESTINATION_DOWNLOAD);
            $this->runPostAction();
            Registry::getUtils()->showMessageAndExit('');
-        } catch (pdfGeneratorExceptionAbstract|InvalidArgumentException $e) {
-            Registry::get(UtilsView::class)->addErrorToDisplay($e);
+        } catch (InvalidArgumentException $e) {
            Registry::getLogger()->error($e);
+            Registry::get(UtilsView::class)->addErrorToDisplay($e);
        }
    }

    /**
     * @param string $path
-     * @param int    $iLanguage
+     * @param int $iLanguage
     *
+     * @return void
+     * @throws ContainerExceptionInterface
     * @throws Html2PdfException
+     * @throws NotFoundExceptionInterface
     */
    public function savePdfFile($path, $iLanguage = 0)
    {
@ -138,7 +123,7 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
                self::PDF_DESTINATION_FILE
            );
            $this->runPostAction();
-        } catch (pdfGeneratorExceptionAbstract|InvalidArgumentException $e) {
+        } catch (InvalidArgumentException $e) {
            Registry::get(UtilsView::class)->addErrorToDisplay($e);
            Registry::getLogger()->error($e);
        }
@ -147,8 +132,10 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
    /**
     * @param int $iLanguage
     *
-     * @return null|string
+     * @return string|null
+     * @throws ContainerExceptionInterface
     * @throws Html2PdfException
+     * @throws NotFoundExceptionInterface
     */
    public function getPdfContent($iLanguage = 0)
    {
@ -158,7 +145,7 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
            $ret = $this->genPdf( $sFilename, $iLanguage, self::PDF_DESTINATION_STRING );
            $this->runPostAction();
            return $ret;
-        } catch (pdfGeneratorExceptionAbstract|InvalidArgumentException $e) {
+        } catch (InvalidArgumentException $e) {
            Registry::get(UtilsView::class)->addErrorToDisplay($e);
            Registry::getLogger()->error($e);
        }
@ -166,18 +153,17 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
        return null;
    }

-    /**
-     * @param int $iSelLang
-     */
-    public function setTemplateEngineVars(int $iSelLang)
+    public function getTemplateEngineVars(int $iSelLang): array
    {
        unset($iSelLang);
-		
-        $this->oTemplateEngine->addGlobal('config', Registry::getConfig());
-        $this->oTemplateEngine->addGlobal('oViewConf', Registry::getConfig()->getActiveView()->getViewConfig());
-        $this->oTemplateEngine->addGlobal('shop', Registry::getConfig()->getActiveShop());
-        $this->oTemplateEngine->addGlobal('lang', Registry::getLang());
-        $this->oTemplateEngine->addGlobal('document', $this);
+
+        return [
+            'config' => Registry::getConfig(),
+            'oViewConf' => Registry::getConfig()->getActiveView()->getViewConfig(),
+            'shop'  => Registry::getConfig()->getActiveShop(),
+            'lang'  => Registry::getLang(),
+            'document' => $this
+        ];
    }
 	
    /**
@ -196,10 +182,11 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
        $currTplLang = $lang->getTplLanguage();
        $lang->setTplLanguage($iSelLang);

-        $this->setTemplateEngineVars($iSelLang);
-		
 	    try {
-		    $content = $this->oTemplateEngine->render($this->getTemplate(), $this->d3GetTemplateEngine()->getGlobals());
+            $content = $this->getTemplateRenderer()->renderTemplate(
+                $this->getTemplate(),
+                $this->getTemplateEngineVars($iSelLang)
+            );
 	    } catch (Error|TemplateNotInChainException $error) {
 		    
 		    //Registry::getLogger()->error(dumpVar(__METHOD__." ".__LINE__), [$error->getFile()]);
@ -214,6 +201,13 @@ abstract class pdfdocumentsGeneric extends Base implements genericInterface
        return $content;
    }

+    protected function getTemplateRenderer(): TemplateRenderer
+    {
+        return ContainerFactory::getInstance()->getContainer()
+            ->get(TemplateRendererBridgeInterface::class)
+            ->getTemplateRenderer();
+    }
+
    /**
     * arguments for Html2Pdf class constructor
     * - $orientation = 'P',
--- a/Application/Model/AbstractClasses/pdfdocumentsOrder.php
+++ b/Application/Model/AbstractClasses/pdfdocumentsOrder.php
@ -57,19 +57,22 @@ abstract class pdfdocumentsOrder extends pdfdocumentsGeneric implements orderInt
     * @param int $iSelLang
     * @throws InvalidArgumentException
     */
-    public function setTemplateEngineVars($iSelLang)
+    public function getTemplateEngineVars($iSelLang): array
    {
-        parent::setTemplateEngineVars($iSelLang);
-
-        $this->oTemplateEngine->addGlobal('order', $this->getOrder());
-
        $oUser = oxNew(User::Class);
        $oUser->load($this->getOrder()->getFieldData('oxuserid'));
-        $this->oTemplateEngine->addGlobal('user', $oUser);

        $oPayment = oxNew(Payment::class);
        $oPayment->loadInLang($iSelLang, $this->getOrder()->getFieldData('oxpaymenttype'));
-        $this->oTemplateEngine->addGlobal('payment', $oPayment);
+
+        return array_merge(
+            parent::getTemplateEngineVars($iSelLang),
+            [
+                'order'    => $this->getOrder(),
+                'user'    => $oUser,
+                'payment'   => $oPayment
+            ]
+        );
    }

    /**
--- a/Application/Model/Documents/invoicewithoutlogoPdf.php
+++ b/Application/Model/Documents/invoicewithoutlogoPdf.php
@ -39,7 +39,8 @@ class invoicewithoutlogoPdf extends invoicePdf
    /**
     * @return string
     */
-    public function getTemplate(){
+    public function getTemplate()
+    {
        return '@d3PdfDocuments/documents/invoice/invoiceNoLogo';
    }
 }
--- a/Application/Model/Registries/registryAbstract.php
+++ b/Application/Model/Registries/registryAbstract.php
@ -28,6 +28,8 @@ abstract class registryAbstract implements registryGenericInterface

    /**
     * @param $className
+     *
+     * @throws wrongPdfGeneratorInterface
     */
    public function addGenerator($className)
    {
@ -44,6 +46,7 @@ abstract class registryAbstract implements registryGenericInterface
    /**
     * @param $className * generator fully qualified class name
     * @param pdfdocumentsGenericInterface $item
+     * @throws wrongPdfGeneratorInterface
     */
    protected function addItem($className, pdfdocumentsGenericInterface $item)
    {
--- a/Application/Model/Registries/registryOrdermanagerActions.php
+++ b/Application/Model/Registries/registryOrdermanagerActions.php
@ -14,10 +14,14 @@ use D3\PdfDocuments\Application\Model\Documents\deliverynotePdf;
 use D3\PdfDocuments\Application\Model\Documents\deliverynotewithoutlogoPdf;
 use D3\PdfDocuments\Application\Model\Documents\invoicePdf;
 use D3\PdfDocuments\Application\Model\Documents\invoicewithoutlogoPdf;
+use D3\PdfDocuments\Application\Model\Exceptions\wrongPdfGeneratorInterface;
 use D3\PdfDocuments\Application\Model\Interfaces\pdfdocumentsOrderInterface;

 class registryOrdermanagerActions extends registryAbstract implements registryOrdermanagerActionsInterface
 {
+    /**
+     * @throws wrongPdfGeneratorInterface
+     */
    public function __construct()
    {
        $this->addGenerator(invoicePdf::class);
--- a/Application/Model/Registries/registryOrderoverview.php
+++ b/Application/Model/Registries/registryOrderoverview.php
@ -14,10 +14,14 @@ use D3\PdfDocuments\Application\Model\Documents\deliverynotePdf;
 use D3\PdfDocuments\Application\Model\Documents\deliverynotewithoutlogoPdf;
 use D3\PdfDocuments\Application\Model\Documents\invoicePdf;
 use D3\PdfDocuments\Application\Model\Documents\invoicewithoutlogoPdf;
+use D3\PdfDocuments\Application\Model\Exceptions\wrongPdfGeneratorInterface;
 use D3\PdfDocuments\Application\Model\Interfaces\pdfdocumentsOrderInterface;

 class registryOrderoverview extends registryAbstract implements registryOrderoverviewInterface
 {
+    /**
+     * @throws wrongPdfGeneratorInterface
+     */
    public function __construct()
    {
        $this->addGenerator(invoicePdf::class);
--- a/Modules/Application/Controller/d3_overview_controller_pdfdocuments.php
+++ b/Modules/Application/Controller/d3_overview_controller_pdfdocuments.php
@ -13,6 +13,7 @@ namespace D3\PdfDocuments\Modules\Application\Controller;
 use D3\PdfDocuments\Application\Controller\orderOverviewPdfGenerator;
 use D3\PdfDocuments\Application\Model\Exceptions\noPdfHandlerFoundException;
 use D3\PdfDocuments\Application\Model\Exceptions\pdfGeneratorExceptionAbstract;
+use D3\PdfDocuments\Application\Model\Exceptions\wrongPdfGeneratorInterface;
 use D3\PdfDocuments\Application\Model\Registries\registryOrderoverview;
 use Doctrine\DBAL\Driver\Exception;
 use Doctrine\DBAL\Exception as DBALException;
@ -77,6 +78,10 @@ class d3_overview_controller_pdfdocuments extends d3_overview_controller_pdfdocu
        }
    }

+    /**
+     * @return registryOrderoverview
+     * @throws wrongPdfGeneratorInterface
+     */
    public function d3getGeneratorList(): registryOrderoverview
    {
        return oxNew(registryOrderoverview::class);
--- a/metadata.php
+++ b/metadata.php
@ -12,14 +12,8 @@ use D3\PdfDocuments\Application\Model\Constants as Constants;
 use D3\PdfDocuments\Modules\Application\Controller\d3_overview_controller_pdfdocuments;
 use OxidEsales\Eshop\Application\Controller\Admin\OrderOverview;

-/**
- * Metadata version
- */
 $sMetadataVersion = '2.1';

-/**
- * Module information
- */
 $aModule = [
    'id'            => Constants::OXID_MODULE_ID,
    'title'         => [
--- a/views/smarty/documents/deliverynote/deliverynote.tpl
+++ b/views/smarty/documents/deliverynote/deliverynote.tpl
@ -1,19 +1,19 @@
 [{assign var="pagePadding"   value=","|explode:"45,15,30,25"}] [{* top, right, bottom, left *}]
 [{assign var="showLogo"      value=$showLogo|default:true}]

-[{capture append="pdfBlock_style"}]
+[{capture assign="pdfBlock_style"}]
    [{block name="pdfStyles"}]
        [{include file="@d3PdfDocuments/assets/d3pdfstyles.css.tpl"}]
    [{/block}]
 [{/capture}]

-[{capture append="pdfBlock_header"}]
+[{capture assign="pdfBlock_header"}]
    [{block name="pdfHeader"}]
        [{include file="@d3PdfDocuments/documents/inc/page/header.tpl" showLogo=$showLogo}]
    [{/block}]
 [{/capture}]

-[{capture append="pdfBlock_content"}]
+[{capture assign="pdfBlock_content"}]
    [{include file="@d3PdfDocuments/documents/inc/elements/foldmarks.tpl" pagePadding=$pagePadding}]

    [{block name="pdfAddressArea"}]
@ -37,10 +37,10 @@
    [{/block}]
 [{/capture}]

-[{capture append="pdfBlock_footer"}]
+[{capture assign="pdfBlock_footer"}]
    [{block name="pdfFooter"}]
        [{include file="@d3PdfDocuments/documents/inc/page/footer.tpl" pagePadding=$pagePadding}]
    [{/block}]
 [{/capture}]

-[{include file="@d3PdfDocuments/documents/inc/page/base.tpl" pagePadding=$pagePadding}]
+[{include file="@d3PdfDocuments/documents/inc/page/base.tpl" pagePadding=$pagePadding}]
--- a/views/smarty/documents/invoice/invoice.tpl
+++ b/views/smarty/documents/invoice/invoice.tpl
@ -1,19 +1,19 @@
 [{assign var="pagePadding"   value=","|explode:"45,15,30,25"}] [{* top, right, bottom, left *}]
 [{assign var="showLogo"      value=$showLogo|default:true}]

-[{capture append="pdfBlock_style"}]
+[{capture assign="pdfBlock_style"}]
    [{block name="pdfStyles"}]
        [{include file="@d3PdfDocuments/assets/d3pdfstyles.css.tpl"}]
    [{/block}]
 [{/capture}]

-[{capture append="pdfBlock_header"}]
+[{capture assign="pdfBlock_header"}]
    [{block name="pdfHeader"}]
        [{include file="@d3PdfDocuments/documents/inc/page/header.tpl" showLogo=$showLogo}]
    [{/block}]
 [{/capture}]

-[{capture append="pdfBlock_content"}]
+[{capture assign="pdfBlock_content"}]
    [{* include file="@d3PdfDocuments/documents/inc/helper/rulers" pagePadding=$pagePadding *}]
    [{include file="@d3PdfDocuments/documents/inc/elements/foldmarks.tpl" pagePadding=$pagePadding}]

@ -42,10 +42,10 @@
    [{/block}]
 [{/capture}]

-[{capture append="pdfBlock_footer"}]
+[{capture assign="pdfBlock_footer"}]
    [{block name="pdfFooter"}]
        [{include file="@d3PdfDocuments/documents/inc/page/footer.tpl" pagePadding=$pagePadding}]
    [{/block}]
 [{/capture}]

-[{include file="@d3PdfDocuments/documents/inc/page/base.tpl" pagePadding=$pagePadding}]
+[{include file="@d3PdfDocuments/documents/inc/page/base.tpl" pagePadding=$pagePadding}]
Auteur	SHA1	Message	Date
Daniel Seifert	bd01cf8d3b	fix reused capture content in Smarty	2025-01-21 11:01:58 +01:00
Daniel Seifert	875f8e2464	cleanup	2025-01-21 10:57:38 +01:00
Daniel Seifert	4e91c42910	fix template renderer	2025-01-21 10:31:03 +01:00