libraries/PDF.class.php

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