Zum Inhalt springen
getnextpdf.com

PHP-Cookbook

Dies ist das Verzeichnis für PHP-native NextPDF-Rezepte — aufgabenorientierte, ausführbare Seiten, die direkt für die Core-PHP-API geschrieben sind. Das nextpdf-Core-Repository verantwortet und verifiziert jedes Rezept unter docs/public/cookbook/php/. Jedes Rezept wird durch ein examples/*.php-Skript und einen tests/Cookbook/Php/-Harness-Test abgesichert. Der Aggregator übernimmt dann jede Seite in diese Site und führt ihre Quellherkunft mit.

Da diese Seite ein Verzeichnis ist, macht sie keine Verhaltensaussage über einzelne Rezepte. Jede Zeile nennt den Zweck des Rezepts, das Core-Modul, das es nutzt, und sein deklariertes Reproduzierbarkeitsprofil. Das Profil und jede Konformitätsaussage stehen auf der Rezeptseite selbst, gespeist aus dem Front-Matter der jeweiligen Seite und ihrem Test im Repository — nicht hier. Das Integrations-Kochbuch für Framework, Renderer und Dienst finden Sie unter Integrations-Kochbuch. Den Vertrag, dem jedes ausführbare Rezept folgt, finden Sie unter Rezeptkonventionen.

Jedes Rezept wird im Core-Repository unter docs/public/cookbook/php/ verfasst und vom Aggregator auf dieser Site veröffentlicht. Der Slug folgt der Konvention eines einzelnen Segments.

/cookbook/php/<recipe>/

<recipe> bezeichnet den Zweck des Rezepts in Kebab-Case (zum Beispiel render-html-to-pdf, nicht den Modulnamen html). Er ist durchgängig kleingeschrieben, durch Bindestriche getrennt, frei von Versionsnummern und endet auf einem einzigen abschließenden Schrägstrich.

Jedes Rezept deklariert das strengste Profil, das es ehrlich erfüllen kann:

  • bitweise — byte-identisch über alle Durchläufe hinweg (rein deterministischer Inhalt, jede Entropie fixiert).
  • strukturell — identisch nach Normalisierung flüchtiger Atome (das Trailer-/ID, creation/modification-Daten, Font-Subset-Präfixe — in der Praxis jedes PDF mit mehreren Objekten).
  • semantisch — nur Äquivalenz des Struktur-AST plus Metadaten (signierte oder mit Zeitstempel versehene Ausgabe oder Ausgabe, deren Äquivalenz von Natur aus nicht byte-stabil ist).

Das Profil ist eine Eigenschaft, die die Rezeptseite durch ihren Harness-Test belegt. Dieses Verzeichnis meldet nur den Wert, den die Seite deklariert.

Ein Dokument aufbauen, paginieren und gestalten.

RezeptWas es tutModulProfil
render-html-to-pdfEin HTML-Dokument in PDF rendernHtmlstrukturell
style-with-cssCSS auf ein HTML-Rendering anwendenHtmlstrukturell
html-table-layoutEine HTML-Tabelle layoutenHtmlstrukturell
paginate-long-htmlEin langes HTML-Dokument paginierenHtmlstrukturell
paginate-large-html-tablesEine große HTML-Tabelle über mehrere Seiten paginierenHtmlstrukturell
render-rtl-arabic-htmlArabisches HTML von rechts nach links rendernHtmlstrukturell
compose-text-and-fontsText mit Typografie-Kontrolle setzenTypographystrukturell
embed-and-subset-fontsSchriften einbetten und subsettenFontstrukturell
cjk-vertical-writingCJK-Text im vertikalen Schreibmodus setzenTypographystrukturell
multi-page-documentEin mehrseitiges Dokument aufbauenDocumentstrukturell
headers-and-footersLaufende Kopf- und Fußzeilen hinzufügenLayoutstrukturell

Vektoren, Bilder, Ebenen und Koordinatenraum.

RezeptWas es tutModulProfil
draw-vector-graphicsVektorgrafiken zeichnenGraphicsstrukturell
gradients-and-transparencyVerläufe und Transparenz anwendenGraphicsstrukturell
embed-imagesRasterbilder einbettenContentstrukturell
add-watermarks-and-backgroundsText- und Bildwasserzeichen oder Hintergründe zu Seiten hinzufügenContentstrukturell
cmyk-spot-color-and-icc-profilesDruckfertige CMYK- und Sonderfarben erzeugenColorstrukturell
embed-file-attachmentsDateien einbetten und PDF-Portfolios erstellenContentstrukturell
optional-content-layersOptionalen Inhalt (Ebenen) verwendenGraphicsstrukturell
transform-coordinate-spaceDen Koordinatenraum transformierenGraphicsstrukturell

Lesezeichen, Links, Anmerkungen und AcroForm-Felder.

RezeptWas es tutModulProfil
bookmarks-and-tocLesezeichen und ein Inhaltsverzeichnis aufbauenNavigationstrukturell
generate-dynamic-table-of-contentsEin dynamisches Inhaltsverzeichnis generierenNavigationstrukturell
links-and-annotationsLinks und Anmerkungen hinzufügenNavigationstrukturell
generate-barcodesBarcodes generierenBarcodebitweise
gs1-composite-barcodesGS1-Composite-Barcodes erzeugen (CC-C-Träger)Barcodestrukturell
fill-pdf-formEin AcroForm ausfüllenFormstrukturell
flatten-form-fieldsFormularfelder abflachenFormstrukturell
form-field-validation-and-flatten-with-stateFormularfelder validieren und mit Status abflachenFormstrukturell

Metadaten und Viewer-Verhalten festlegen.

RezeptWas es tutModulProfil
set-document-metadataDokumentmetadaten festlegenMetadatastrukturell
set-viewer-preferencesViewer-Einstellungen festlegenDocumentstrukturell

Vorhandene Dokumente zusammenfügen, aufteilen und optimieren.

RezeptWas es tutModulProfil
merge-external-pdfsExterne PDFs zusammenführen oder Seiten anhängenDocumentstrukturell
split-and-extract-pagesEin PDF aufteilen und Seitenbereiche extrahierenDocumentstrukturell
optimize-pdf-file-sizePDF-Dateigröße durch Komprimierung und Subsetting reduzierenDocumentstrukturell

Verschlüsselung, Signierung, Barrierefreiheit und Profilausgabe. Diese Rezepte machen die Grenzen Unterstützung≠Konformität und Vorhandensein≠Gültigkeit auf der jeweiligen Rezeptseite deutlich.

RezeptWas es tutModulProfil
encrypt-aes256Mit AES-256 verschlüsseln und Berechtigungsflags setzenSecuritystrukturell
encrypt-with-permissionsMit Berechtigungsflags verschlüsselnSecuritystrukturell
sign-pades-b-bEine PAdES-Signatur anwenden (B-B und B-T)Securitysemantisch
inspect-existing-signatureEine vorhandene Signatur prüfenInspectsemantisch
tagged-pdf-ua2Getaggte Struktur für PDF/UA-2 ausgebenAccessibilitysemantisch
accessible-pdfua2-from-htmlDie getaggte Struktur für barrierefreies PDF/UA-2-Authoring aus HTML ausgebenAccessibilitysemantisch
pdf-a-4-outputPDF/A-4-Ausgabe erzeugenConformancesemantisch
pdfa4-conformance-gatePDF/A-4-Ausgabe erzeugen und mit einem externen Validator absichernConformancesemantisch
validate-conformanceGegen ein Konformitätsprofil validierenCompliancesemantisch

Inhalt und Struktur aus einem PDF auslesen.

RezeptWas es tutModulProfil
extract-text-contentTextinhalt extrahierenTextsemantisch
multilingual-copy-paste-extractionKorrektes Kopieren und Einfügen aus CJK- und arabischen PDFs sicherstellenTextstrukturell
parse-and-inspect-pdfEin PDF parsen und inspizierenInspectsemantisch
inspect-layout-boxesLayout-Boxen inspizierenInspectsemantisch

Muster, die sich über mehrere Module erstrecken.

RezeptWas es tutUmfasstProfil
worker-safe-batch-renderingSicher in einem langlaufenden Worker rendern (gemeinsame Registries, begrenzter Speicher)Core · Performance · Supportsemantisch
streaming-and-memoryStreaming- und Speichernutzung profilenPerformancebitweise
exception-aware-error-handlingFehler mit der NextPDF-Ausnahmehierarchie behandelnException · Contractsstrukturell
custom-error-recovery-patternsEigene Fehlerbehebungs- und Wiederholungsstrategien implementierenExceptionsemantisch
observe-with-opentelemetryRendering mit OpenTelemetry beobachtenObservability · Telemetry · Eventsemantisch

Jedes oben aufgeführte Rezept wird mit einem unterstützenden examples/*.php-Skript und einem tests/Cookbook/Php/-Harness-Test im Core-Repository veröffentlicht. Wird ein neues Rezept im Upstream verfasst, erscheint es hier, sobald sein Beispiel und sein Test vorliegen.