Integrations
At a glance
Section titled “At a glance”NextPDF extensions connect the core Portable Document Format (PDF) engine to application frameworks, browser renderers, edge services, build tooling, and legacy migrations. Each extension section follows the same manual structure: overview, install, quickstart, configuration, application programming interface (API), developer guide, production usage, security, and troubleshooting.
Extension map
Section titled “Extension map”| Extension | Package | Use it when | Main section |
|---|---|---|---|
| Laravel | nextpdf/laravel | Use it when you build Laravel applications and need container bindings, a facade, responses, and queue jobs. | Laravel |
| Symfony | nextpdf/symfony | Use it when you build Symfony applications and need a bundle, dependency injection wiring, Messenger jobs, and Hypertext Transfer Protocol (HTTP) responses. | Symfony |
| CodeIgniter | nextpdf/codeigniter | Use it when you build CodeIgniter 4 applications and need services, a library wrapper, responses, and queue jobs. | CodeIgniter |
| Artisan | nextpdf/artisan | Use it when you need Chrome DevTools Protocol (CDP) Hypertext Markup Language (HTML) rendering, page import, or low-level PDF inspection utilities. | Artisan |
| Cloudflare | nextpdf/cloudflare | Use it when you render through Cloudflare Browser Rendering, protect API access, or archive PDFs to R2. | Cloudflare |
| Gotenberg | nextpdf/gotenberg | Use it when you convert office documents or HTML through a Gotenberg service. | Gotenberg |
| TCPDF compatibility | nextpdf/compat-legacy | Use it when you migrate TCPDF-shaped application code to NextPDF without a full rewrite. | TCPDF compatibility |
| Backport Builder | nextpdf/backport-builder | Use it when you maintain release artifacts for older PHP: Hypertext Preprocessor (PHP) runtimes. | Backport Builder |
Selection guide
Section titled “Selection guide”| Need | Start here | Operational note |
|---|---|---|
| Framework response helpers | Laravel, Symfony, or CodeIgniter | The framework package owns container and response integration; core owns document authoring. |
| Pixel-oriented HTML rendering | Artisan or Cloudflare | Choose Artisan for host-local Chrome CDP. Choose Cloudflare when rendering belongs at the edge. |
| Office conversion | Gotenberg | Treat Gotenberg as an external service boundary with timeout, size, and server-side request forgery (SSRF) controls. |
| Legacy TCPDF migration | TCPDF compatibility | Check the method coverage table before you assume a legacy call is supported. |
| Older PHP distribution | Backport Builder | Build tooling only; do not install it as an application runtime dependency. |
Manual shape
Section titled “Manual shape”Each extension section contains these page types:
| Page | Purpose |
|---|---|
overview | Product boundary, target audience, supported workflows, and limitations. |
install | Installation commands and required runtime dependencies. |
quickstart | Minimal working flow with a copyable first result. |
configuration | Supported config keys, environment variables, defaults, and effects. |
api | Public classes, methods, parameters, defaults, return values, and exceptions. |
developer-guide | Extension architecture, lifecycle, extension points, and code organization. |
production-usage | Deployment, reliability, performance, worker safety, and observability. |
security-and-operations | Trust boundaries, safe defaults, secrets, file access, and operational controls. |
troubleshooting | Symptoms, diagnostics, likely causes, and corrective actions. |
API table convention
Section titled “API table convention”API tables use the same columns across the manual, so you can compare packages without learning a new layout.
| Column | Meaning |
|---|---|
| Symbol | Fully qualified class, method, endpoint, command-line interface (CLI) command, or config object. |
| Parameters | Name, type, required status, default, and accepted values. |
| Default behavior | What happens when you omit optional input. |
| Returns | Return type or output artifact. |
| Throws or fails with | Exception type, HTTP status, validation failure, or operational failure mode. |
| Notes | Security, worker-safety, compatibility, or performance detail. |
Translation readiness
Section titled “Translation readiness”The English source is written for later localization: short sections, stable headings, explicit nouns, no idioms, and tables for repeated structures. Keep method names, config keys, CLI flags, and exception names in code formatting on new API pages so translation tools preserve them.