HtmlToPdfProvider.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

use Xoops\Core\Service\AbstractContract;
use Xoops\Core\Service\Contract\HtmlToPdfInterface;

class HtmlToPdfProvider extends AbstractContract implements HtmlToPdfInterface
{
    private $moddir = 'pdf';

    protected $pdfEngine;

    protected $pageOrientation = 'P';

    protected $pageSize = 'A4';

    protected $unit = 'mm';

    protected $leftMargin;

    protected $topMargin;

    protected $rightMargin;

    protected $bottomMargin;

    protected $fontFamily;

    protected $fontStyle;

    protected $fontSize;

    protected $monoFontFamily;

    protected $pdfAuthor;

    protected $pdfTitle;

    protected $pdfSubject;

    protected $pdfKeywords;

    protected $pdfCreator;

    protected $moduleConfigs;

    public function __construct()
    {
        $this->resetPdf();
    }

    private function setFromConfigs($name, $property, $default)
    {
        $this->$property = $default;
        if (isset($this->moduleConfigs[$name])) {
            $value = $this->moduleConfigs[$name];
            $this->$property = empty($value) ? $default : $value;
        }
    }
    protected function resetPdf()
    {
        unset($this->pdfEngine);

        unset($this->pdfAuthor);
        unset($this->pdfTitle);
        unset($this->pdfSubject);
        unset($this->pdfKeywords);

        $this->moduleConfigs = \Xoops::getInstance()->getModuleConfigs($this->moddir);

        $this->setFromConfigs('page_orientation', 'pageOrientation', 'P');
        $this->setFromConfigs('page_size', 'pageSize', 'A4');
        $this->setFromConfigs('pdf_creator', 'pdfCreator', 'XOOPS');

        $this->setFromConfigs('font_family', 'fontFamily', null);
        $this->setFromConfigs('font_style', 'fontStyle', '');
        $this->setFromConfigs('font_style', 'fontStyle', '');
        $this->setFromConfigs('font_size', 'fontSize', 10);
        $this->setFromConfigs('monofont_family', 'monoFontFamily', null);
        $this->setFromConfigs('size_unit', 'unit', 'mm');
        $this->setFromConfigs('margin_left', 'leftMargin', null);
        $this->setFromConfigs('margin_top', 'topMargin', null);
        $this->setFromConfigs('margin_right', 'rightMargin', null);
        $this->setFromConfigs('margin_bottom', 'bottomMargin', null);
    }

    public function startPdf($response)
    {
        $this->resetPdf();
    }

    public function getName()
    {
        return 'pdf';
    }

    public function getDescription()
    {
        return 'Simple HTML to PDF using TCPDF.';
    }

