ZzAntares / cfdi-wrapper

src/Cfdi.php

<?php

/**
 * This file is part of the CFDI Wrapper library.
 *
 * @copyright 2015 César Antáres <zzantares@gmail.com>
 * @license http://opensource.org/licenses/MIT The MIT License.
 */

namespace ZzAntares\CfdiWrapper;

use ZzAntares\CfdiWrapper\Exceptions\UndefinedAttributeException;
use ZzAntares\CfdiWrapper\Exceptions\MalformedCfdiException;

class Cfdi
{
    /**
     * Holds the instance used by all the methods to acces to the properties of
     * the CFDI XSD.
     *
     * @var \SimpleXMLElement
     */
    private $cfdi;

    /**
     * Contains a map between CFDI XSD paths and an easier to read dotted
     * representation of the paths.
     *
     * @var array
     */
    private $paths = [
        'cfdi' => '//cfdi:Comprobante',
        'cfdi.issuing' => '//cfdi:Comprobante//cfdi:Emisor',
        'cfdi.issuing.address' => '//cfdi:Comprobante//cfdi:Emisor//cfdi:DomicilioFiscal',
        'cfdi.issuing.issued_at' => '//cfdi:Comprobante//cfdi:Emisor//cfdi:ExpedidoEn',
        'cfdi.issuing.regimen' => '//cfdi:Comprobante//cfdi:Emisor//cfdi:RegimenFiscal',
        'cfdi.receiver' => '//cfdi:Comprobante//cfdi:Receptor',
        'cfdi.receiver.address' => '//cfdi:Comprobante//cfdi:Receptor//cfdi:Domicilio',
        'cfdi.items' => '//cfdi:Comprobante//cfdi:Conceptos//cfdi:Concepto',
        'cfdi.taxes' => '//cfdi:Comprobante//cfdi:Impuestos',
        'cfdi.taxes.holdbacks' => '//cfdi:Comprobante//cfdi:Impuestos//cfdi:Retenciones//cfdi:Retencion',
        'cfdi.taxes.transfers' => '//cfdi:Comprobante//cfdi:Impuestos//cfdi:Traslados//cfdi:Traslado',
        'cfdi.addon.taxes' => '//cfdi:Comprobante//cfdi:Complemento//implocal:ImpuestosLocales',
        // @codingStandardsIgnoreLine
        'cfdi.addon.taxes.holdbacks' => '//cfdi:Comprobante//cfdi:Complemento//implocal:ImpuestosLocales//implocal:RetencionesLocales',
    ];

    /**
     * Contains the allowed attributes on the CFDI Wrapper instance.
     *
     * @var array
     */
    private $allowedAttributes = [
        'version',
        'serie',
        'folio',
        'fecha',
        'subTotal',
        'subtotal',  // Alias of subTotal
        'total',
        'certificado' ,
        'noCertificado',
        'condicionesDePago',
        'descuento',
        'motivoDescuento',
        'TipoCambio',
        'tipoCambio',  // Alias of TipoCambio
        'Moneda',
        'moneda',  // Alias of Moneda
        'metodoDePago',
        'sello' ,
        'tipoDeComprobante',
        'formaDePago',
        'LugarExpedicion',
        'lugarExpedicion',  // Alias of LugarExpedcion
        'NumCtaPago',
        'numCtaPago',  // Alias of numCtaPago
        'cadenaOriginal',  // Dinamically generated
        'leyenda',  // Dinamically generated
        'iva',  // Dinamically generated
    ];

    /**
     * List the nested objects vailable on the CFDI Wrapper instance.
     *
     * @var array
     */
    private $nestedObjects = [
        'emisor',
        'receptor',
        'conceptos',
        'impuestos',
        'impuestosLocales',
        'timbre',
        'timbreFiscalDigital',
    ];


    /**
     * Constructor.
     *
     * @return void
     */
    public function __construct($pathOrContent)
    {
        if (file_exists($pathOrContent)) {
            $this->loadFromFile($pathOrContent);
        } else {
            $this->load($pathOrContent);
        }
    }

    /**
     * Allows to change the loaded CFDI by specifying a new string whose content
     * is the new CDFI to set.
     *
     * @param string $xmlContent
     *
     * @return bool 'true' if load was successful, 'false' otherwise.
     */
    public function load($xmlContent)
    {
        $this->xmlContent = $this->sanitizeXML($xmlContent);

The property xmlContent does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $cfdi = simplexml_load_string($this->xmlContent);
        $this->cfdi = $cfdi;

        return $this->isValid(true);

Are you sure the usage of $this->isValid(true) targeting ZzAntares\CfdiWrapper\Cfdi::isValid() seems to always return null.

The expression return $this->isValid(true) returns the type void which is incompatible with the documented return type boolean.

    }

