Use this page when you know the integration type but need the package-specific reference for Portable Document Format (PDF) work. Each row links to the authoritative application programming interface (API) page for that extension area.
The API pages are source-backed and use a shared table format: symbol, parameters, default behavior, return value, failure mode, and operational notes.
| Surface | Package | Primary symbols | API page |
|---|
| Laravel facade and container bindings | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | Laravel API |
| Laravel Hypertext Transfer Protocol (HTTP) responses | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, stream response helpers | Laravel API |
| Laravel queue jobs | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | Laravel API |
| Symfony factory and bundle | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | Symfony API |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | Symfony API |
| CodeIgniter service and library | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | CodeIgniter API |
| CodeIgniter queue job | nextpdf/codeigniter | GeneratePdfJob::process, static builder callable | CodeIgniter API |
| Surface | Package | Primary symbols | API page |
|---|
| Chrome rendering on the host | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | Artisan API |
| Chrome PDF import | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | Artisan API |
| Low-level parser diagnostics | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | Artisan API |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | Cloudflare API |
| Cloudflare API protection | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | Cloudflare API |
| Cloudflare R2 archival | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | Cloudflare API |
| Gotenberg office document conversion | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | Gotenberg API |
| Gotenberg format and transport policy | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | Gotenberg API |
| Surface | Package | Primary symbols | API page |
|---|
| TCPDF adapter | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | TCPDF compatibility API |
| TCPDF method families | nextpdf/compat-legacy | Text, font, page, image, drawing, security, form, and output concerns | TCPDF method coverage |
| Backport build scripts | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | Backport Builder API |
| Backport Rector rules | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | Backport Builder API |
| Task | Start with | Then read |
|---|
| Return a PDF from a framework controller | PdfResponse in the matching framework package. | The package quickstart, then the api response table. |
| Generate PDF files in a background worker | Laravel GeneratePdfJob, Symfony GeneratePdfMessage, or CodeIgniter GeneratePdfJob. | The package developer-guide queue or Messenger pattern. |
| Render Hypertext Markup Language (HTML) with Chrome on the host | ChromeHtmlRenderer::render(). | Artisan configuration, security, and production usage pages. |
| Render HTML through Cloudflare | CloudflareHtmlRenderer::render(). | Cloudflare API protection and Worker operations pages. |
| Convert office documents | GotenbergBridge::convertFile() or convertString(). | Gotenberg configuration and troubleshooting pages. |
| Archive generated PDFs to object storage | R2ArchiveManager::upload() and generateSignedUrl(). | Cloudflare production usage and security pages. |
| Migrate a TCPDF codebase | TCPDF, method coverage, and OutputBridge. | The TCPDF compatibility migration guide. |
| Build older-runtime packages | scripts/build.php and Build::run(). | The Backport developer guide and production usage pages. |
| Task | Config area | Package page |
|---|
| Set document metadata defaults | defaults.* | Laravel, Symfony, or CodeIgniter configuration. |
| Preload production fonts | preload_fonts or preloadFonts | Framework configuration pages. |
| Configure the Chrome binary and timeout | artisan.* or ChromeRendererConfig | Artisan and framework configuration pages. |
| Configure signing and Time-Stamping Authority (TSA) | signature.*, tsa.*, ocsp_cache.* | Framework configuration pages. |
| Protect public render endpoints | ApiProtectionConfig | Cloudflare API and security pages. |
| Configure the R2 archive | R2ArchiveConfig | Cloudflare configuration and API pages. |
| Configure the Gotenberg service | GotenbergConfig | Gotenberg configuration and API pages. |
| Tune compatibility behavior | AdaptationConfig | TCPDF compatibility configuration page. |
| Symptom | Likely API boundary | First diagnostic page |
|---|
| Response downloads with the wrong filename | Framework PdfResponse helper. | Matching framework API page. |
| Queue job fails before rendering | Job/message validation. | Matching framework troubleshooting page. |
| Chrome rendering times out | ChromeHtmlRenderer or BrowserPool. | The Artisan troubleshooting page. |
| Worker returns data that is not PDF output | CloudflareResponseParser. | The Cloudflare troubleshooting page. |
| R2 upload succeeds, but the Uniform Resource Locator (URL) is not usable | R2UploadResult or signed URL generation. | The Cloudflare production usage page. |
| Office file is rejected | OfficeFormat or GotenbergSecurityPolicy. | The Gotenberg troubleshooting page. |
| Legacy TCPDF method throws | Compatibility concern or exception factory. | The TCPDF method coverage page. |
| Backport output fails the syntax check | Rector config or custom rule. | The Backport developer guide. |
Each package API page is expected to document:
| Required detail | Reason |
|---|
| Fully qualified symbol | Helps you search source and tests without guessing namespaces. |
| Parameter names and defaults | Prevents call-site ambiguity and supports typed examples. |
| Default behavior | Makes optional input safe to omit deliberately. |
| Return value or side effect | Shows whether the method is fluent, terminal, or diagnostic. |
| Failure mode | Helps production code fail closed and log the correct boundary. |
| Operational note | Captures worker safety, security, memory, timeout, or compatibility concerns. |
