phpmyadmin/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 string  $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      * @access public
  42      */
  43     public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4',
  44         $unicode = true, $encoding = 'UTF-8', $diskcache = false, $pdfa=false
  45     ) {
  46         parent::__construct(
  47             $orientation, $unit, $format, $unicode,
  48             $encoding, $diskcache, $pdfa
  49         );
  50         $this->SetAuthor('phpMyAdmin ' . PMA_VERSION);
  51         $this->AddFont('DejaVuSans', '', 'dejavusans.php');
  52         $this->AddFont('DejaVuSans', 'B', 'dejavusansb.php');
  53         $this->SetFont(PMA_PDF_FONT, '', 14);
  54         $this->setFooterFont(array(PMA_PDF_FONT, '', 14));
  55     }
  56
  57     /**
  58      * This function must be named "Footer" to work with the TCPDF library
  59      *
  60      * @return void
  61      */
  62     public function Footer()
  63     {
  64         // Check if footer for this page already exists
  65         if (!isset($this->footerset[$this->page])) {
  66             $this->SetY(-15);
  67             $this->SetFont(PMA_PDF_FONT, '', 14);
  68             $this->Cell(
  69                 0, 6,
  70                 __('Page number:') . ' '
  71                 . $this->getAliasNumPage() . '/' .  $this->getAliasNbPages(),
  72                 'T', 0, 'C'
  73             );
  74             $this->Cell(0, 6, PMA_Util::localisedDate(), 0, 1, 'R');
  75             $this->SetY(20);
  76
  77             // set footerset
  78             $this->footerset[$this->page] = 1;
  79         }
  80     }
  81
  82     /**
  83      * Function to set alias which will be expanded on page rendering.
  84      *
  85      * @param string $name  name of the alias
  86      * @param string $value value of the alias
  87      *
  88      * @return void
  89      */
  90     public function SetAlias($name, $value)
  91     {
  92         $name = TCPDF_FONTS::UTF8ToUTF16BE(
  93             $name, false, true, $this->CurrentFont
  94         );
  95         $this->Alias[$name] = TCPDF_FONTS::UTF8ToUTF16BE(
  96             $value, false, true, $this->CurrentFont
  97         );
  98     }
  99
 100     /**
 101      * Improved with alias expanding.
 102      *
 103      * @return void
 104      */
 105     public function _putpages()
 106     {
 107         if (count($this->Alias) > 0) {
 108             $nbPages = count($this->pages);
 109             for ($n = 1; $n <= $nbPages; $n++) {
 110                 $this->pages[$n] = strtr($this->pages[$n], $this->Alias);
 111             }
 112         }
 113         parent::_putpages();
 114     }
 115
 116     /**
 117      * Displays an error message
 118      *
 119      * @param string $error_message the error message
 120      *
 121      * @return void
 122      */
 123     public function Error($error_message = '')
 124     {
 125         PMA_Message::error(
 126             __('Error while creating PDF:') . ' ' . $error_message
 127         )->display();
 128         exit;
 129     }
 130
 131     /**
 132      * Sends file as a download to user.
 133      *
 134      * @param string $filename file name
 135      *
 136      * @return void
 137      */
 138     public function Download($filename)
 139     {
 140         $pdfData = $this->getPDFData();
 141         PMA_Response::getInstance()->disable();
 142         PMA_downloadHeader(
 143             $filename,
 144             'application/pdf',
 145             /*overload*/mb_strlen($pdfData)
 146         );
 147         echo $pdfData;
 148     }
 149 }