pdfdokumente/Application/Model/AbstractClasses/pdfdocumentsGeneric.php

411 lines
13 KiB
PHP
Raw Normal View History

2020-05-26 16:32:22 +02:00
<?php
/**
2020-07-04 23:25:24 +02:00
* See LICENSE file for license details.
2020-05-26 16:32:22 +02:00
*
* @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
2020-07-04 23:25:24 +02:00
* @author D3 Data Development - Max Buhe <support@shopmodule.com>
* @link http://www.oxidmodule.com
2020-05-26 16:32:22 +02:00
*/
namespace D3\PdfDocuments\Application\Model\AbstractClasses;
use Assert\InvalidArgumentException;
use D3\ModCfg\Application\Model\d3filesystem;
use D3\PdfDocuments\Application\Model\Exceptions\pdfGeneratorExceptionAbstract;
2020-05-30 01:17:27 +02:00
use D3\PdfDocuments\Application\Model\Interfaces\pdfdocumentsGenericInterface as genericInterface;
use OxidEsales\Eshop\Core\Base;
use OxidEsales\Eshop\Core\Exception\StandardException;
2020-05-26 16:32:22 +02:00
use OxidEsales\Eshop\Core\Registry;
use OxidEsales\Eshop\Core\UtilsView;
2024-09-03 19:06:16 +02:00
use OxidEsales\EshopCommunity\Internal\Container\ContainerFactory;
use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateEngineInterface;
2024-08-26 23:43:09 +02:00
use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateRenderer;
use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateRendererBridgeInterface;
use OxidEsales\Twig\Resolver\TemplateChain\TemplateNotInChainException;
use Smarty;
use Spipu\Html2Pdf\Exception\Html2PdfException;
2020-05-26 16:32:22 +02:00
use Spipu\Html2Pdf\Html2Pdf;
use Twig\Error\Error;
2020-05-26 16:32:22 +02:00
abstract class pdfdocumentsGeneric extends Base implements genericInterface
2020-05-26 16:32:22 +02:00
{
2020-06-09 14:56:14 +02:00
const PDF_DESTINATION_DOWNLOAD = 'D'; // force download in browser
const PDF_DESTINATION_STDOUT = 'I'; // show in browser plugin if available, otherwise download
const PDF_DESTINATION_FILE = 'F'; // save as local file
const PDF_DESTINATION_FILEANDSTDOUT = 'FI'; // output as local file and show in browser plugin
const PDF_DESTINATION_FILEANDDOWNLOAD = 'FD'; // output as local file and force download in browser
const PDF_DESTINATION_STRING = 'S'; // output as string
const PDF_ORIENTATION_PORTRAIT = 'P';
const PDF_ORIENTATION_LANDSCAPE = 'L';
2020-06-05 10:06:58 +02:00
public $filenameExtension = 'pdf';
/** @var Smarty */
public $oTemplateEngine;
2020-06-05 09:37:11 +02:00
/** @var string */
public $filename;
/**
2020-05-30 01:17:27 +02:00
* pdfDocumentsGeneric constructor.
*/
public function __construct()
{
parent::__construct();
2024-09-03 19:06:16 +02:00
$this->oTemplateEngine = $this->d3GetTemplateEngine();
}
2024-09-03 19:06:16 +02:00
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()
{
}
public function runPostAction()
{
}
/**
2020-07-03 20:04:21 +02:00
* @param $sFilename
* @param int $iSelLang
* @param string $target
2020-07-03 20:04:21 +02:00
* @return mixed|string|null
* @throws Html2PdfException
*/
public function genPdf($sFilename, $iSelLang = 0, $target = self::PDF_DESTINATION_STDOUT)
{
$oPdf = oxNew(Html2Pdf::class, ...$this->getPdfProperties());
2020-06-09 22:49:47 +02:00
$oPdf->setTestIsImage(false);
2020-06-11 01:26:16 +02:00
$htmlContent = $this->getHTMLContent($iSelLang);
$oPdf->writeHTML($htmlContent);
2020-06-09 22:49:47 +02:00
$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);
2020-06-11 01:26:16 +02:00
return $this->output($oPdf, $sFilename, $target, $htmlContent);
}
/**
* @param int $iLanguage
2020-07-03 20:04:21 +02:00
* @throws Html2PdfException
*/
public function downloadPdf($iLanguage = 0)
{
try {
$this->runPreAction();
$sFilename = $this->getFilename();
$this->genPdf($sFilename, $iLanguage, self::PDF_DESTINATION_DOWNLOAD);
$this->runPostAction();
Registry::getUtils()->showMessageAndExit('');
} catch (pdfGeneratorExceptionAbstract $e) {
Registry::get(UtilsView::class)->addErrorToDisplay($e);
Registry::getLogger()->error($e);
} catch (InvalidArgumentException $e) {
Registry::get(UtilsView::class)->addErrorToDisplay($e);
Registry::getLogger()->error($e);
}
}
2020-06-09 14:56:14 +02:00
/**
* @param string $path
* @param int $iLanguage
*
* @throws Html2PdfException
*/
public function savePdfFile($path, $iLanguage = 0)
{
try {
$this->runPreAction();
2020-06-09 14:56:14 +02:00
$sFilename = $this->getFilename();
$this->genPdf(
rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$sFilename,
$iLanguage,
self::PDF_DESTINATION_FILE
);
$this->runPostAction();
2020-06-09 14:56:14 +02:00
} catch (pdfGeneratorExceptionAbstract $e) {
Registry::get(UtilsView::class)->addErrorToDisplay($e);
Registry::getLogger()->error($e);
} catch (InvalidArgumentException $e) {
Registry::get(UtilsView::class)->addErrorToDisplay($e);
Registry::getLogger()->error($e);
2020-06-09 14:56:14 +02:00
}
}
2020-06-08 16:39:33 +02:00
/**
* @param int $iLanguage
*
* @return null|string
* @throws Html2PdfException
*/
public function getPdfContent($iLanguage = 0)
{
try {
$this->runPreAction();
2020-06-08 16:39:33 +02:00
$sFilename = $this->getFilename();
$ret = $this->genPdf( $sFilename, $iLanguage, self::PDF_DESTINATION_STRING );
$this->runPostAction();
return $ret;
2020-06-08 16:39:33 +02:00
} catch (pdfGeneratorExceptionAbstract $e) {
Registry::get(UtilsView::class)->addErrorToDisplay($e);
Registry::getLogger()->error($e);
} catch (InvalidArgumentException $e) {
Registry::get(UtilsView::class)->addErrorToDisplay($e);
Registry::getLogger()->error($e);
2020-06-08 16:39:33 +02:00
}
return null;
}
2020-07-02 01:21:14 +02:00
/**
* @param int $iSelLang
*/
public function setTemplateEngineVars($iSelLang)
{
2020-07-02 01:21:14 +02:00
unset($iSelLang);
2024-08-26 23:43:09 +02:00
$this->oTemplateEngine->addGlobal('config', Registry::getConfig());
2024-09-06 01:26:10 +02:00
$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);
}
/**
* @param int $iSelLang
*
* @return mixed
* @throws InvalidArgumentException
*/
public function getHTMLContent($iSelLang = 0)
{
2020-06-09 22:49:47 +02:00
$blCurrentRenderFromAdmin = self::$_blIsAdmin;
self::$_blIsAdmin = $this->renderTemplateFromAdmin();
$lang = Registry::getLang();
$currTplLang = $lang->getTplLanguage();
$lang->setTplLanguage($iSelLang);
$this->setTemplateEngineVars($iSelLang);
try {
$content = $this->oTemplateEngine->render($this->getTemplate(), $this->d3GetTemplateEngine()->getGlobals());
} catch (Error|TemplateNotInChainException $error) {
//Registry::getLogger()->error(dumpVar(__METHOD__." ".__LINE__), [$error->getFile()]);
$error = oxNew(StandardException::class, $error->getMessage());
throw $error;
}
$lang->setTplLanguage($currTplLang);
2020-06-09 22:49:47 +02:00
self::$_blIsAdmin = $blCurrentRenderFromAdmin;
return $content;
}
/**
* arguments for Html2Pdf class constructor
* - $orientation = 'P',
* - $format = 'A4',
* - $lang = 'fr',
* - $unicode = true,
* - $encoding = 'UTF-8',
* - $margins = array(5, 5, 5, 8),
* - $pdfa = false
* @return string[]
*/
public function getPdfProperties()
{
2020-06-11 01:26:16 +02:00
$orientation = self::PDF_ORIENTATION_PORTRAIT;
$format = 'A4';
$lang = 'de';
$unicode = true;
$encoding = 'UTF-8';
$margins = [0, 0, 0, 0];
$pdfa = true;
return [$orientation, $format, $lang, $unicode, $encoding, $margins, $pdfa];
}
2020-06-05 09:37:11 +02:00
/**
* @param $filename
*/
public function setFilename($filename)
{
$this->filename = $filename;
}
2020-06-05 10:06:58 +02:00
/**
* @return string
*/
public function getFilename()
{
// forced filename from setFilename()
if ($this->filename) {
return $this->makeValidFileName(
$this->addFilenameExtension(
2020-06-17 09:05:49 +02:00
$this->filename
)
);
2020-06-05 10:06:58 +02:00
}
return $this->makeValidFileName(
$this->addFilenameExtension(
2020-06-17 09:05:49 +02:00
$this->getTypeForFilename()
)
);
2020-06-05 10:06:58 +02:00
}
/**
* @param string $filename
*
* @return string
*/
public function addFilenameExtension($filename)
{
$extension = $this->filenameExtension;
$extensionLength = (strlen($extension) + 1) * -1;
if (strlen($extension) && substr($filename, $extensionLength) != '.'.$extension) {
2020-06-05 10:06:58 +02:00
$filename .= '.'.$extension;
}
return $filename;
}
/**
* Gets proper file name
*
* @param string $sFilename file name
*
* @return string
*/
public function makeValidFileName($sFilename)
{
$fs = oxNew(d3filesystem::class);
return $fs->filterFilename($sFilename);
}
/**
* @return bool
*/
public function renderTemplateFromAdmin()
{
2020-06-30 00:44:07 +02:00
return false;
}
2020-06-11 01:26:16 +02:00
2020-07-03 20:04:21 +02:00
/**
* @param Html2Pdf $oPdf
* @param $sFilename
* @param $target
* @param $html
* @return string|null
* @throws Html2PdfException
*/
2020-06-11 01:26:16 +02:00
public function output(Html2Pdf $oPdf, $sFilename, $target, $html)
{
if ((bool) Registry::getConfig()->getConfigParam('d3PdfDocumentsbDev') === true) {
return $this->outputDev($oPdf, $sFilename, $target, $html);
} else {
return $oPdf->output($sFilename, $target);
}
}
/**
* @param Html2Pdf $oPdf
* @param $sFilename
* @param $target
* @param $html
2020-07-03 20:04:21 +02:00
* @return null
2020-06-11 01:26:16 +02:00
*/
public function outputDev(Html2Pdf $oPdf, $sFilename, $target, $html)
{
$sFilename = str_replace('.pdf', '.html', $sFilename);
switch($target) {
case 'I': {
// Send PDF to the standard output
if (ob_get_contents()) {
$oPdf->pdf->Error('Some data has already been output, can\'t send PDF file');
}
if (substr(php_sapi_name(), 0, 3) != 'cli') {
2020-06-11 01:26:16 +02:00
//We send to a browser
header('Content-Type: text/html');
if (headers_sent()) {
$oPdf->pdf->Error('Some data has already been output to browser, can\'t send PDF file');
}
header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
header('Pragma: public');
header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
header('Content-Length: '.strlen($html));
header('Content-Disposition: inline; filename="'.basename($sFilename).'";');
}
echo $html;
break;
}
case 'D': {
// Download PDF as file
if (ob_get_contents()) {
$oPdf->pdf->Error('Some data has already been output, can\'t send PDF file');
}
header('Content-Description: File Transfer');
if (headers_sent()) {
$oPdf->pdf->Error('Some data has already been output to browser, can\'t send PDF file');
}
header('Cache-Control: public, must-revalidate, max-age=0'); // HTTP/1.1
header('Pragma: public');
header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
// force download dialog
header('Content-Type: application/force-download');
header('Content-Type: application/octet-stream', false);
header('Content-Type: application/download', false);
header('Content-Type: text/html', false);
// use the Content-Disposition header to supply a recommended filename
header('Content-Disposition: attachment; filename="'.basename($sFilename).'";');
header('Content-Transfer-Encoding: binary');
header('Content-Length: '.strlen($html));
echo $html;
break;
}
case 'F': {
// Save PDF to a local file
$f = fopen($sFilename, 'wb');
if (!$f) {
$oPdf->pdf->Error('Unable to create output file: '.$sFilename);
}
fwrite($f, $html, strlen($html));
fclose($f);
break;
}
case 'S': {
// Returns PDF as a string
return $html;
}
default: {
$oPdf->pdf->Error('Incorrect output destination: '.$target);
}
}
2020-07-03 20:04:21 +02:00
return null;
2020-06-11 01:26:16 +02:00
}
2020-05-26 16:32:22 +02:00
}