Usar esta página cuando se conoce el tipo de integración, pero no la página específica del paquete. Cada fila enlaza con la referencia de API canónica de esa sección de la extensión.
Las páginas de API están respaldadas por el código fuente y usan el mismo formato de tabla: símbolo, parámetros, comportamiento predeterminado, valor de retorno, modo de fallo y notas operativas.
| Superficie | Paquete | Símbolos principales | Página de API |
|---|
| Facade y enlaces del contenedor de Laravel | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | API de Laravel |
| Respuestas HTTP de Laravel | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, helpers de respuesta en stream | API de Laravel |
| Trabajos en cola de Laravel | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | API de Laravel |
| Factory y bundle de Symfony | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | API de Symfony |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | API de Symfony |
| CodeIgniter service/library | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | API de CodeIgniter |
| Trabajo en cola de CodeIgniter | nextpdf/codeigniter | GeneratePdfJob::process, callable del builder estático | API de CodeIgniter |
| Superficie | Paquete | Símbolos principales | Página de API |
|---|
| Renderizado con Chrome local en el host | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | API de Artisan |
| Importación de PDF con Chrome | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | API de Artisan |
| Diagnóstico del parser de bajo nivel | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | API de Artisan |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | API de Cloudflare |
| Protección de API de Cloudflare | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | API de Cloudflare |
| Archivado en Cloudflare R2 | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | API de Cloudflare |
| Conversión de documentos de Office con Gotenberg | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | API de Gotenberg |
| Política de formato y transporte de Gotenberg | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | API de Gotenberg |
| Superficie | Paquete | Símbolos principales | Página de API |
|---|
| Adaptador de TCPDF | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | API de compatibilidad con TCPDF |
| Familias de métodos de TCPDF | nextpdf/compat-legacy | Áreas de texto, fuente, página, imagen, dibujo, seguridad, formulario y salida | Cobertura de métodos de TCPDF |
| Scripts de compilación de backport | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | API de Backport Builder |
| Reglas de Rector de backport | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | API de Backport Builder |
| Tarea | Empezar por | Leer después |
|---|
| Devolver un PDF desde un controlador del framework | PdfResponse en el paquete de framework correspondiente. | El quickstart del paquete y, después, su tabla de respuestas api. |
| Generar un PDF en un worker en segundo plano | Laravel GeneratePdfJob, Symfony GeneratePdfMessage o CodeIgniter GeneratePdfJob. | El patrón de cola o de Messenger del developer-guide del paquete. |
| Renderizar HTML con Chrome local en el host | ChromeHtmlRenderer::render(). | Las páginas de configuración, seguridad y uso en producción de Artisan. |
| Renderizar HTML mediante Cloudflare | CloudflareHtmlRenderer::render(). | Las páginas de protección de API y de operaciones del Worker de Cloudflare. |
| Convertir documentos de Office | GotenbergBridge::convertFile() o convertString(). | Las páginas de configuración y resolución de problemas de Gotenberg. |
| Archivar los PDF generados en un almacenamiento de objetos | R2ArchiveManager::upload() y generateSignedUrl(). | Las páginas de uso en producción y seguridad de Cloudflare. |
| Migrar una base de código de TCPDF | TCPDF, cobertura de métodos y OutputBridge. | La guía de migración de compatibilidad con TCPDF. |
| Compilar paquetes para runtimes anteriores | scripts/build.php y Build::run(). | La guía para desarrolladores y el uso en producción de backport. |
| Tarea | Área de configuración | Página del paquete |
|---|
| Definir los valores predeterminados de los metadatos del documento | defaults.* | La configuración de Laravel, Symfony o CodeIgniter. |
| Precalentar las fuentes de producción | preload_fonts o preloadFonts | Las páginas de configuración del framework. |
| Configurar el binario de Chrome y el tiempo de espera | artisan.* o ChromeRendererConfig | Las páginas de configuración de Artisan y del framework. |
| Configurar la firma y el TSA | signature.*, tsa.*, ocsp_cache.* | Las páginas de configuración del framework. |
| Proteger los endpoints de renderizado públicos | ApiProtectionConfig | Las páginas de API y seguridad de Cloudflare. |
| Configurar el archivado en R2 | R2ArchiveConfig | Las páginas de configuración y API de Cloudflare. |
| Configurar el servicio de Gotenberg | GotenbergConfig | Las páginas de configuración y API de Gotenberg. |
| Ajustar el comportamiento de compatibilidad | AdaptationConfig | La página de configuración de compatibilidad con TCPDF. |
| Síntoma | Límite probable de API | Primera página de diagnóstico |
|---|
| La respuesta se descarga con el nombre de archivo incorrecto | El helper PdfResponse del framework. | La página de API del framework correspondiente. |
| El trabajo en cola falla antes de renderizar | Validación del trabajo o del mensaje. | La página de resolución de problemas del framework correspondiente. |
| El renderizado de Chrome supera el tiempo de espera | ChromeHtmlRenderer o BrowserPool. | La página de resolución de problemas de Artisan. |
| El worker devuelve datos que no son PDF | CloudflareResponseParser. | La página de resolución de problemas de Cloudflare. |
| La subida a R2 se completa con éxito, pero la URL no es utilizable | R2UploadResult o la generación de la URL firmada. | La página de uso en producción de Cloudflare. |
| El archivo de Office se rechaza | OfficeFormat o GotenbergSecurityPolicy. | La página de resolución de problemas de Gotenberg. |
| Un método heredado de TCPDF lanza una excepción | Área de compatibilidad o factory de excepciones. | La página de cobertura de métodos de TCPDF. |
| La salida de backport no pasa la comprobación de sintaxis | Configuración de Rector o regla personalizada. | La guía para desarrolladores de backport. |
Se espera que cada página de API del paquete documente:
| Detalle requerido | Motivo |
|---|
| Símbolo completamente cualificado | Permite a los lectores buscar en el código fuente y en las pruebas sin adivinar los namespaces. |
| Nombres de parámetros y valores predeterminados | Evita la ambigüedad en el punto de llamada y permite ejemplos tipados. |
| Comportamiento predeterminado | Permite omitir la entrada opcional de forma deliberada y segura. |
| Valor de retorno o efecto secundario | Muestra si el método es fluido, terminal o de diagnóstico. |
| Modo de fallo | Ayuda a que el código de producción falle en modo cerrado y registre el límite correcto. |
| Nota operativa | Recoge aspectos de seguridad operativa del worker, seguridad, memoria, tiempo de espera o compatibilidad. |
