Генератор PDF документов, основанный на TCPDF/FPDF

• использование "образцовых" PDF файлов в качестве шаблонов
• настраиваемый вывод значений полей формы в нужные позиции на листе, параметры настройки при этом хранятся в отдельном XML файле
• вывод в указанные координаты графических файлов (что бывает необходимо для печати факсимильных оттисков штампов, подписей и т.д.)
• вывод штрих-кодов и QR-кодов
• Возможность формирования нескольких "документов" в выходном PDF файле (например, нескольких "писем клиентам", или договоров для нескольких людей) на основе одного шаблона и нескольких блоков пользовательских данных
• Размножение блока данных на листе (печать визитных карт и т.п.)
• несколько дополнительных бонус-функций (генерация разлинованного листа, листа нотной бумаги, и головоломки Судоку)
• (с версии 1.1) поддержка плагинов для реализации новых графических возможностей
• (с версии 1.4) поля, выводимые на все страницы документа (выод логотипов, штрих-кодов, и т.д.)

Установка модуля на web сервер

1. TCPDF - набор классов для генерации PDF файлов. Ссылка: tcpdf.org
2. Дополнительные модули FPDF-FPDFI, необходимые для поддержки чтения-импорта PDF шаблонов. Ссылка: http://www.setasign.de/
3. Если планируется генерация пазлов судоку, нужно скачать и установить модуль class.Sudoku.php

Использование класса

if(!class_exists('TCPDF',false)) {
    require_once('tcpdf/config/lang/rus.php'); // Подключаем использование своего языкового пакета, здесь - русского
    require_once 'tcpdf/tcpdf.php';
    require_once 'fpdf/fpdi2tcpdf_bridge.php';
    require_once 'fpdf/fpdi.php';
}
require_once('printform-pdf.php');

$xmlcfg = "pdf-config.xml";

$pdf = new CPrintFormPdf(array(
    'configfile' => $xmlcfg
   ,'outname' => "output-file.pdf"
   ,'author'  => 'Some clever guy'
   ,'creator' => 'Test program'
   ,'title'   => 'Generated test PDF'
   ,'subject' => 'Testing PDF creation filled by user data'
   ,'compression' => true
));

$userdata = array(
    'cityname' => 'Moscow'
   ,'personname' => 'Dow'
   ,'person_firstname' => 'John'
   ,'person_birthdate' => '04/15/1970'
   ,'person_document' => 'Passport 0034 010203'
   ,'demostring' => 'DEMONSTATION!'
);
$pdf->AddData($userdata);
$pdf->Render(); // генерация в поток клиенту, браузер предложит открыть/сохранить PDF файл

Формат настроечного XML-файла

<?xml version="1.0" encoding="UTF-8"?>
<printdef>
  <version>1.0</version>
  <title>Testing PDF generation</title>
  <description>This is a test PDF document created by CPrintfromPDF class</description>
  <stringcharset>UTF-8</stringcharset>

  <baseparameters>
    <margins left="0" top="0" right="0" bottom="0" />
    <font name="arial" size="6" />
    <page orientation="P" size="A4" units="mm" />
    <template src="pdf-template.pdf" altsrc="pdf-template-alternate.pdf" />
  </baseparameters>

  <pages>
   <page>
      <template page="1" />
      <field name="cityname" posx="143" posy="26" />
      <field name="personname" posx="42" posy="26" />
      <field name="person_firstname" posx="88" posy="26" width="20" />
      <field name="person_birthdate" posx="42" posy="32" width="70" />
      <field name="person_document" posx="143" posy="32" width="55" />
      <field name="demostring"     posx="50"  posy="110" rotate="45" size="40" color="#EE4040"/>
   </page>
  </pages>
</printdef>

Помимо списка полей, блок описания страницы может содеражать один специальный элемент : datagrid, упрощающий вывод однотипных данных в таблицу.
Допустим, вам нужно напечатать на PDF-странице таблицу (до 30 строк) с данными сотрудников, для каждого из них выводя его ФИО, дату рождения и зарплату.
Чтобы сделать это "обычным" способом, пришлось бы готовить длинный XML с описанием всех 30 блоков по 3 поля в каждом :

  ...
  <page>
      <field name="emp_name1" posx="10" posy="26" />
      <field name="emp_birthdate1" posx="50" posy="26" />
      <field name="emp_duty1" posx="80" posy="26" />
      <field name="emp_salary1" posx="120" posy="26" />

      <field name="emp_name2" posx="10" posy="32" />
      <field name="emp_birthdate2" posx="50" posy="32" />
      <field name="emp_duty2" posx="80" posy="32" />
      <field name="emp_salary2" posx="120" posy="32" />
      /**... and so on **/
  </page>
  ...

  ...
  <page>
      <field name="emp_name" posx="10" />
      <field name="emp_birthdate" posx="50" />
      <field name="emp_duty" posx="80" />
      <field name="emp_salary" posx="120" />
      <datagrid name="empl_grid" fields="emp_name,emp_birthdate,emp_duty,emp_salary" posy="26" step_y="6" rows="30" />
  </page>
  ...

