Verwenden Sie diese Seite, wenn Sie den Integrationstyp kennen, aber nicht die paketspezifische Seite. Jede Zeile verweist auf die maßgebliche API-Referenz für diesen Erweiterungsbereich.
Die API-Seiten sind quellengestützt und verwenden dieselbe Tabellenstruktur: Symbol, Parameter, Standardverhalten, Rückgabewert, Fehlermodus und Betriebshinweise.
| Bereich | Paket | Primäre Symbole | API-Seite |
|---|
| Laravel-Facade und Container-Bindungen | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | Laravel-API |
| Laravel-HTTP-Antworten | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, Stream-Response-Helfer | Laravel-API |
| Laravel-Queue-Jobs | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | Laravel-API |
| Symfony-Factory und -Bundle | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | Symfony-API |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | Symfony-API |
| CodeIgniter-Service/-Library | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | CodeIgniter-API |
| CodeIgniter-Queue-Job | nextpdf/codeigniter | GeneratePdfJob::process, statischer Builder-Callable | CodeIgniter-API |
| Bereich | Paket | Primäre Symbole | API-Seite |
|---|
| Lokales Chrome-Rendering auf dem Host | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | Artisan-API |
| Chrome-PDF-Import | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | Artisan-API |
| Low-Level-Parserdiagnostik | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | Artisan-API |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | Cloudflare-API |
| Cloudflare-API-Schutz | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | Cloudflare-API |
| Cloudflare-R2-Archivierung | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | Cloudflare-API |
| Gotenberg-Office-Konvertierung | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | Gotenberg-API |
| Gotenberg-Richtlinie für Format und Transport | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | Gotenberg-API |
| Bereich | Paket | Primäre Symbole | API-Seite |
|---|
| TCPDF-Adapter | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | TCPDF-Kompatibilitäts-API |
| TCPDF-Methodenfamilien | nextpdf/compat-legacy | Text-, Schrift-, Seiten-, Bild-, Zeichen-, Sicherheits-, Formular- und Ausgabebereiche | TCPDF-Methodenabdeckung |
| Backport-Build-Skripte | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | Backport-Builder-API |
| Backport-Rector-Regeln | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | Backport-Builder-API |
| Aufgabe | Beginnen Sie mit | Dann lesen Sie |
|---|
| Ein PDF aus einem Framework-Controller zurückgeben | PdfResponse im passenden Framework-Paket. | Die quickstart-Seite des Pakets, danach dessen api-Response-Tabelle. |
| PDFs in einem Hintergrund-Worker erzeugen | Laravel GeneratePdfJob, Symfony GeneratePdfMessage oder CodeIgniter GeneratePdfJob. | Das Queue- oder Messenger-Muster im developer-guide des Pakets. |
| HTML mit lokalem Chrome auf dem Host rendern | ChromeHtmlRenderer::render(). | Artisan-Seiten zu Konfiguration, Sicherheit und Produktiveinsatz. |
| HTML über Cloudflare rendern | CloudflareHtmlRenderer::render(). | Cloudflare-Seiten zu API-Schutz und Worker-Betrieb. |
| Office-Dokumente konvertieren | GotenbergBridge::convertFile() oder convertString(). | Gotenberg-Seiten zu Konfiguration und Fehlerbehebung. |
| Erzeugte PDFs in einem Object Storage archivieren | R2ArchiveManager::upload() und generateSignedUrl(). | Cloudflare-Seiten zu Produktiveinsatz und Sicherheit. |
| Eine TCPDF-Codebasis migrieren | TCPDF, Methodenabdeckung und OutputBridge. | TCPDF-Kompatibilitätsleitfaden zur Migration. |
| Pakete für ältere Laufzeitumgebungen bauen | scripts/build.php und Build::run(). | Backport-Entwicklerleitfaden und Hinweise zum Produktiveinsatz. |
| Aufgabe | Konfigurationsbereich | Paketseite |
|---|
| Standardwerte für Dokumentmetadaten festlegen | defaults.* | Laravel-, Symfony- oder CodeIgniter-Konfiguration. |
| Schriften für den Produktiveinsatz vorladen | preload_fonts oder preloadFonts | Framework-Konfigurationsseiten. |
| Chrome-Binary und Timeout konfigurieren | artisan.* oder ChromeRendererConfig | Artisan- und Framework-Konfigurationsseiten. |
| Signierung und TSA konfigurieren | signature.*, tsa.*, ocsp_cache.* | Framework-Konfigurationsseiten. |
| Öffentliche Render-Endpunkte schützen | ApiProtectionConfig | Cloudflare-Seiten zu API und Sicherheit. |
| R2-Archiv konfigurieren | R2ArchiveConfig | Cloudflare-Seiten zu Konfiguration und API. |
| Gotenberg-Service konfigurieren | GotenbergConfig | Gotenberg-Seiten zu Konfiguration und API. |
| Kompatibilitätsverhalten anpassen | AdaptationConfig | TCPDF-Konfigurationsseite zur Kompatibilität. |
| Symptom | Wahrscheinliche API-Grenze | Erste Diagnoseseite |
|---|
| Antwort wird mit einem falschen Dateinamen heruntergeladen | Framework-PdfResponse-Helfer. | Passende Framework-API-Seite. |
| Queue-Job schlägt vor dem Rendern fehl | Job-/Message-Validierung. | Passende Framework-Fehlerbehebungsseite. |
| Chrome-Rendering endet mit einem Timeout | ChromeHtmlRenderer oder BrowserPool. | Artisan-Fehlerbehebungsseite. |
| Worker liefert Nicht-PDF-Daten zurück | CloudflareResponseParser. | Cloudflare-Fehlerbehebungsseite. |
| R2-Upload gelingt, aber die URL lässt sich nicht verwenden | R2UploadResult oder Erzeugung der signierten URL. | Cloudflare-Seite zum Produktiveinsatz. |
| Office-Datei wird abgelehnt | OfficeFormat oder GotenbergSecurityPolicy. | Gotenberg-Fehlerbehebungsseite. |
| Veraltete TCPDF-Methode löst eine Exception aus | Kompatibilitätsbereich oder Exception-Factory. | TCPDF-Methodenabdeckungsseite. |
| Backport-Ausgabe besteht die Syntaxprüfung nicht | Rector-Konfiguration oder benutzerdefinierte Regel. | Backport-Entwicklerleitfaden. |
Von jeder Paket-API-Seite wird erwartet, dass sie Folgendes dokumentiert:
| Erforderliches Detail | Grund |
|---|
| Vollständig qualifiziertes Symbol | Ermöglicht die Suche in Quellcode und Tests, ohne Namespaces erraten zu müssen. |
| Parameternamen und Standardwerte | Verhindert Mehrdeutigkeit an der Aufrufstelle und unterstützt typisierte Beispiele. |
| Standardverhalten | Ermöglicht es, optionale Eingaben bewusst und sicher wegzulassen. |
| Rückgabewert oder Seiteneffekt | Zeigt, ob die Methode fluent, terminal oder diagnostisch ist. |
| Fehlermodus | Hilft Produktionscode dabei, kontrolliert fehlzuschlagen und die richtige Grenze zu protokollieren. |
| Betriebshinweis | Erfasst Betriebsaspekte zu Worker-Sicherheit, Sicherheit, Speicher, Timeout oder Kompatibilität. |