    /**
     * Allows to change the loaded CFDI by specifying the file path.
     *
     * @param string $path
     *
     * @return bool 'true' if load was successful, 'false' otherwise.
     */
    public function loadFromFile($path)
    {
        return $this->load(file_get_contents($path));
    }

    /**
     * Saves the XML representation of the CFDI into a file.
     *
     * @throws RuntimeException If Overwritte can't happen and file exists.
     *
     * @param string $filepath Full path and filename where to save the CFDI.
     * @param bool $overwrite If the given file path exists and this is set to
     *             'true' then file will be overwritten, otherwise an exception
     *             will be thrown.
     *
     * @return return integer Bytes written to file or 'false' if writting

The type ZzAntares\CfdiWrapper\return was not found. Maybe you did not declare it correctly or list all dependencies?

     *                        wasn't possible.
     */
    public function toFile($filepath, $overwrite = false)
    {
        if (file_exists($filepath) and !$overwrite) {
            throw new \RuntimeException($filepath . ' already exists.');
        }

        return file_put_contents($filepath, $this->xmlContent);

The expression return file_put_contents($filepath, $this->xmlContent) returns the type integer which is incompatible with the documented return type ZzAntares\CfdiWrapper\return.

    }


    /**
     * Checks if the given CFDI is valid by searching the needed namespaces.
     *
     * @throws ZzAntares\CfdiWrapper\Exceptions\MalformedCfdiException
     *
     * @param SimpleXMLElement $cfdi

The type ZzAntares\CfdiWrapper\SimpleXMLElement was not found. Did you mean SimpleXMLElement? If so, make sure to prefix the type with \.

     *
     * @return void
     */
    public function isValid($throwException = false)
    {
        $namespaces = array_keys($this->cfdi->getNamespaces(true));

        if (in_array_all(['tfd', 'xsi', 'cfdi', 'implocal'], $namespaces)) {
            return true;

The expression return true returns the type true which is incompatible with the documented return type void.

        }

        if ($throwException) {
            throw new MalformedCfdiException();
        }

        return false;

The expression return false returns the type false which is incompatible with the documented return type void.

    }

    /**
     * Gets the specified attribute.
     *
     * @param string $attribute Property on the CFDI to retrieve.
     *
     * @return void
     */
    private function getAttribute($attribute)
    {
        $comprobante = $this->cfdi->xpath($this->paths['cfdi']);

        switch ($attribute) {
            case 'subtotal':
                $attribute = 'subTotal';
                break;

            case 'tipoCambio':
                $attribute = 'TipoCambio';
                break;

            case 'moneda':
                $attribute = 'Moneda';
                break;

            case 'lugarExpedicion':
                $attribute = 'LugarExpedicion';
                break;

            case 'numCtaPago':
                $attribute = 'NumCtaPago';
                break;

            case 'cadenaOriginal':
                return $this->getCadenaOriginal();

The expression return $this->getCadenaOriginal() returns the type string which is incompatible with the documented return type void.

                break;

            case 'leyenda':
                return 'Este documento es una representación impresa de un CFDI';

The expression return 'Este documento es una representación impresa de un CFDI' returns the type string which is incompatible with the documented return type void.

                break;

            case 'iva':
                return $this->getImpuesto('iva');

The expression return $this->getImpuesto('iva') returns the type object which is incompatible with the documented return type void.

                break;
        }

        return $comprobante[0][$attribute]->__toString();
    }

    /**
     * Retrieves the propper nested object under the CFDI.
     *
     * @return object
     */
    private function getNestedObject($attribute)
    {
        switch ($attribute) {
            case 'emisor':
                return $this->getEmisor();
                break;

            case 'receptor':
                return $this->getReceptor();
                break;

            case 'conceptos':
                return $this->getConceptos();

The expression return $this->getConceptos() returns the type array which is incompatible with the documented return type object.

                break;

            case 'impuestos':
                return $this->getImpuestos();
                break;

            case 'impuestosLocales':
                return $this->getImpuestosLocales();
                break;

            case 'timbre':
            case 'timbreFiscalDigital':
                return $this->getTimbreFiscalDigital();
                break;
        }
    }

