pdf.php

<?php
/**
 * Extended TCPDF class
 *
 * PHP version 8
 *
 * Copyright (C) Ere Maijala 2010-2018.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2,
 * as published by the Free Software Foundation.
 *
 * 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.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @category MLInvoice
 * @package  MLInvoice\Base
 * @author   Ere Maijala <ere@labs.fi>
 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
 * @link     http://labs.fi/mlinvoice.eng.php
 */
require_once 'markdown.php';

/**
 * Extended TCPDF class
 *
 * @category MLInvoice
 * @package  MLInvoice\Base
 * @author   Ere Maijala <ere@labs.fi>
 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
 * @link     http://labs.fi/mlinvoice.eng.php
 */
class PDF extends \setasign\Fpdi\Tcpdf\Fpdi
{
    public $headerLeft = '';

    public $headerCenter = '';

    public $headerRight = '';

    public $footerLeft = '';

    public $footerCenter = '';

    public $footerRight = '';

    public $printHeaderOnFirstPage = false;

    public $printFooterOnFirstPage = false;

    public $headerTopMargin = 10;

    public $headerLeftPos = 10;

    public $headerLeftWidth = 60;

    public $headerCenterPos = 75; // 105 - 60 / 2

    public $headerCenterWidth = 60;

    public $headerRightPos = 140;

    public $headerRightWidth = 60;

    public $footerBottomMargin = 17;

    public $footerLeftPos = 10;

    public $footerLeftWidth = 60;

    public $footerCenterPos = 75; // 105 - 60 / 2

    public $footerCenterWidth = 60;

    public $footerRightPos = 140;

    public $footerRightWidth = 60;

    public $markdown = false;

    protected $savedAutoBreakState = null;

    protected $savedPageBreakTrigger = null;

    protected $savedbMargin = null;

    protected $marginSubsequent = null;

    protected $printHeader = true;

    protected $printFooter = true;

    protected $markdownParser = null;

    /**
     * This method is used to render the page header.
     * It is automatically called by AddPage().
     *
     * @return void
     */
    // @codingStandardsIgnoreLine
    public function Header()
    {
        if (!$this->printHeader
            || ($this->PageNo() == 1 && !$this->printHeaderOnFirstPage)
        ) {
            return;
        }
        $this->SetY($this->headerTopMargin);
        $this->SetFont('Helvetica', '', 7);
        $this->SetX($this->headerLeftPos);
        $this->MultiCell(
            $this->headerLeftWidth, 5, $this->handlePageNum($this->headerLeft),
            0, 'L', 0, 0
        );
        $this->SetX($this->headerCenterPos);
        $this->MultiCell(
            $this->headerCenterWidth, 5, $this->handlePageNum($this->headerCenter),
            0, 'C', 0, 0
        );
        $this->SetX($this->headerRightPos);
        $this->MultiCell(
            $this->headerRightWidth, 5, $this->handlePageNum($this->headerRight),
            0, 'R', 0, 0
        );
    }

    /**
     * This method is used to render the page footer.
     * It is automatically called by AddPage().
     *
     * @return void
     */
    // @codingStandardsIgnoreLine
    public function Footer()
    {
        if (!$this->printFooter()
            || ($this->PageNo() == 1 && !$this->printFooterOnFirstPage)
        ) {
            return;
        }
        $this->SetY(-$this->footerBottomMargin);
        $this->SetFont('Helvetica', '', 7);
        $this->SetX($this->footerLeftPos);
        $this->MultiCell($this->footerLeftWidth, 5, $this->footerLeft, 0, 'L', 0, 0);
        $this->SetX($this->footerCenterPos);
        $this->MultiCell(
            $this->footerCenterWidth, 5, $this->footerCenter, 0, 'C', 0, 0
        );
        $this->SetX($this->footerRightPos);
        $this->MultiCell(
            $this->footerRightWidth, 5, $this->footerRight, 0, 'R', 0, 0
        );
    }

