libraries/classes/Pdf.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * TCPDF wrapper class.
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 namespace PhpMyAdmin;
   9
  10 use PhpMyAdmin\Core;
  11 use PhpMyAdmin\Message;
  12 use PhpMyAdmin\Response;
  13 use PhpMyAdmin\Util;
  14 use TCPDF;
  15 use TCPDF_FONTS;
  16
  17 /**
  18  * PDF export base class providing basic configuration.
  19  *
  20  * @package PhpMyAdmin
  21  */
  22 class Pdf extends TCPDF
  23 {
  24     var $footerset;
  25     var $Alias = array();
  26
  27     /**
  28      * PDF font to use.
  29      */
  30     const PMA_PDF_FONT = 'DejaVuSans';
  31
  32     /**
  33      * Constructs PDF and configures standard parameters.
  34      *
  35      * @param string  $orientation page orientation
  36      * @param string  $unit        unit
  37      * @param string  $format      the format used for pages
  38      * @param boolean $unicode     true means that the input text is unicode
  39      * @param string  $encoding    charset encoding; default is UTF-8.
  40      * @param boolean $diskcache   if true reduce the RAM memory usage by caching
  41      *                             temporary data on filesystem (slower).
  42      * @param boolean $pdfa        If TRUE set the document to PDF/A mode.
  43      *
  44      * @access public
  45      */
  46     public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4',
  47         $unicode = true, $encoding = 'UTF-8', $diskcache = false, $pdfa=false
  48     ) {
  49         parent::__construct(
  50             $orientation, $unit, $format, $unicode,
  51             $encoding, $diskcache, $pdfa
  52         );
  53         $this->SetAuthor('phpMyAdmin ' . PMA_VERSION);
  54         $this->AddFont('DejaVuSans', '', 'dejavusans.php');
  55         $this->AddFont('DejaVuSans', 'B', 'dejavusansb.php');
  56         $this->SetFont(Pdf::PMA_PDF_FONT, '', 14);
  57         $this->setFooterFont(array(Pdf::PMA_PDF_FONT, '', 14));
  58     }
  59
  60     /**
  61      * This function must be named "Footer" to work with the TCPDF library
  62      *
  63      * @return void
  64      */
  65     // @codingStandardsIgnoreLine
  66     public function Footer()
  67     {
  68         // Check if footer for this page already exists
  69         if (!isset($this->footerset[$this->page])) {
  70             $this->SetY(-15);
  71             $this->SetFont(Pdf::PMA_PDF_FONT, '', 14);
  72             $this->Cell(
  73                 0, 6,
  74                 __('Page number:') . ' '
  75                 . $this->getAliasNumPage() . '/' .  $this->getAliasNbPages(),
  76                 'T', 0, 'C'
  77             );
  78             $this->Cell(0, 6, Util::localisedDate(), 0, 1, 'R');
  79             $this->SetY(20);
  80
  81             // set footerset
  82             $this->footerset[$this->page] = 1;
  83         }
  84     }
  85
  86     /**
  87      * Function to set alias which will be expanded on page rendering.
  88      *
  89      * @param string $name  name of the alias
  90      * @param string $value value of the alias
  91      *
  92      * @return void
  93      */
  94     public function setAlias($name, $value)
  95     {
  96         $name = TCPDF_FONTS::UTF8ToUTF16BE(
  97             $name, false, true, $this->CurrentFont
  98         );
  99         $this->Alias[$name] = TCPDF_FONTS::UTF8ToUTF16BE(
 100             $value, false, true, $this->CurrentFont
 101         );
 102     }
 103
 104     /**
 105      * Improved with alias expanding.
 106      *
 107      * @return void
 108      */
 109     public function _putpages()
 110     {
 111         if (count($this->Alias) > 0) {
 112             $nbPages = count($this->pages);
 113             for ($n = 1; $n <= $nbPages; $n++) {
 114                 $this->pages[$n] = strtr($this->pages[$n], $this->Alias);
 115             }
 116         }
 117         parent::_putpages();
 118     }
 119
 120     /**
 121      * Displays an error message
 122      *
 123      * @param string $error_message the error message
 124      *
 125      * @return void
 126      */
 127     // @codingStandardsIgnoreLine
 128     public function Error($error_message = '')
 129     {
 130         Message::error(
 131             __('Error while creating PDF:') . ' ' . $error_message
 132         )->display();
 133         exit;
 134     }
 135
 136     /**
 137      * Sends file as a download to user.
 138      *
 139      * @param string $filename file name
 140      *
 141      * @return void
 142      */
 143     public function download($filename)
 144     {
 145         $pdfData = $this->getPDFData();
 146         Response::getInstance()->disable();
 147         Core::downloadHeader(
 148             $filename,
 149             'application/pdf',
 150             strlen($pdfData)
 151         );
 152         echo $pdfData;
 153     }
 154 }