    /**
     * Magic method to get attributes on the CFDI.
     *
     * @throws UndefinedAttributeException when attribute is not in the XML.
     *
     * @param string $attribute
     *
     * @return mixed A string or a nested object.
     */
    public function __get($attribute)
    {
        if (in_array($attribute, $this->allowedAttributes)) {
            return $this->getAttribute($attribute);

Are you sure the usage of $this->getAttribute($attribute) targeting ZzAntares\CfdiWrapper\Cfdi::getAttribute() seems to always return null.

        }

        if (in_array($attribute, $this->nestedObjects)) {
            return $this->getNestedObject($attribute);
        }

        throw new UndefinedAttributeException();
    }

    /**
     * Retrieves the string representation of the CFDI.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->sanitizeXML($this->xmlContent);
    }

    /**
     * Removes new lines and spaces from the XML string representation.
     *
     * @param  string $xmlString XML string.
     * @return string
     */
    public function sanitizeXML($xmlString)
    {
        $xmlHeader = '<?xml version="1.0" encoding="UTF-8"?>';

        $data = str_replace($xmlHeader, '', $xmlString);
        $data = str_replace("\n", '', $data);
        $data = str_replace("\r", '', $data);
        $data = preg_replace('~\s*(<([^>]*)>[^<]*</\2>|<[^>]*>)\s*~', '$1', $data);
        $data = preg_replace('/\r\n/', "\n", $data);

        return $xmlHeader . PHP_EOL . $data;
    }

    /**
     * Retrieves the 'cfdi.addon.digital_stamp' path in the CFDI.
     *
     * @return object
     */
    private function getTimbreFiscalDigital()
    {
        // $stamp = $this->cfdi->xpath($this->paths['cfdi.addon.digital_stamp']);

        $ns = $this->cfdi->getNamespaces(true);
        $this->cfdi->registerXPathNamespace('tfd', $ns['tfd']);
        $stamp = $this->cfdi->xpath('//tfd:TimbreFiscalDigital')[0];

        return (object) [
            'version'          => $stamp['version']->__toString(),
            'uuid'             => $stamp['UUID']->__toString(),
            'UUID'             => $stamp['UUID']->__toString(),
            'fecha'            => $stamp['FechaTimbrado']->__toString(),
            'fechaTimbrado'    => $stamp['FechaTimbrado']->__toString(),
            'selloCFD'         => $stamp['selloCFD']->__toString(),
            'cfd'              => $stamp['selloCFD']->__toString(),
            'noCertificadoSAT' => $stamp['noCertificadoSAT']->__toString(),
            'selloSAT'         => $stamp['selloSAT']->__toString(),
            'sat'              => $stamp['selloSAT']->__toString(),
        ];
    }

    /**
     * Retrieves the 'cfdi.addon.taxes' path in the CFDI.
     *
     * @return object
     */
    private function getImpuestosLocales()
    {
        $addon = $this->cfdi->xpath($this->paths['cfdi.addon.taxes'])[0];

        return (object) [
            'version'            => $addon['version'],
            'totalDeRetenciones' => $addon['TotaldeRetenciones'],
            'totaldeRetenciones' => $addon['TotaldeRetenciones'],
            'retenciones'        => $addon['TotaldeRetenciones'],
            'totalDeTraslados'   => $addon['TotaldeTraslados'],
            'totaldeTraslados'   => $addon['TotaldeTraslados'],
            'traslados'          => $addon['TotaldeTraslados'],
            'retencionesLocales' => $this->getRetencionesLocales(),
        ];
    }

    /**
     * Retrieves the 'cfdi.addon.taxes.holdbacks' path in the CFDI.
     *
     * @return object
     */
    private function getRetencionesLocales()
    {
        $holdbacks = $this->cfdi->xpath($this->paths['cfdi.addon.taxes.holdbacks'])[0];

        return (object) [
            'impuesto' => $holdbacks['ImpLocRetenido']->__toString(),
            'importe'  => $holdbacks['Importe']->__toString(),
            'tasa'     => $holdbacks['TasadeRetencion']->__toString(),
        ];
    }

    /**
     * Retrieves all the 'cfdi.taxes' with it's nested objects like
     * 'retenciones' and 'traslados'.
     *
     * @return object
     */
    private function getImpuestos()
    {
        $impuestos = $this->cfdi->xpath($this->paths['cfdi.taxes'])[0];

        return (object) [
            'totalImpuestosTrasladados' => $impuestos['totalImpuestosTrasladados']->__toString(),
            'totalImpuestosRetenidos'   => $impuestos['totalImpuestosRetenidos']->__toString(),
            'retenciones'               => $this->getRetenciones(),
            'traslados'                 => $this->getTraslados(),
        ];
    }

