Recetario PHP
Recetario de PHP
Sección titulada «Recetario de PHP»Este es el índice de las recetas nativas de PHP de NextPDF: páginas ejecutables, centradas en tareas y escritas directamente contra la API PHP del core. El repositorio core nextpdf es propietario de cada receta en docs/public/cookbook/php/ y la verifica. Cada una está respaldada por un script examples/*.php y una prueba de arnés tests/Cookbook/Php/. Después, el agregador incorpora cada página a este sitio y conserva su procedencia de origen.
Como esta página es un índice, no formula ninguna afirmación de comportamiento sobre ninguna receta. Cada fila registra la intención de la receta, el módulo core que ejercita y su perfil de reproducibilidad declarado. El perfil y cualquier afirmación de conformidad figuran en la propia página de la receta, tomados del front-matter de esa página y de su prueba en el repositorio, no aquí. Para el recetario de integraciones (framework / renderizador / servicio), consulte Recetario de integraciones. Para el contrato que sigue toda receta ejecutable, consulte Convenciones de recetas.
Cómo se organizan los slugs de las recetas
Sección titulada «Cómo se organizan los slugs de las recetas»Cada receta se redacta en el repositorio core bajo docs/public/cookbook/php/ y el agregador la publica en este sitio. El slug sigue una única convención: un solo segmento.
/cookbook/php/<recipe>/<recipe> identifica la intención de la receta en kebab-case (por ejemplo render-html-to-pdf, no el nombre del módulo html). Va en minúsculas, separado por guiones, sin números de versión y termina en una única barra final.
Perfil de reproducibilidad, en una línea
Sección titulada «Perfil de reproducibilidad, en una línea»Cada receta declara el perfil más estricto que puede satisfacer con rigor:
- bitwise — idéntico byte a byte entre ejecuciones (contenido determinista simple, con toda la entropía fijada).
- structural — idéntico tras normalizar los átomos volátiles (el
/IDdel trailer, las fechas de creation/modification, los prefijos de subconjunto de fuente; en la práctica, cualquier PDF con varios objetos). - semantic — solo equivalencia de AST estructural más metadatos (salida firmada o con marca de tiempo, o salida cuya equivalencia sea inherentemente inestable a nivel de bytes).
El perfil es una propiedad que la página de la receta demuestra con su prueba de arnés. Este índice solo informa el valor que la página declara.
Fundamentos
Sección titulada «Fundamentos»Construir, paginar y aplicar estilos a un documento.
| Receta | Qué hace | Módulo | Perfil |
|---|---|---|---|
render-html-to-pdf | Renderizar un documento HTML a PDF | Html | structural |
style-with-css | Aplicar CSS a un renderizado de HTML | Html | structural |
html-table-layout | Maquetar una tabla HTML | Html | structural |
paginate-long-html | Paginar un documento HTML largo | Html | structural |
paginate-large-html-tables | Paginar una tabla HTML grande a lo largo de varias páginas | Html | structural |
render-rtl-arabic-html | Renderizar HTML árabe de derecha a izquierda | Html | structural |
compose-text-and-fonts | Componer texto con control tipográfico | Tipografía | structural |
embed-and-subset-fonts | Incrustar y subconjuntar fuentes | Fuente | structural |
cjk-vertical-writing | Componer texto CJK en modo de escritura vertical | Tipografía | structural |
multi-page-document | Construir un documento de varias páginas | Documento | structural |
headers-and-footers | Añadir encabezados y pies de página recurrentes | Diseño | structural |
Gráficos y contenido
Sección titulada «Gráficos y contenido»Vectores, imágenes, capas y espacio de coordenadas.
| Receta | Qué hace | Módulo | Perfil |
|---|---|---|---|
draw-vector-graphics | Dibujar gráficos vectoriales | Gráficos | structural |
gradients-and-transparency | Aplicar degradados y transparencia | Gráficos | structural |
embed-images | Incrustar imágenes rasterizadas | Contenido | structural |
add-watermarks-and-backgrounds | Añadir marcas de agua o fondos de texto e imagen a las páginas | Contenido | structural |
cmyk-spot-color-and-icc-profiles | Producir CMYK y tintas planas listos para impresión | Color | structural |
embed-file-attachments | Incrustar archivos y crear portafolios PDF | Contenido | structural |
optional-content-layers | Usar contenido opcional (capas) | Gráficos | structural |
transform-coordinate-space | Transformar el espacio de coordenadas | Gráficos | structural |
Navegación y formularios
Sección titulada «Navegación y formularios»Marcadores, enlaces, anotaciones y campos de AcroForm.
| Receta | Qué hace | Módulo | Perfil |
|---|---|---|---|
bookmarks-and-toc | Construir marcadores y una tabla de contenido | Navegación | structural |
generate-dynamic-table-of-contents | Generar una tabla de contenido dinámica | Navegación | structural |
links-and-annotations | Añadir enlaces y anotaciones | Navegación | structural |
generate-barcodes | Generar códigos de barras | Código de barras | bitwise |
gs1-composite-barcodes | Generar códigos de barras GS1 Composite (portador CC-C) | Código de barras | structural |
fill-pdf-form | Rellenar un AcroForm | Formulario | structural |
flatten-form-fields | Aplanar los campos de formulario | Formulario | structural |
form-field-validation-and-flatten-with-state | Validar los campos de formulario y aplanarlos conservando su estado | Formulario | structural |
Información del documento
Sección titulada «Información del documento»Configurar metadatos y el comportamiento del visor.
| Receta | Qué hace | Módulo | Perfil |
|---|---|---|---|
set-document-metadata | Establecer los metadatos del documento | Metadatos | structural |
set-viewer-preferences | Establecer las preferencias del visor | Documento | structural |
Operaciones con documentos
Sección titulada «Operaciones con documentos»Ensamblar, dividir y optimizar documentos existentes.
| Receta | Qué hace | Módulo | Perfil |
|---|---|---|---|
merge-external-pdfs | Combinar PDF externos o añadir páginas | Documento | structural |
split-and-extract-pages | Dividir un PDF y extraer rangos de páginas | Documento | structural |
optimize-pdf-file-size | Reducir el tamaño del archivo PDF con compresión y subconjuntado | Documento | structural |
Seguridad, firma y conformidad
Sección titulada «Seguridad, firma y conformidad»Cifrado, firma, accesibilidad y salida con perfil. Estas recetas documentan en su propia página los límites soporte≠conformidad y presencia≠validez.
| Receta | Qué hace | Módulo | Perfil |
|---|---|---|---|
encrypt-aes256 | Cifrar con AES-256 y establecer las marcas de permisos | Seguridad | structural |
encrypt-with-permissions | Cifrar con marcas de permisos | Seguridad | structural |
sign-pades-b-b | Aplicar una firma PAdES (B-B y B-T) | Seguridad | semantic |
inspect-existing-signature | Inspeccionar una firma existente | Inspección | semantic |
tagged-pdf-ua2 | Emitir la estructura etiquetada para PDF/UA-2 | Accesibilidad | semantic |
accessible-pdfua2-from-html | Emitir la estructura etiquetada para la generación accesible de PDF/UA-2 a partir de HTML | Accesibilidad | semantic |
pdf-a-4-output | Producir salida PDF/A-4 | Conformidad | semantic |
pdfa4-conformance-gate | Producir salida PDF/A-4 y validarla con un validador externo | Conformidad | semantic |
validate-conformance | Validar frente a un perfil de conformidad | Cumplimiento | semantic |
Inspección y extracción
Sección titulada «Inspección y extracción»Volver a leer el contenido y la estructura de un PDF.
| Receta | Qué hace | Módulo | Perfil |
|---|---|---|---|
extract-text-content | Extraer contenido de texto | Texto | semantic |
multilingual-copy-paste-extraction | Lograr que los PDF en CJK y árabe se copien y peguen correctamente | Texto | structural |
parse-and-inspect-pdf | Analizar e inspeccionar un PDF | Inspección | semantic |
inspect-layout-boxes | Inspeccionar las cajas de diseño | Inspección | semantic |
Transversal
Sección titulada «Transversal»Patrones que abarcan varios módulos.
| Receta | Qué hace | Abarca | Perfil |
|---|---|---|---|
worker-safe-batch-rendering | Renderizar de forma segura en un worker de larga duración (registros compartidos, memoria acotada) | Core · Rendimiento · Soporte | semantic |
streaming-and-memory | Perfilar el uso de streaming y de memoria | Rendimiento | bitwise |
exception-aware-error-handling | Gestionar errores con la jerarquía de excepciones de NextPDF | Excepción · Contratos | structural |
custom-error-recovery-patterns | Implementar estrategias personalizadas de recuperación de errores y reintento | Excepción | semantic |
observe-with-opentelemetry | Observar el renderizado con OpenTelemetry | Observabilidad · Telemetría · Evento | semantic |
Cada receta anterior se publica con un script examples/*.php de respaldo y una prueba de arnés tests/Cookbook/Php/ en el repositorio core. Cuando se redacta una nueva receta en upstream, aparece aquí en cuanto se incorporan su ejemplo y su prueba.
Véase también
Sección titulada «Véase también»- Recetario de integraciones — el índice de integración de frameworks, renderizadores y servicios.
- Convenciones de recetas — el contrato que sigue toda receta ejecutable de este recetario.