Example E066 : import document append

Appending a whole source document, or a selected list of its pages.

Appending a whole source document, or a selected list of its pages.

PDF

Page 1 of E066_import_document_append.pdf

Source Code

<?php

declare(strict_types=1);

/**
 * E066_import_document_append.php
 *
 * @since       2026-05-03
 * @category    Library
 * @package     Pdf
 * @author      Nicola Asuni <info@tecnick.com>
 * @copyright   2002-2026 Nicola Asuni - Tecnick.com LTD
 * @license     https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
 * @link        https://github.com/tecnickcom/tc-lib-pdf
 *
 * This file is part of tc-lib-pdf software library.
 */

// NOTE: local file reads (images, fonts, attachments) are restricted to an allowlist of
// trusted paths that covers this package tree, so run the examples in place. To read assets
// from other locations, list them in the 'allowedPaths' entry of the fileOptions constructor
// parameter (see E047_remote_resources_security.php).

// NOTE: run make fonts in the project root to generate the dependencies and example fonts.

// autoloader when using Composer
require __DIR__ . '/../vendor/autoload.php';

// define fonts directory
\define('K_PATH_FONTS', \realpath(__DIR__ . '/../vendor/tecnickcom/tc-lib-pdf-font/target/fonts'));

// ---- Step 1: build a multi-page source PDF ----

$src = new \Com\Tecnick\Pdf\Tcpdf();
$src->setCreator('tc-lib-pdf');
$src->setAuthor('Nicola Asuni');
$src->setSubject('tc-lib-pdf example: 066 source');
$src->setTitle('Import Document Append - Source');
$src->setKeywords('TCPDF tc-lib-pdf import document append source template');
$src->setPDFFilename('066_import_document_append_src.pdf');

$bfont = $src->font->insert($src->pon, 'helvetica', '', 14);

$pages = ['First page', 'Second page', 'Third page'];
foreach ($pages as $idx => $label) {
    $srcPage = $src->addPage();
    $src->page->addContent($bfont['out']);
    $src->addHTMLCell(
        html: '<h2>Source: '
        . \htmlspecialchars($label)
        . '</h2>'
        . '<p>Page '
        . ($idx + 1)
        . ' of '
        . \count($pages)
        . ' in the source document.</p>',
        posx: 15,
        posy: 20,
        width: 160,
    );
}

$sourcePdfData = $src->getOutPDFString();

// ---- Step 2: create destination document with an intro page ----

$pdf = new \Com\Tecnick\Pdf\Tcpdf();
$pdf->setCreator('tc-lib-pdf');
$pdf->setAuthor('Nicola Asuni');
$pdf->setSubject('tc-lib-pdf example: 066');
$pdf->setTitle('Import Document Append - Destination');
$pdf->setKeywords('TCPDF tc-lib-pdf import append merge destination template');
$pdf->setPDFFilename('066_import_document_append.pdf');

$bfont = $pdf->font->insert($pdf->pon, 'helvetica', '', 12);

$pdf->addPage();
$pdf->page->addContent($bfont['out']);
$pdf->addHTMLCell(
    html: '<h1>Document append demo</h1><p>The following pages are imported from a separate source document.</p>',
    posx: 15,
    posy: 20,
    width: 160,
);

// ---- Step 3: register source and append all its pages ----

$sourceId = $pdf->setImportSourceData($sourcePdfData);
$pageCount = $pdf->getSourcePageCount($sourceId);

// appendDocument adds one new destination page per source page and places the template.
$templates = $pdf->appendDocument($sourceId);

// ---- Step 4: add a closing page with a summary ----

$pdf->addPage();
$pdf->page->addContent($bfont['out']);
$pdf->addHTMLCell(
    html: '<p>Appended ' . \count($templates) . ' page(s) from source (' . $pageCount . ' available).</p>',
    posx: 15,
    posy: 20,
    width: 160,
);

// Render
$rawpdf = $pdf->getOutPDFString();
$pdf->renderPDF(rawpdf: $rawpdf);