fdf_add_template — Funktion · PHP-Referenz

Signatur

fdf_add_template(resource $fdf_document, int $newpage, string $filename, string $template, int $rename): bool

Beschreibung

fdf_add_template() ermöglicht es, einer FDF-Datei (Forms Data Format) ein Template hinzuzufügen, das auf eine bestimmte Seite einer PDF-Datei verweist. Templates werden in FDF-Dokumenten genutzt, um Formularvorlagen zu referenzieren, die beim Import in Adobe Acrobat auf bestehende PDF-Dokumente angewendet werden können.

Die FDF-Technologie wurde von Adobe entwickelt und erlaubt den kompakten Austausch von Formulardaten. Templates innerhalb eines FDF-Dokuments verknüpfen eine Seite einer externen PDF-Datei mit einem Bezeichner (Template-Name), sodass Acrobat-Anwendungen diese Seite als Vorlage einsetzen können.

Der Parameter newpage gibt an, ob beim Einfügen des Templates eine neue Seite angelegt werden soll, und rename steuert, ob das Template umbenannt werden soll, falls ein gleichnamiges Template im Zieldokument bereits vorhanden ist.

Hinweis: Die gesamte FDF-Erweiterung (ext/fdf) ist veraltet und wurde in modernen PHP-Versionen entfernt. Sie steht nur bis einschließlich PHP 5 zur Verfügung und sollte in neuen Projekten nicht mehr verwendet werden.

Parameter

Name	Typ	Beschreibung
$fdf_document Pflicht	resource	Eine gültige FDF-Dokumentressource, wie sie von `fdf_create()` oder `fdf_open()` zurückgegeben wird.
$newpage Pflicht	int	Gibt an, ob beim Hinzufügen des Templates eine neue Seite erstellt werden soll (`1` = neue Seite, `0` = keine neue Seite).
$filename Pflicht	string	Pfad oder Name der PDF-Datei, die das Template enthält. Dieser Wert wird als Dateireferenz im FDF-Dokument gespeichert.
$template Pflicht	string	Der Name des Templates innerhalb der angegebenen PDF-Datei, das dem FDF-Dokument hinzugefügt werden soll.
$rename Pflicht	int	Gibt an, ob das Template umbenannt werden soll, wenn im Zieldokument bereits ein Template mit demselben Namen vorhanden ist (`1` = umbenennen, `0` = nicht umbenennen).

Rückgabewert

Typ

bool

Beschreibung

Gibt true bei Erfolg zurück, false bei einem Fehler.

Beispiele

Template zu einem neuen FDF-Dokument hinzufügen

<?php
// Neue FDF-Ressource erstellen
$fdf = fdf_create();

if ($fdf) {
    // Template aus einer PDF-Datei dem FDF-Dokument hinzufügen
    $result = fdf_add_template(
        $fdf,
        0,                      // Keine neue Seite
        'vorlage.pdf',          // PDF-Datei mit dem Template
        'MeinTemplate',         // Name des Templates
        1                       // Umbenennen falls Konflikt
    );

    if ($result) {
        echo "Template erfolgreich hinzugefügt.";
        // FDF-Daten ausgeben
        fdf_save($fdf, 'ausgabe.fdf');
    } else {
        echo "Fehler beim Hinzufügen des Templates.";
    }

    fdf_close($fdf);
} else {
    echo "FDF-Dokument konnte nicht erstellt werden.";
}
?>

Template erfolgreich hinzugefügt.

FDF-Dokument mit Template als HTTP-Response senden

<?php
$fdf = fdf_create();

if ($fdf) {
    fdf_add_template($fdf, 0, 'formulare/antragsvorlage.pdf', 'Antrag2024', 0);

    // FDF direkt an den Browser senden
    header('Content-Type: application/vnd.fdf');
    header('Content-Disposition: attachment; filename="template.fdf"');

    fdf_save($fdf);
    fdf_close($fdf);
}
?>

// Wichtig · Fallstricke

Veraltete Erweiterung: Die PHP-FDF-Erweiterung (ext/fdf) ist seit PHP 5 veraltet und wurde in PHP 7 und höher vollständig entfernt. Sie ist nur verfügbar, wenn PHP mit der Adobe FDF-Toolkit-Bibliothek kompiliert wurde. Für moderne Projekte sollten Alternativen wie TCPDF oder FPDF in Betracht gezogen werden.

Die Funktion setzt voraus, dass das FDF-Toolkit von Adobe auf dem Server installiert und korrekt mit PHP verknüpft ist. Ohne diese Bibliothek steht die gesamte fdf_*-Funktionsfamilie nicht zur Verfügung.

Siehe auch

fdf_create fdf_open fdf_close fdf_save fdf_set_value