Download the PHP package puyu-pe/nexus-doc-gen without Composer

PUYU.PE QILLQAY

Libreria para generar representación de CPE

LIBRERIA EN PRUEBAS

Libreria para generar documentos en formatos A4 y ticket en PDF y HTML:

Documentos electrónicos:

• Facturas
• Boletas
• Notas de Crédito
• Guias de remisión (solo a4)

Documentos personalizados (desde el mismo formato de objeto y/o html):

• Requiere datos adicionales (ver generación de objeto)

Utilización

Requerimientos

• PHP 7.4
• Binario wkhtmltopdf 0.12.6 (mínimo) https://wkhtmltopdf.org/

Instalación

• Ejecutar el comando:

Utilización

• Incluir la libreria

• Generar el objeto $data, el cual es el objeto $invoice que se usa para enviar a nexus (https://github.com/puyu-pe/nexus/blob/develop/docs/api.md)

• Se puede usar el comando json_encode en caso de tener el json en una variable de tipo string

• Caso contrario generar el objeto:

• Adicionar un campo params al objeto, debe contener la siguiente estructura:

• Se requieren los siguientes parámetros al momento de llamar a una de las funciones:

• Llamar a la función fromObject usando el siguiente codigo:

• Llamar a la función fromHtml (debe incluir el css):
• fromHtml($html, $format = 'pdf', $size = 'a4', $height = 210, $wkhtmlPath = 'wkhtmltopdf', $env = 'run')

Se genera un stream del archivo, asi que no es necesario agregar return o asignarlo a una variable

Documentos personalizados (tipoDoc = 00)

Los documentos “custom” se procesan cuando el tipo de documento es 00. La plantilla Twig evalúa esta condición con:

Datos adicionales requeridos para tipoDoc = 00

Además del objeto estándar, se requiere:

• doc.tipoDocNombre (string): nombre visible del documento custom.

• doc.detailsHeader (array de objetos): define el encabezado y mapea columnas de details. Campos soportados por columna:

  • field (string, requerido): clave presente en cada item de details.
  • title (string, recomendado): etiqueta a mostrar en el encabezado.
  • type (string, opcional): uno de text (default), number, currency, boolean, date.
  • decimals (int, opcional): número de decimales para number/currency (por defecto: number=0, currency=2).
  • format (string, opcional): formato para date (por defecto: d/m/Y).
  • align (string, opcional): left|center|right. Si se omite, se infiere por type (number/currency=right, boolean=center, demás left).
  • null_as (string, opcional): placeholder si el valor es null o vacío.
• doc.details (array de objetos): filas del detalle. Cada objeto debe incluir los campos listados en detailsHeader[*].field.
• doc.detailsSummary (array de objetos, opcional): totales/resumen. Para ticket, incluya colspan.

Ejemplo mínimo de configuración

Vista previa