    /**
     * Retrieves all 'cfdi.taxes.transfers' in the CFDI.
     *
     * @return array
     */
    private function getTraslados()
    {
        $transfers = $this->cfdi->xpath($this->paths['cfdi.taxes.transfers']);

        $traslados = [];
        foreach ($transfers as $transfer) {
            $traslado = [
                'impuesto' => $transfer['impuesto']->__toString(),
                'importe'  => $transfer['importe']->__toString(),
                'tasa'     => $transfer['tasa']->__toString(),
            ];

            $traslados[] = (object) $traslado;
        }

        return $traslados;
    }

    /**
     * Retrieves the path 'cfdi.taxes.holdbacks'.
     *
     * @return array
     */
    private function getRetenciones()
    {
        $holdbacks = $this->cfdi->xpath($this->paths['cfdi.taxes.holdbacks']);

        $retenciones = [];
        foreach ($holdbacks as $holdback) {
            $retencion = [
                'impuesto' => $holdback['impuesto']->__toString(),
                'importe'  => $holdback['importe']->__toString(),
            ];

            $retenciones[] = (object) $retencion;
        }

        return $retenciones;
    }

    /**
     * Retrieves all 'cfdi.items' in the CFDI.
     *
     * @return array
     */
    private function getConceptos()
    {
        $items = $this->cfdi->xpath($this->paths['cfdi.items']);
        $conceptos = [];
        foreach ($items as $item) {
            $concepto = [
                'cantidad'      => $item['cantidad']->__toString(),
                'unidad'        => $item['unidad']->__toString(),
                'descripcion'   => $item['descripcion']->__toString(),
                'valorUnitario' => $item['valorUnitario']->__toString(),
                'importe'       => $item['importe']->__toString(),
            ];

            $conceptos[] = (object) $concepto;
        }

        return $conceptos;
    }

    /**
     * Retrieves the 'cfdi.receiver' path, including it's nested resources like
     * 'domicilio'.
     *
     * @return object
     */
    private function getReceptor()
    {
        $comprobante = $this->cfdi->xpath($this->paths['cfdi.receiver']);
        $domicilio = $this->getDomicilioFiscal('cfdi.receiver.address');

        $receptor = [
            'rfc'             => $comprobante[0]['rfc']->__toString(),
            'nombre'          => $comprobante[0]['nombre']->__toString(),
            'domicilioFiscal' => $domicilio,
            'domicilio'       => $domicilio,
        ];

        return (object) $receptor;
    }

    /**
     * Retrieves the 'cfdi.issuing' path and all it's nested resources like
     * 'comprobante', 'domicilio', 'regimen', etc.
     *
     * @return object
     */
    private function getEmisor()
    {
        $comprobante = $this->cfdi->xpath($this->paths['cfdi.issuing']);
        $domicilio = $this->getDomicilioFiscal('cfdi.issuing.address');
        $regimenFiscal = $this->getRegimenFiscal();

        $emisor = [
            'rfc'             => $comprobante[0]['rfc']->__toString(),
            'nombre'          => $comprobante[0]['nombre']->__toString(),
            'domicilioFiscal' => $domicilio,
            'domicilio'       => $domicilio,
            'expedidoEn'      => $this->getExpedidoEn(),
            'regimenFiscal'   => $regimenFiscal,
            'regimen'         => $regimenFiscal,
        ];

        return (object) $emisor;
    }

    /**
     * Get the nested object domicilioFiscal for the specified path, this can be
     * either 'cfdi.issuing.address' or 'cfdi.receiver.address'.
     *
     * @param string $path 'cfdi.receiver.address' or 'cfdi.issuing.address'.
     *
     * @return object
     */
    private function getDomicilioFiscal($path)
    {
        $address = $this->cfdi->xpath($this->paths[$path])[0];

        $domicilio = [
            'calle'        => $address['calle']->__toString(),
            'colonia'      => $address['colonia']->__toString(),
            'localidad'    => '',
            'municipio'    => $address['municipio']->__toString(),
            'noExterior'   => $address['noExterior']->__toString(),
            'noInterior'   => '',
            'estado'       => $address['estado']->__toString(),
            'pais'         => $address['pais']->__toString(),
            'codigoPostal' => $address['codigoPostal']->__toString(),
        ];

        if (isset($address['localidad'])) {
            $domicilio['localidad'] = $address['localidad']->__toString();
        }

        if (isset($address['noInterior'])) {
            $domicilio['noInterior'] = $address['noInterior']->__toString();
        }

        return (object) $domicilio;
    }