• "name" - уникальное имя (ИД) таблицы
• "fields" - список имен ранее объявленных полей, входящих в "грид" (разеделенный запятыми),
• "posx" - горизонтальная позиция (смещение таблицы) - это значение добавляется к X-позициям всех полей внутри таблицы.
• "posy" - вертикальная позиция (отсюда начнется печать первой строки таблицы)
• "step_y" - шаг по вертикали - расстоние до следующей строки таблицы
• "rows" - максимальное число строк данных в таблице (следите, чтобы таблица не вылезла за границы листа!)

1. Честно заполнить массив данных для метода AddData($data) всеми "нумерованными" парами данных ключ=>значение:
   

   $data[emp_name1'] = 'Joshua Gordon';
   $data['emp_birth1'] = '1980-04-20';
   ...
   $data['emp_name2'] = 'Alex Johnson';
   $data['emp_birth2'] = '1975-10-09';
   ...
   $pdf->AddData($data);
   

2. Занести в основной массив $data все поля кроме таблицы, вызвать метод AddData($data), а после этого вызвать метод AddDataGridRow():
   
   

   // мы считаем, что каждый элемент массива  $employees - это ассоциативный массив с необходимыми значениями
   $pdf->AddData($data);
   foreach($employees as $oneempl) {
     $pdf->AddDataGridRow('empl_grid', $oneempl);
   }
   

   AddDataGridRow() заполняет одну строку таблицы и может быть вызван столько раз, сколько у вас есть фактических данных (в нашем примере - сотрудников).
3. Все данные для "грида" могут быть переданы как особый элемент массива $data для метода AddData().
   Для этого используется специальное имя (ключ) поля в массиве, оно начинается с префикса 'grid:', за которым следует имя (ИД) нашего описания таблицы:
   

   $data['grid:empl_grid'] = array(
        array('emp_name'=>'Joshua Gordon', 'emp_birth'=>'1980-04-20')
       ,array('emp_name'=>'Alex Johnson', 'emp_birth'=>'1975-10-09')
   );
   $pdf->AddData($data);
   $pdf->Render();
     

Дополнительные возможности

• "разлинованного" листа в клетку/полоску AddPageLined(),
• чистого нотного листа - AddPageMusicStaff() (учащимся музыкальных школ можно не покупать нотные тетради, если у папы есть компьютер и принтер :) ),
• и странички популярной головоломки (пазла) Судоку - см.метод AddPageSudoku().

Описание методов класса

Использование массива координат posx

<field name="date_entered" ... posx="50,54,0,70,74,0,0,0,90,94" />

// Нарисуем горизонтальную линию
$pdf = new CPrintFormPdf(...);
...
$pdf->AddData($mydata);
$pdf->Render(false);
$tcpdf = $pdf->getPdfObject();
$tcpdf->Line(10,100,190, 100);
$pdf->Output(); // финал: закрываем PDF и посылаем клиенту (или сохраняем на диск)

Вывод штрих-кодов

Фрагмента XML с описанием поля "штрих-код"
      ...
      <field name="barcode_crc" type="barcode:C128" posx="10"  posy="180" width="40" height="10" options="border,text" color="#EE4040"/>
      ...

Вывод QR-кодов

Размножение (дублирование) данных на странице : тег repeat

