Start · Sprachen · PHP · Referenz · fdf_get_status

fdf_get_status

Funktion

Liest den Wert des <code>/STATUS</code>-Schlüssels aus einem FDF-Dokument und gibt ihn als Zeichenkette zurück.

seit PHP 4.0.0 Kategorie: io

Signatur

fdf_get_status(resource $fdf_document): string

Beschreibung

fdf_get_status() gehört zur FDF-Erweiterung (Forms Data Format) von PHP und ermöglicht das Auslesen des /STATUS-Eintrags aus einem FDF-Dokument. FDF ist ein von Adobe entwickeltes Format, das speziell zum Austausch von Formulardaten in PDF-Dokumenten dient.

Der /STATUS-Schlüssel in einem FDF-Dokument enthält eine optionale Statusmeldung, die vom Server an den Client übertragen werden kann – beispielsweise eine Rückmeldung nach dem Absenden eines PDF-Formulars. Diese Statusmeldung kann Informationen darüber enthalten, ob die Verarbeitung der Formulardaten erfolgreich war oder ob Fehler aufgetreten sind.

Die Funktion wird typischerweise eingesetzt, wenn PHP-Skripte PDF-basierte Formulare empfangen und verarbeiten, und der Status der serverseitigen Verarbeitung an die PDF-Anwendung des Nutzers zurückgemeldet werden soll. Das zurückgegebene Ergebnis kann anschließend z. B. mit fdf_set_status() in einem neuen FDF-Dokument gesetzt werden.

Hinweis: Die FDF-Erweiterung ist seit PHP 7.0 nicht mehr im offiziellen PHP-Kern enthalten und wird als veraltet angesehen. Für neue Projekte empfiehlt sich der Einsatz alternativer PDF-Bibliotheken.

Parameter

Name Typ Default Beschreibung
$fdf_document Pflicht resource Eine gültige FDF-Dokument-Ressource, die zuvor mit fdf_open() oder fdf_create() erstellt wurde.

Rückgabewert

Typ
string
Beschreibung
Gibt den Wert des /STATUS-Schlüssels aus dem FDF-Dokument als Zeichenkette zurück. Ist kein /STATUS-Schlüssel im Dokument vorhanden, wird eine leere Zeichenkette zurückgegeben.

Beispiele

Statusmeldung aus einem empfangenen FDF-Dokument auslesen

<?php
// FDF-Dokument aus dem HTTP-Body öffnen (typisch bei PDF-Formular-Übermittlung)
$fdf = fdf_open_string($HTTP_RAW_POST_DATA);

if ($fdf) {
    // Statuswert aus dem FDF-Dokument lesen
    $status = fdf_get_status($fdf);

    if (!empty($status)) {
        echo 'FDF-Status: ' . htmlspecialchars($status);
    } else {
        echo 'Kein STATUS-Schlüssel im FDF-Dokument vorhanden.';
    }

    fdf_close($fdf);
} else {
    echo 'FDF-Dokument konnte nicht geöffnet werden.';
}
?>
FDF-Status: Formular erfolgreich empfangen

Status setzen und anschließend wieder auslesen

<?php
// Neues FDF-Dokument erstellen
$fdf = fdf_create();

// Status im FDF-Dokument setzen
fdf_set_status($fdf, 'Verarbeitung abgeschlossen');

// Status wieder auslesen
$status = fdf_get_status($fdf);
echo 'Gesetzter Status: ' . htmlspecialchars($status);

fdf_close($fdf);
?>
Gesetzter Status: Verarbeitung abgeschlossen

// Wichtig · Fallstricke

Deprecation-Hinweis: Die FDF-Erweiterung (ext/fdf) wurde mit PHP 7.0 aus dem offiziellen PHP-Kern entfernt. Sie steht nur als PECL-Paket zur Verfügung und sollte in neuen Projekten nicht mehr verwendet werden. Alternativen für die PDF-Verarbeitung sind Bibliotheken wie FPDF, TCPDF oder Spatie PDF.

Die FDF-Erweiterung benötigt die externe Adobe FDF-Toolkit-Bibliothek. Ohne diese Bibliothek können die FDF-Funktionen nicht verwendet werden.