Use esta página quando você já conhece o tipo de integração, mas precisa da referência específica do pacote para trabalhar com o Portable Document Format (PDF). Cada linha aponta para a página oficial da API daquela área de extensão.
As páginas de API são baseadas no código-fonte e usam um formato de tabela compartilhado: símbolo, parâmetros, comportamento padrão, valor de retorno, modo de falha e notas operacionais.
| Superfície | Pacote | Símbolos principais | Página de API |
|---|
| Facade do Laravel e bindings do container | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | API do Laravel |
| Respostas em Hypertext Transfer Protocol (HTTP) no Laravel | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, helpers para respostas em stream | API do Laravel |
| Jobs de fila do Laravel | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | API do Laravel |
| Factory e bundle do Symfony | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | API do Symfony |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | API do Symfony |
| Service e library do CodeIgniter | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | API do CodeIgniter |
| Job de fila do CodeIgniter | nextpdf/codeigniter | GeneratePdfJob::process, callable de builder estático | API do CodeIgniter |
| Superfície | Pacote | Símbolos principais | Página de API |
|---|
| Renderização com Chrome no host | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | API do Artisan |
| Importação de PDF com Chrome | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | API do Artisan |
| Diagnósticos de parser de baixo nível | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | API do Artisan |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | API da Cloudflare |
| Proteção de API da Cloudflare | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | API da Cloudflare |
| Arquivamento no Cloudflare R2 | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | API da Cloudflare |
| Conversão de documentos de escritório com o Gotenberg | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | API do Gotenberg |
| Política de formato e transporte do Gotenberg | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | API do Gotenberg |
| Superfície | Pacote | Símbolos principais | Página de API |
|---|
| Adaptador do TCPDF | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | API de compatibilidade com o TCPDF |
| Famílias de métodos do TCPDF | nextpdf/compat-legacy | Aspectos de texto, fonte, página, imagem, desenho, segurança, formulário e saída | Cobertura de métodos do TCPDF |
| Scripts de build do Backport | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | API do Backport Builder |
| Regras do Rector do Backport | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | API do Backport Builder |
| Tarefa | Comece por | Em seguida, leia |
|---|
| Retornar um PDF de um controller de framework | PdfResponse no pacote de framework correspondente. | O quickstart do pacote e, em seguida, a tabela de respostas em api. |
| Gerar arquivos PDF em um worker em segundo plano | Laravel GeneratePdfJob, Symfony GeneratePdfMessage ou CodeIgniter GeneratePdfJob. | O padrão de fila ou de Messenger do developer-guide do pacote. |
| Renderizar Hypertext Markup Language (HTML) com Chrome no host | ChromeHtmlRenderer::render(). | Páginas de configuração, segurança e uso em produção do Artisan. |
| Renderizar HTML pela Cloudflare | CloudflareHtmlRenderer::render(). | Páginas de proteção de API e operações do Worker da Cloudflare. |
| Converter documentos de escritório | GotenbergBridge::convertFile() ou convertString(). | Páginas de configuração e solução de problemas do Gotenberg. |
| Arquivar PDFs gerados em armazenamento de objetos | R2ArchiveManager::upload() e generateSignedUrl(). | Páginas de uso em produção e segurança da Cloudflare. |
| Migrar uma base de código TCPDF | TCPDF, cobertura de métodos e OutputBridge. | O guia de migração de compatibilidade com o TCPDF. |
| Compilar pacotes para runtimes mais antigos | scripts/build.php e Build::run(). | As páginas do guia do desenvolvedor e de uso em produção do Backport. |
| Tarefa | Área de configuração | Página do pacote |
|---|
| Definir padrões de metadados do documento | defaults.* | Configuração do Laravel, Symfony ou CodeIgniter. |
| Pré-carregar fontes de produção | preload_fonts ou preloadFonts | Páginas de configuração do framework. |
| Configurar o binário do Chrome e o timeout | artisan.* ou ChromeRendererConfig | Páginas de configuração do Artisan e do framework. |
| Configurar assinatura e Time-Stamping Authority (TSA) | signature.*, tsa.*, ocsp_cache.* | Páginas de configuração do framework. |
| Proteger endpoints públicos de renderização | ApiProtectionConfig | Páginas de API e segurança da Cloudflare. |
| Configurar o arquivamento R2 | R2ArchiveConfig | Páginas de configuração e API da Cloudflare. |
| Configurar o serviço Gotenberg | GotenbergConfig | Páginas de configuração e API do Gotenberg. |
| Ajustar o comportamento de compatibilidade | AdaptationConfig | Página de configuração de compatibilidade com o TCPDF. |
| Sintoma | Provável fronteira de API | Primeira página de diagnóstico |
|---|
| A resposta é baixada com o nome de arquivo incorreto | Helper do framework para PdfResponse. | Página de API do framework correspondente. |
| O job de fila falha antes da renderização | Validação de job/mensagem. | Página de solução de problemas do framework correspondente. |
| A renderização do Chrome atinge o timeout | ChromeHtmlRenderer ou BrowserPool. | A página de solução de problemas do Artisan. |
| O Worker retorna dados que não são saída em PDF | CloudflareResponseParser. | A página de solução de problemas da Cloudflare. |
| O upload para o R2 é concluído com sucesso, mas o Uniform Resource Locator (URL) não é utilizável | R2UploadResult ou geração de URL assinada. | A página de uso em produção da Cloudflare. |
| O arquivo de escritório é rejeitado | OfficeFormat ou GotenbergSecurityPolicy. | A página de solução de problemas do Gotenberg. |
| Um método legado do TCPDF lança exceção | Aspecto de compatibilidade ou factory de exceções. | A página de cobertura de métodos do TCPDF. |
| A saída do Backport falha na verificação de sintaxe | Configuração do Rector ou regra personalizada. | O guia do desenvolvedor do Backport. |
Cada página de API de pacote deve documentar:
| Detalhe obrigatório | Motivo |
|---|
| Símbolo totalmente qualificado | Ajuda você a pesquisar o código-fonte e os testes sem adivinhar namespaces. |
| Nomes de parâmetros e valores padrão | Evita ambiguidade no local de chamada e dá suporte a exemplos tipados. |
| Comportamento padrão | Torna seguro omitir deliberadamente entradas opcionais. |
| Valor de retorno ou efeito colateral | Mostra se o método é fluente, terminal ou de diagnóstico. |
| Modo de falha | Ajuda o código de produção a falhar de forma fechada e a registrar a fronteira correta. |
| Nota operacional | Captura aspectos de segurança operacional do worker, segurança, memória, timeout ou compatibilidade. |
