phpcfdi / cfdi-to-json
Convert CFDI to JSON
Installs: 10 283
Dependents: 1
Suggesters: 0
Security: 0
Stars: 29
Watchers: 8
Forks: 8
Open Issues: 0
Requires
- php: >=7.3
- ext-dom: *
- ext-json: *
Requires (Dev)
- phpunit/phpunit: ^9.5
README
Herramienta para convertir archivos CFDI a JSON
Acerca de phpcfdi/cfdi-to-json
Esta es una herramienta que sigue sus propias convenciones para convertir los archivos de CFDI (XML de SAT) a formato JSON.
Algunas de las convenciones que se siguen son:
- Los elementos son objetos que contienen su valor, los atributos y sus elementos hijos.
- Los elementos que pueden aparecer más de una vez, son manejados como arreglos.
- La librería guarda un registro interno de los elementos que pueden aparecer más de una vez.
Instalación
Usa composer
composer require phpcfdi/cfdi-to-json
Uso básico
Convirtiendo de CFDI (string) a JSON (string)
<?php declare(strict_types=1); use PhpCfdi\CfdiToJson\JsonConverter; $contents = file_get_contents('mi-archivo-xfdi.xml'); $json = JsonConverter::convertToJson($contents); echo $json;
Convirtiendo de DOMDocument
a array
<?php declare(strict_types=1); use PhpCfdi\CfdiToJson\Factory; /** @var DOMDocument $document */ $factory = new Factory(); $dataConverter = $factory->createConverter(); $rootNode = $dataConverter->convertXmlDocument($document); $array = $rootNode->toArray(); var_export($array);
Ejemplo de salida
Note que:
Emisor
parece una propiedad más del objeto principal, pero el contenido es un objeto y no una cadena de caracteres.Concepto
contiene un arreglo de objetos, cada uno es una representación de un nodo concepto.Traslado
contiene un arreglo a pesar de que solo contenga un objeto, se conoce que es múltiple.Complemento
es un arreglo a pesar de lo definido en el Anexo 20 porque el XSD dice que puede tener múltiples apariciones.
{ "Certificado": "MIIGH...imAyX", "CondicionesDePago": "CONTADO", "Fecha": "2018-01-12T08:15:01", "Folio": "11541", "FormaPago": "04", "LugarExpedicion": "76802", "MetodoPago": "PUE", "Moneda": "MXN", "NoCertificado": "00001000000401220451", "Sello": "Xt7tK...gdg==", "Serie": "H", "SubTotal": "1709.12", "TipoDeComprobante": "I", "Total": "2010.01", "Version": "3.3", "xsi:schemaLocation": "http://www.sat.gob.mx/cfd/3 http://www.sat.gob.mx/sitio_internet/cfd/3/cfdv33.xsd http://www.sat.gob.mx/implocal http://www.sat.gob.mx/sitio_internet/cfd/implocal/implocal.xsd", "Emisor": { "Nombre": "PROMOTORA OTIR SA DE CV", "RegimenFiscal": "601", "Rfc": "POT9207213D6" }, "Receptor": { "Nombre": "DAY INTERNATIONAL DE MEXICO SA DE CV", "Rfc": "DIM8701081LA", "UsoCFDI": "G03" }, "Conceptos": { "Concepto": [ { "Cantidad": "2.00", "ClaveProdServ": "90111501", "ClaveUnidad": "E48", "Descripcion": "Paquete", "Importe": "1355.67", "Unidad": "UNIDAD DE SERVICIO", "ValorUnitario": "677.83", "Impuestos": { "Traslados": { "Traslado": [ { "Base": "1355.67", "Importe": "216.91", "Impuesto": "002", "TasaOCuota": "0.160000", "TipoFactor": "Tasa" } ] } } }, { "Cantidad": "1.00", "ClaveProdServ": "90101501", "ClaveUnidad": "E48", "Descripcion": "Restaurante", "Importe": "353.45", "Unidad": "UNIDAD DE SERVICIO", "ValorUnitario": "353.45", "Impuestos": { "Traslados": { "Traslado": [ { "Base": "353.45", "Importe": "56.55", "Impuesto": "002", "TasaOCuota": "0.160000", "TipoFactor": "Tasa" } ] } } } ] }, "Impuestos": { "TotalImpuestosTrasladados": "273.46", "Traslados": { "Traslado": [ { "Importe": "273.46", "Impuesto": "002", "TasaOCuota": "0.160000", "TipoFactor": "Tasa" } ] } }, "Complemento": [ { "ImpuestosLocales": { "TotaldeRetenciones": "0.00", "TotaldeTraslados": "27.43", "version": "1.0", "TrasladosLocales": [ { "ImpLocTrasladado": "IH", "Importe": "27.43", "TasadeTraslado": "2.50" } ] }, "TimbreFiscalDigital": { "FechaTimbrado": "2018-01-12T08:17:54", "NoCertificadoSAT": "00001000000406258094", "RfcProvCertif": "DCD090706E42", "SelloCFD": "Xt7tK...gdg==", "SelloSAT": "IRy7w...6Zg==", "UUID": "CEE4BE01-ADFA-4DEB-8421-ADD60F0BEDAC", "Version": "1.1", "xsi:schemaLocation": "http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd" } } ] }
Funcionamiento interno
La conversión parte de un objeto DOMDocument
que es recorrido nodo a nodo y en cada transformación genera
un objeto de tipo Nodes\Node
que contiene sus propiedades básicas de nombre, ruta, valor de texto, atributos e hijos.
Los hijos (Nodes\Children
) son una colección de nodos Nodes\Node
.
Al momento de exportar a un arreglo Nodes\Node::toArray()
es cuando se resuelve si los nodos deben agregarse como
llaves directas a objetos, o bien, como arreglos de objetos.
Elementos con múltiples apariciones
Para detectar los elementos con múltiples apariciones esta librería contiene un archivo src/UnboundedOccursPaths.json
con el listado de rutas de elementos que pueden aparecer más de una vez.
Este listado se puede generar utilizando el archivo bin/max-occurs-paths.php
, que descargará el registro de espacios
de nombres del SAT de PhpCfdi phpcfdi/sat-ns-registry
así como todos
los archivos XSD para interpretar las rutas que contienen maxOccurs="unbounded"
.
Desde 2021-03-22 se ha agregado un evento desde phpcfdi/sat-ns-registry
para que notifique a este mismo repositorio
que el registro de espacios de nombres cambió.
Nodos con texto
El texto o valor que contenga algún nodo XML es exportado a una llave de cadena vacía en el JSON resultante. Por ejemplo, el siguiente XML:
<detallista:orderIdentification> <detallista:referenceIdentification type="ON">3</detallista:referenceIdentification> </detallista:orderIdentification>
Genera el siguiente JSON:
{ "orderIdentification": { "referenceIdentification": { "": "3", "type": "ON" } } }
Soporte
Puedes obtener soporte abriendo un ticket en Github.
Adicionalmente, esta librería pertenece a la comunidad PhpCfdi, así que puedes usar los mismos canales de comunicación para obtener ayuda de algún miembro de la comunidad.
Compatibilidad
Esta librería se mantendrá compatible con al menos la versión con soporte activo de PHP más reciente.
También utilizamos Versionado Semántico 2.0.0 por lo que puedes usar esta librería sin temor a romper tu aplicación.
Contribuciones
Las contribuciones con bienvenidas. Por favor, revisa CONTRIBUTING para más detalles y recuerda revisar el archivo de tareas pendientes TODO y el archivo CHANGELOG.
Copyright and License
The phpcfdi/cfdi-to-json
library is copyright © PhpCfdi
and licensed for use under the MIT License (MIT). Please see LICENSE for more information.