    /**
     * Retrieves the info located at 'cfdi.issuing.issued_at'.
     *
     * @return object
     */
    private function getExpedidoEn()
    {
        $expedidoEn = $this->cfdi->xpath($this->paths['cfdi.issuing.issued_at']);

        return (object) [
            'pais' => $expedidoEn[0]['pais']->__toString(),
        ];
    }

    /**
     * Retrieves the info located at 'cfdi.issuing.regimen'.
     *
     * @return object
     */
    private function getRegimenFiscal()
    {
        $regimenFiscal = $this->cfdi->xpath($this->paths['cfdi.issuing.regimen']);

        return (object) [
            'regimen' => $regimenFiscal[0]['Regimen']->__toString(),
            'Regimen' => $regimenFiscal[0]['Regimen']->__toString(),
        ];
    }

    /**
     * Retrieves the field known as 'Cadena original de complemento de
     * certificación del SAT'.
     *
     * @return string
     */
    private function getCadenaOriginal()
    {
        return sprintf(
            '||%s|%s|%s|%s|%s||',
            $this->timbre->version,

The property timbre does not exist on ZzAntares\CfdiWrapper\Cfdi. Since you implemented __get, consider adding a @property annotation.

            $this->timbre->uuid,
            $this->timbre->fechaTimbrado,
            $this->timbre->selloCFD,
            $this->timbre->noCertificadoSAT
        );
    }

    /**
     * Gives a stdClass object with information of the given tax like 'tasa',
     * 'importe', etc.
     *
     * @throws UndefinedAttributeException When tax is not found in the CFDI.
     *
     * @param $taxName Which tax to retrieve, this could be 'iva', 'ieps', etc.

The type ZzAntares\CfdiWrapper\Which was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return object
     */
    private function getImpuesto($taxName)
    {
        // Only 'iva' is supported for now
        if ($taxName != 'iva') {
            throw new UndefinedAttributeException();
        }

        $taxName = strtoupper($taxName);

        foreach ($this->impuestos->traslados as $tax) {

The property impuestos does not exist on ZzAntares\CfdiWrapper\Cfdi. Since you implemented __get, consider adding a @property annotation.

            if ($tax->impuesto == $taxName) {
                return $tax;
            }
        }

        throw new UndefinedAttributeException();
    }

    /**
     * Gets the Qr string, this is the string that should be read when scaning
     * the QR code image.
     *
     * @return string
     */
    public function getQrString()
    {
        return '?re=' . $this->emisor->rfc

The property emisor does not exist on ZzAntares\CfdiWrapper\Cfdi. Since you implemented __get, consider adding a @property annotation.

            . '&rr=' . $this->receptor->rfc

The property receptor does not exist on ZzAntares\CfdiWrapper\Cfdi. Since you implemented __get, consider adding a @property annotation.

            . '&tt=' . $this->total

Are you sure $this->total of type object can be used in concatenation?

The property total does not exist on ZzAntares\CfdiWrapper\Cfdi. Since you implemented __get, consider adding a @property annotation.

            . '&id=' . $this->timbre->uuid;

The property timbre does not exist on ZzAntares\CfdiWrapper\Cfdi. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     * Gets the qr code in string format.
     *
     * @param integer $width Width of the QR code image.
     * @param integer $height Height of the QR code image.
     * @param bool $base64 If you want raw bytes then set this to 'false'.
     *
     * @return string
     */
    public function qr($width = 256, $height = 256, $base64 = true)
    {
        $renderer = new \BaconQrCode\Renderer\Image\Png();
        $renderer->setWidth($width);
        $renderer->setHeight($height);

        $writer = new \BaconQrCode\Writer($renderer);
        $qrString = $writer->writeString($this->getQrString());

        if (!$base64) {
            return $qrString;
        }

        return base64_encode($qrString);
    }

    /**
     * Writes the QR code string (bytes) to a file in order to generate the
     * QR code image.
     *
     * @param string $filepath Full path to file location with filename included.
     * @param integer $width Width of the QR code image.
     * @param integer $height Height of the QR code image.
     *
     * @return integer Bytes written or 'false' on failure.
     */
    public function qrCode($filepath, $width = 256, $height = 256)
    {
        return file_put_contents($filepath, $this->qr($width, $height, false));
    }
}