    /**
     * MultiCell with Markdown support.
     *
     * This method allows printing text with line breaks.
     * They can be automatic (as soon as the text reaches the right border of the
     * cell) or explicit (via the \n character). As many cells as necessary are
     * output, one below the other.<br />
     * Text can be aligned, centered or justified. The cell block can be framed and
     * the background painted.
     *
     * @param float  $w     (float) Width of cells. If 0, they extend up to the
     *                      right margin of the page.
     * @param float  $h     (float) Cell minimum height. The cell extends
     *                      automatically if needed.
     * @param string $txt   (string) String to print
     * @param string $align (string) Allows to center or align the text.
     *                      Possible values are:<ul><li>L or empty string: left align</li>
     *                      <li>C: center</li><li>R: right align</li><li>J: justification (default value
     *                      when $ishtml=false)</li></ul>
     * @param int    $ln    (int) Indicates where the current position should
     *                      go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to
     *                      the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
     * @param float  $maxh  (float) maximum height. It should be >= $h and less
     *                      then remaining space to the bottom of the page, or 0 for disable this feature.
     *                      This feature works only when $ishtml=false.
     * @param bool   $md    Whether the input is to be interpreted as Markdown.
     *
     * @return int Return the number of cells or 1 for html mode.
     */
    public function multiCellMD($w, $h, $txt, $align = 'J', $ln = 1,
        $maxh = 0, $md = false
    ) {
        if (!$md || !$this->markdown) {
            $this->MultiCell(
                $w,
                $h,
                $txt,
                0,
                $align,
                false,
                $ln,
                '',
                '',
                true,
                0,
                false,
                true,
                $maxh
            );
        } else {
            if (null === $this->markdownParser) {
                $this->markdownParser = new MLMarkdown();
            }
            $html = $this->markdownParser->transform($txt);
            $this->writeHTMLCell(
                $w,
                $h,
                '',
                '',
                $html,
                0,
                $ln,
                false,
                true,
                $align,
                true
            );
        }
    }

    /**
     * Enables or disables the automatic page breaking mode. When enabling, the
     * second parameter is the distance from the bottom of the page that defines the
     * triggering limit. By default, the mode is on and the margin is 2 cm.
     *
     * @param bool  $auto        Boolean indicating if mode should be on or off.
     * @param float $margin      float Distance from the bottom of the page.
     * @param float $marginFirst float Distance from the bottom of the page on first page.
     *
     * @return void
     */
    // @codingStandardsIgnoreLine
    public function SetAutoPageBreak($auto, $margin = 0, $marginFirst = false)
    {
        $this->marginSubsequent = $margin;
        parent::SetAutoPageBreak(
            $auto, false !== $marginFirst ? $marginFirst : $margin
        );
    }

    /**
     * Save auto page break state
     *
     * @return void
     */
    public function saveAutoBreakState()
    {
        $this->savedAutoBreakState = $this->AutoPageBreak;
        $this->savedbMargin = $this->bMargin;
        $this->savedPageBreakTrigger = $this->PageBreakTrigger;
    }

    /**
     * Restore saved auto page break state
     *
     * @return void
     */
    public function restoreAutoBreakState()
    {
        if (null === $this->savedAutoBreakState) {
            throw new Exception('No saved auto break state');
        }
        $this->AutoPageBreak = $this->savedAutoBreakState;
        $this->PageBreakTrigger = $this->savedPageBreakTrigger;
        $this->bMargin = $this->savedbMargin;
    }

    /**
     * Get/set if printing of header is enabled
     *
     * @param bool $newValue If defined, sets the value
     *
     * @return bool Current setting
     */
    public function printHeader($newValue = null)
    {
        if (null !== $newValue) {
            $this->printHeader = $newValue;
        }
        return $this->printHeader;
    }

    /**
     * Get/set if printing of footer is enabled
     *
     * @param bool $newValue If defined, sets the value
     *
     * @return bool Current setting
     */
    public function printFooter($newValue = null)
    {
        if (null !== $newValue) {
            $this->printFooter = $newValue;
        }
        return $this->printFooter;
    }

    /**
     * Include page number in a header string if appropriate
     *
     * @param string $str Header string
     *
     * @return string
     */
    protected function handlePageNum($str)
    {
        return sprintf($str, $this->PageNo());
    }

    /**
     * Initialize a new page.
     *
     * @param string $orientation page orientation. Possible values are (case
     * insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
     * @param mixed  $format      The format used for pages. It can be either: one
     * of the string values specified at getPageSizeFromFormat() or an array of
     * parameters specified at setPageFormat().
     *
     * @return void
     */
    // @codingStandardsIgnoreLine
    protected function _beginpage($orientation = '', $format = '')
    {
        if (null !== $this->marginSubsequent && 1 === $this->page) {
            // Change page break margin when moving on from first page
            $this->SetAutoPageBreak(true, $this->marginSubsequent);
        }
        return parent::_beginpage($orientation, $format);
    }
}