    public function setPageOrientation($response, $pageOrientation)
    {
        $this->pageOrientation = $pageOrientation;
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->setPageOrientation($this->pageOrientation, true, $this->bottomMargin);
        }
    }

    public function setPageSize($response, $pageSize)
    {
        $this->pageSize = $pageSize;
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->setPageFormat($this->pageSize, $this->pageOrientation);
        }
    }

    public function setBaseUnit($response, $unit)
    {
        $this->unit = $unit;
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->setPageUnit($unit);
        }
    }

    public function setMargins($response, $leftMargin, $topMargin, $rightMargin, $bottomMargin)
    {
        $this->$leftMargin = $leftMargin;
        $this->$topMargin = $topMargin;
        $this->$rightMargin = $rightMargin;
        $this->$bottomMargin = $bottomMargin;
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->SetMargins($this->leftMargin, $this->topMargin, $this->rightMargin);
            if (empty($this->bottomMargin)) {
                $this->bottomMargin = PDF_MARGIN_BOTTOM;
            }
            $this->pdfEngine->SetAutoPageBreak(true, $this->bottomMargin);
        }
    }

    public function setBaseFont($response, $fontFamily, $fontStyle = '', $fontSize = null)
    {
        $this->fontFamily = $fontFamily;
        $this->fontStyle  = $fontStyle;
        $this->fontSize   = $fontSize;
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->SetFont($this->fontFamily, $this->fontStyle, $this->fontSize);
        }
    }

    public function setDefaultMonospacedFont($response, $monoFontFamily)
    {
        $this->monoFontFamily = $monoFontFamily;
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->SetDefaultMonospacedFont($this->monoFontFamily);
        }
    }

    public function setAuthor($response, $pdfAuthor)
    {
        $this->pdfAuthor = $this->decodeEntities($pdfAuthor);
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->SetAuthor($this->pdfAuthor);
        }
    }

    public function setTitle($response, $pdfTitle)
    {
        $this->pdfTitle = $this->decodeEntities($pdfTitle);
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->SetTitle($this->pdfTitle);
        }
    }

    public function setSubject($response, $pdfSubject)
    {
        $this->pdfSubject = $this->decodeEntities($pdfSubject);
        if (isset($this->pdfEngine)) {
            $this->pdfEngine->SetSubject($this->pdfSubject);
        }
    }

    public function setKeywords($response, $pdfKeywords)
    {
        $this->pdfKeywords = $pdfKeywords;
        if (isset($this->pdfEngine)) {
            $keywords =
                is_array($this->pdfKeywords) ? implode(', ', $this->pdfKeywords) : (string) $this->pdfKeywords;
            $this->pdfEngine->SetKeywords($keywords);
        }
    }

    public function addHtml($response, $html)
    {
        $this->initPdf();
        $this->pdfEngine->AddPage();
        $this->pdfEngine->writeHTML($html, true, false, true, false, '');
    }

    public function outputPdfInline($response, $name)
    {
        $this->initPdf();
        if (empty($name)) {
            $name = 'requested.pdf';
        }
        $this->pdfEngine->lastPage();
        $this->pdfEngine->Output($name, 'I');
    }

    public function outputPdfDownload($response, $name)
    {
        $this->initPdf();
        if (empty($name)) {
            $name = 'requested.pdf';
        }
        $this->pdfEngine->lastPage();
        $this->pdfEngine->Output($name, 'D');
    }

    public function fetchPdf($response)
    {
        $this->initPdf();
        $this->pdfEngine->lastPage();
        $response->seValue($this->pdfEngine->Output('', 'S'));
    }

    private function initPdf()
    {
        if (empty($this->pdfEngine)) {
            $this->pdfEngine = new TCPDF($this->pageOrientation, $this->unit, $this->pageSize, true, 'UTF-8', false);
            if (isset($this->pdfAuthor)) {
                $this->pdfEngine->SetAuthor($this->pdfAuthor);
            }
            if (isset($this->pdfTitle)) {
                $this->pdfEngine->SetTitle($this->pdfTitle);
            }
            if (isset($this->pdfSubject)) {
                $this->pdfEngine->SetSubject($this->pdfSubject);
            }
            if (isset($this->pdfKeywords)) {
                $keywords =
                    is_array($this->pdfKeywords) ? implode(', ', $this->pdfKeywords) : (string) $this->pdfKeywords;
                $this->pdfEngine->SetKeywords($keywords);
            }
            if (!empty($this->pdfCreator)) {
                $this->pdfEngine->SetCreator($this->pdfCreator);
            }
            if (!empty($this->fontFamily)) {
                $this->pdfEngine->SetFont($this->fontFamily, $this->fontStyle, $this->fontSize);
            }
            if (!empty($this->monoFontFamily)) {
                $this->pdfEngine->SetDefaultMonospacedFont($this->monoFontFamily);
            }
            if (!empty($this->leftMargin)) {
                $this->pdfEngine->SetMargins($this->leftMargin, $this->topMargin, $this->rightMargin);
            }
            if (empty($this->bottomMargin)) {
                $this->bottomMargin = PDF_MARGIN_BOTTOM;
            }
            $this->pdfEngine->SetAutoPageBreak(true, $this->bottomMargin);
        }
    }

    private function decodeEntities($text)
    {
        $text= html_entity_decode($text, ENT_QUOTES, "UTF-8");
        $text= preg_replace_callback(
            '/&#(\d+);/m',
            function ($m) {
                return utf8_encode(chr($m[1]));
            },
            $text
        ); // decimal notation
        $text= preg_replace_callback(
            '/&#x([a-f0-9]+);/mi',
            function ($m) {
                return utf8_encode(chr('0x'.$m[1]));
            },
            $text
        );  //hex notation
        return $text;
    }
}