Livro de receitas em PHP
Este índice lista as receitas PHP nativas do NextPDF: páginas executáveis e focadas em tarefas, escritas diretamente sobre a API PHP do core. O repositório core nextpdf é responsável por cada receita e a verifica em docs/public/cookbook/php/. Cada receita tem um script examples/*.php e um teste de harness em tests/Cookbook/Php/. Em seguida, o agregador traz cada página para este site e preserva a procedência de origem.
Como esta página é um índice, ela não afirma como nenhuma receita se comporta. Cada linha registra a intenção da receita, o módulo do core usado por ela e o perfil de reprodutibilidade declarado. O perfil e qualquer afirmação de conformidade pertencem à própria página da receita. Esses dados vêm do front-matter daquela página e do teste no repositório, não deste índice. Para o livro de receitas de integração (framework / renderizador / serviço), consulte Livro de receitas de integração. Para o contrato seguido por toda receita executável, consulte Convenções de receita.
Como os slugs de receita são organizados
Seção intitulada “Como os slugs de receita são organizados”Cada receita é escrita no repositório core, em docs/public/cookbook/php/, e publicada neste site pelo agregador. Cada slug segue uma convenção: um único segmento.
/cookbook/php/<recipe>/<recipe> nomeia a intenção da receita em kebab-case (por exemplo render-html-to-pdf, não o nome do módulo html). Ele fica em minúsculas, separado por hifens, não tem números de versão e termina com uma única barra final.
Perfil de reprodutibilidade, em uma linha
Seção intitulada “Perfil de reprodutibilidade, em uma linha”Cada receita declara o perfil mais rigoroso que consegue satisfazer honestamente:
- bitwise — idêntico byte a byte entre execuções (conteúdo determinístico simples, com toda a entropia fixada).
- structural — idêntico após normalizar átomos voláteis (o
/IDdo trailer, datas de criação/modificação, prefixos de subconjunto de fonte — na prática, todo PDF com múltiplos objetos). - semantic — apenas equivalência de AST estrutural mais metadados (saída assinada ou com carimbo de tempo, ou saída cuja equivalência inerentemente não é estável byte a byte).
A página da receita comprova o perfil com o teste de harness. Este índice apenas informa o valor que aquela página declara.
Fundamentos
Seção intitulada “Fundamentos”Construa, pagine e estilize um documento.
| Receita | O que ela faz | Módulo | Perfil |
|---|---|---|---|
render-html-to-pdf | Renderiza um documento HTML para PDF | Html | structural |
style-with-css | Aplica CSS a uma renderização HTML | Html | structural |
html-table-layout | Define o layout de uma tabela HTML | Html | structural |
paginate-long-html | Pagina um documento HTML longo | Html | structural |
paginate-large-html-tables | Pagina uma tabela HTML grande ao longo das páginas | Html | structural |
render-rtl-arabic-html | Renderiza HTML árabe da direita para a esquerda | Html | structural |
compose-text-and-fonts | Compõe texto com controle tipográfico | Typography | structural |
embed-and-subset-fonts | Incorpora fontes e gera subconjuntos | Font | structural |
cjk-vertical-writing | Dispõe texto CJK no modo de escrita vertical | Typography | structural |
multi-page-document | Constrói um documento com várias páginas | Document | structural |
headers-and-footers | Adiciona cabeçalhos e rodapés correntes | Layout | structural |
Gráficos e conteúdo
Seção intitulada “Gráficos e conteúdo”Trabalhe com vetores, imagens, camadas e espaço de coordenadas.
| Receita | O que ela faz | Módulo | Perfil |
|---|---|---|---|
draw-vector-graphics | Desenha gráficos vetoriais | Graphics | structural |
gradients-and-transparency | Aplica gradientes e transparência | Graphics | structural |
embed-images | Incorpora imagens raster | Content | structural |
add-watermarks-and-backgrounds | Adiciona marcas d’água de texto e imagem ou planos de fundo às páginas | Content | structural |
cmyk-spot-color-and-icc-profiles | Produz CMYK e cores especiais prontos para impressão | Color | structural |
embed-file-attachments | Incorpora arquivos e cria portfólios de PDF | Content | structural |
optional-content-layers | Usa conteúdo opcional (camadas) | Graphics | structural |
transform-coordinate-space | Transforma o espaço de coordenadas | Graphics | structural |
Navegação e formulários
Seção intitulada “Navegação e formulários”Adicione marcadores, links, anotações e campos de AcroForm.
| Receita | O que ela faz | Módulo | Perfil |
|---|---|---|---|
bookmarks-and-toc | Constrói marcadores e um sumário | Navigation | structural |
generate-dynamic-table-of-contents | Gera um sumário dinâmico | Navigation | structural |
links-and-annotations | Adiciona links e anotações | Navigation | structural |
generate-barcodes | Gera códigos de barras | Barcode | bitwise |
gs1-composite-barcodes | Gera códigos de barras GS1 Composite (portador CC-C) | Barcode | structural |
fill-pdf-form | Preenche um AcroForm | Form | structural |
flatten-form-fields | Achata os campos de formulário | Form | structural |
form-field-validation-and-flatten-with-state | Valida os campos de formulário e os achata mantendo o estado | Form | structural |
Informações do documento
Seção intitulada “Informações do documento”Defina metadados e o comportamento do visualizador.
| Receita | O que ela faz | Módulo | Perfil |
|---|---|---|---|
set-document-metadata | Define os metadados do documento | Metadata | structural |
set-viewer-preferences | Define as preferências do visualizador | Document | structural |
Operações de documento
Seção intitulada “Operações de documento”Monte, divida e otimize documentos existentes.
| Receita | O que ela faz | Módulo | Perfil |
|---|---|---|---|
merge-external-pdfs | Mescla PDFs externos ou anexa páginas | Document | structural |
split-and-extract-pages | Divide um PDF e extrai intervalos de páginas | Document | structural |
optimize-pdf-file-size | Reduz o tamanho do arquivo PDF com compressão e geração de subconjuntos | Document | structural |
Segurança, assinatura e conformidade
Seção intitulada “Segurança, assinatura e conformidade”Use criptografia, assinatura, acessibilidade e saída aderente a perfil. Estas receitas mantêm, na página da receita, os limites entre suporte≠conformidade e presença≠validade.
| Receita | O que ela faz | Módulo | Perfil |
|---|---|---|---|
encrypt-aes256 | Criptografa com AES-256 e define as flags de permissão | Security | structural |
encrypt-with-permissions | Criptografa com flags de permissão | Security | structural |
sign-pades-b-b | Aplica uma assinatura PAdES (B-B e B-T) | Security | semantic |
inspect-existing-signature | Inspeciona uma assinatura existente | Inspect | semantic |
tagged-pdf-ua2 | Emite estrutura marcada para PDF/UA-2 | Accessibility | semantic |
accessible-pdfua2-from-html | Emite a estrutura marcada para criar PDF/UA-2 acessível a partir de HTML | Accessibility | semantic |
pdf-a-4-output | Produz saída PDF/A-4 | Conformance | semantic |
pdfa4-conformance-gate | Produz saída PDF/A-4 e impõe uma trava de validação com um validador externo | Conformance | semantic |
validate-conformance | Valida em relação a um perfil de conformidade | Compliance | semantic |
Inspeção e extração
Seção intitulada “Inspeção e extração”Leia de volta o conteúdo e a estrutura a partir de um PDF.
| Receita | O que ela faz | Módulo | Perfil |
|---|---|---|---|
extract-text-content | Extrai conteúdo de texto | Text | semantic |
multilingual-copy-paste-extraction | Torna PDFs em CJK e árabe corretos para copiar e colar | Text | structural |
parse-and-inspect-pdf | Analisa e inspeciona um PDF | Inspect | semantic |
inspect-layout-boxes | Inspeciona caixas de layout | Inspect | semantic |
Transversais
Seção intitulada “Transversais”Use padrões que abrangem vários módulos.
| Receita | O que ela faz | Abrange | Perfil |
|---|---|---|---|
worker-safe-batch-rendering | Renderiza com segurança em um worker de longa duração (registros compartilhados, memória limitada) | Core · Performance · Support | semantic |
streaming-and-memory | Traça o perfil de streaming e uso de memória | Performance | bitwise |
exception-aware-error-handling | Trata erros com a hierarquia de exceções do NextPDF | Exception · Contracts | structural |
custom-error-recovery-patterns | Implementa estratégias personalizadas de recuperação de erros e de novas tentativas | Exception | semantic |
observe-with-opentelemetry | Observa a renderização com OpenTelemetry | Observability · Telemetry · Event | semantic |
Toda receita acima é publicada com um script examples/*.php de suporte e um teste de harness em tests/Cookbook/Php/ no repositório core. Quando uma nova receita é escrita no upstream, ela aparece aqui assim que seu exemplo e seu teste chegam.
Veja também
Seção intitulada “Veja também”- Livro de receitas de integração — o índice de integração por framework, renderizador e serviço.
- Convenções de receita — o contrato seguido por toda receita executável deste livro de receitas.