Integrações
Visão geral
Seção intitulada “Visão geral”As extensões do NextPDF conectam o mecanismo central de Portable Document Format (PDF) a frameworks de aplicação, renderizadores de navegador, serviços de borda, ferramentas de build e migrações legadas. Cada seção de extensão segue a mesma estrutura do manual: visão geral, instalação, início rápido, configuração, application programming interface (API), guia do desenvolvedor, uso em produção, segurança e solução de problemas.
Mapa de extensões
Seção intitulada “Mapa de extensões”| Extensão | Pacote | Use quando | Seção principal |
|---|---|---|---|
| Laravel | nextpdf/laravel | Use quando você desenvolve aplicações Laravel e precisa de bindings de container, uma facade, respostas e jobs de fila. | Laravel |
| Symfony | nextpdf/symfony | Use quando você desenvolve aplicações Symfony e precisa de um bundle, ligação de dependency injection, jobs do Messenger e respostas de Hypertext Transfer Protocol (HTTP). | Symfony |
| CodeIgniter | nextpdf/codeigniter | Use quando você desenvolve aplicações CodeIgniter 4 e precisa de services, um wrapper de biblioteca, respostas e jobs de fila. | CodeIgniter |
| Artisan | nextpdf/artisan | Use quando você precisa renderizar Hypertext Markup Language (HTML) via Chrome DevTools Protocol (CDP), importar páginas ou usar utilitários de inspeção de PDF de baixo nível. | Artisan |
| Cloudflare | nextpdf/cloudflare | Use quando você renderiza via Cloudflare Browser Rendering, protege o acesso à API ou arquiva PDFs no R2. | Cloudflare |
| Gotenberg | nextpdf/gotenberg | Use quando você converte documentos de escritório ou HTML por meio de um serviço Gotenberg. | Gotenberg |
| Compatibilidade com TCPDF | nextpdf/compat-legacy | Use quando você migra código de aplicação baseado em TCPDF para o NextPDF sem uma reescrita completa. | Compatibilidade com TCPDF |
| Backport Builder | nextpdf/backport-builder | Use quando você mantém artefatos de release para runtimes mais antigos de PHP: Hypertext Preprocessor (PHP). | Backport Builder |
Guia de seleção
Seção intitulada “Guia de seleção”| Necessidade | Comece aqui | Nota operacional |
|---|---|---|
| Helpers de resposta de framework | Laravel, Symfony ou CodeIgniter | O pacote de framework cuida da integração de container e das respostas; o core cuida da criação de documentos. |
| Renderização de HTML orientada a pixels | Artisan ou Cloudflare | Escolha o Artisan para CDP do Chrome local no host. Escolha o Cloudflare quando a renderização precisar ficar na borda. |
| Conversão de documentos de escritório | Gotenberg | Trate o Gotenberg como um limite de serviço externo, com controles de timeout, tamanho e server-side request forgery (SSRF). |
| Migração de TCPDF legado | Compatibilidade com TCPDF | Consulte a tabela de cobertura de métodos antes de supor que uma chamada legada tem suporte. |
| Distribuição de PHP mais antiga | Backport Builder | É apenas uma ferramenta de build; não a instale como dependência de runtime da aplicação. |
Estrutura do manual
Seção intitulada “Estrutura do manual”Cada seção de extensão contém estes tipos de página:
| Página | Finalidade |
|---|---|
overview | Escopo do produto, público-alvo, fluxos de trabalho com suporte e limitações. |
install | Comandos de instalação e dependências de runtime obrigatórias. |
quickstart | Fluxo funcional mínimo com um primeiro resultado que você pode copiar. |
configuration | Chaves de config com suporte, variáveis de ambiente, valores padrão e efeitos. |
api | Classes públicas, métodos, parâmetros, valores padrão, valores de retorno e exceções. |
developer-guide | Arquitetura da extensão, ciclo de vida, pontos de extensão e organização do código. |
production-usage | Deployment, confiabilidade, desempenho, segurança de workers e observabilidade. |
security-and-operations | Limites de confiança, valores padrão seguros, secrets, acesso a arquivos e controles operacionais. |
troubleshooting | Sintomas, diagnósticos, causas prováveis e ações corretivas. |
Convenção das tabelas de API
Seção intitulada “Convenção das tabelas de API”As tabelas de API usam as mesmas colunas em todo o manual, para que você possa comparar pacotes sem aprender um layout novo.
| Coluna | Significado |
|---|---|
| Símbolo | Classe totalmente qualificada, método, endpoint, comando de command-line interface (CLI) ou objeto de config. |
| Parâmetros | Nome, tipo, status de obrigatoriedade, valor padrão e valores aceitos. |
| Comportamento padrão | O que acontece quando você omite uma entrada opcional. |
| Retorna | Tipo de retorno ou artefato de saída. |
| Lança ou falha com | Tipo de exceção, status HTTP, falha de validação ou modo de falha operacional. |
| Notas | Detalhe de segurança, segurança de workers, compatibilidade ou desempenho. |
Preparação para tradução
Seção intitulada “Preparação para tradução”O texto-fonte em inglês é escrito pensando na localização posterior: seções curtas, títulos estáveis, substantivos explícitos, sem expressões idiomáticas e tabelas para estruturas repetidas. Mantenha nomes de métodos, chaves de config, flags de CLI e nomes de exceções em formatação de código nas novas páginas de API, para que as ferramentas de tradução os preservem.