<?xml version="1.0" encoding="UTF-8"?>
<printdef>
  <version modified="2012-11-02">1.0</version>
  <title>Visit card template</title>
  <baseparameters>
    <margins left="0" top="0" right="0" bottom="0" />
    <font name="arial" size="8" />
    <page orientation="P" size="A4" units="mm" />
  </baseparameters>

  <pages>
   <page>
   <template page="1" />
    <field name="corner1" type="poly" posx="10,10,14" posy="14,10,10" color="#AAA" />
    <field name="corner2" type="poly" posx="91,95,95" posy="10,10,14" color="#AAA" />
    <field name="corner3" type="poly" posx="10,10,14" posy="61,65,65" color="#AAA" />
    <field name="corner4" type="poly" posx="91,95,95" posy="65,65,61" color="#AAA" />

    <field name="logo" type="image" posx="12" posy="12" width="26" height="26" src="logo.png" />
    <field name="lastname" posx="45" posy="20" width="35" color="#008" size="14" />
    <field name="firstname" posx="45" posy="28" width="35" size="12"/>
    <field name="middlename" posx="45" posy="35" width="35"  size="12" />
    <field name="duty"       posx="45" posy="42" width="35" size="7"/>
    <field name="phones"     posx="15" posy="52" width="75" align="C" size="7"/>
    <!-- duplicate card on the page -->
    <repeat offset_x="88" offset_y="0" />
    <repeat offset_x="0" offset_y="57" />
    <repeat offset_x="88" offset_y="57" />
    <repeat offset_x="0" offset_y="114" />
    <repeat offset_x="88" offset_y="114" />
    <repeat offset_x="0" offset_y="171" />
    <repeat offset_x="88" offset_y="171" />
    <repeat offset_x="0" offset_y="228" />
    <repeat offset_x="88" offset_y="228" />

   </page>
  </pages>
</printdef>

$pdfOptions = array('outname' =>'mycard.pdf', 'configfile' => 'pdf-card.xml');
$pdf = new CPrintFormPdf($pdfOptions);
$data = array(
     'lastname'=>'Stivenson'
    ,'firstname'=>'Alex'
    ,'middlename'=>'Jr'
    ,'duty'=>'Senior Sales Manager'
    ,'phones'=>'+1(555)111-2200, 111-2233'
);
$pdf->AddData($data);
$pdf->Render();

Поля, выводимые на всех страницах

<?xml version="1.0" encoding="UTF-8"?>
<printdef>
  <version>1.0</version>
  <title>Testing PDF generation</title>
  <allpages>
    <field name="bar_code01" type="barcode" posx="100" posy="280" width="50" height="5" options="text" value="012345678" />
  </allpages>
  ...
</printdef>

Поддержка плагинов

require_once('printform-pdf.php');
require_once('my-plugin.php');

<?xml version="1.0" encoding="UTF-8"?>
<printdef>
  ...
  <pages>
   <page>
      <template page="1" />
      <field name="cityname" posx="143" posy="26" />
      <field name="personname" posx="42" posy="26" />
      <field name="person_firstname" posx="88" posy="26" width="20" />
      <field name="person_birthdate" posx="42" posy="32" width="70" />
      <field name="person_document" posx="143" posy="32" width="55" />
      <plugin name="chart_gantt" type="my_plugin_classname" posx="10"  posy="160" width="180" height="80"
        options="dateformat=d.m,descr_width=0.25,arrow_color=#F22,shade_color=#BBB" />
   </page>
  </pages>
</printdef>

class PfPdf_Gantt extends PfPdfPlugin {
    private $_config = array();
    private $tcpdf_obj = null;
    private $xpos,$ypos,$width,$height;
    public function __construct($pdfobj, $config=null, $x=0,$y=0,$w=0,$h=0) {
        $this->tcpdf_obj = $pdfobj;
        $this->xpos = $x;
        $this->ypos = $x;
        $this->width = $w;
        $this->height = $h;
        $this->_config = $config;
    }
    public function Render($data) { // just draw a rectangle
        $this->tcpdf_obj->Rect($this->xpos,$this->ypos,$this->width,$this->height,'D');
    }
}

Бонус-Функции

$pdf = new PrintFormPdf;
$pdf->AddPageLined('Lined page title',
    array(
        'step_y'=>12
       ,'step_x'=>12
       ,'color'=>'red'
   )
);

$obj->AddPageLined('','mm'); // выводится "серая" миллиметровка, цвет линий - RGB(180,180,180)
// или другой способ, если нужно задать свой цвет миллиметровой сетки:
$obj->AddPageLined('', array('mm'=>true, 'color'=>array(20,200,20)));

Возможные проблемы

История изменений

1.4.0023 (16.04.2014)

• Добавлена поддержка "All Pages Fields" (поля, выводимые на все страницы)
• Добавлена функция setResourcePaths()

1.3.0020 (2014-02-01)

• Добавлена функция disableImages()
• Добавлена поддержка тега repeat (дублирование данных на странице со сдвигом)

1.2 (2013-12-10)

• Добавлена функция addPageDef(), для программной загрузки описания страницы

1.1.0017 (22.05.2013)

• bugfix: работа класса вызывает ошибку при вызове convertHTMLColorToDec() , из-за того, что TCPDF 6.x перенес эту функцию в отдельный класс TCPDF_COLORS

1.1 (26.04.2013)

• new: добавлена поддержка плагинов (абстрактный класс PfPdfPlugin)

1.00 (14.11.2012)

• Первая публикация