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