libredte\lib\Core\Package\Billing\Component\Document\Abstract\AbstractDocument

Complexity

Total Complexity

32

Size/Duplication

Total Lines	310
Duplicated Lines	0 %

Test Coverage

Coverage

72.17%

Importance

Changes	1
Bugs	0	Features	0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	getTotales()	0	3	1
A	getReceptor()	0	3	1
A	__toString()	0	3	1
A	getFechaEmision()	0	3	1
A	getRutEmisor()	0	3	1
A	getXml()	0	3	1
A	getId()	0	7	1
A	getXmlDocument()	0	3	1
A	getRazonSocialReceptor()	0	3	1
A	__construct()	0	13	2
A	getEmisor()	0	3	1
A	getCodigo()	0	3	1
A	saveXml()	0	3	1
A	getRutReceptor()	0	3	1
A	getTipoDocumento()	0	3	1
A	getMontoTotal()	0	11	2
A	getFolio()	0	3	1
A	getPlantillaTED()	0	28	1
A	query()	0	3	1
A	getDetalle()	0	12	4
A	getDatos()	0	28	3
A	getMoneda()	0	5	1
A	get()	0	3	1
A	getTED()	0	6	2

<?php

declare(strict_types=1);

/**
 * LibreDTE: Biblioteca PHP (Núcleo).
 * Copyright (C) LibreDTE <https://www.libredte.cl>
 *
 * Este programa es software libre: usted puede redistribuirlo y/o modificarlo
 * bajo los términos de la Licencia Pública General Affero de GNU publicada por
 * la Fundación para el Software Libre, ya sea la versión 3 de la Licencia, o
 * (a su elección) cualquier versión posterior de la misma.
 *
 * Este programa se distribuye con la esperanza de que sea útil, pero SIN
 * GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
 * PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la Licencia Pública
 * General Affero de GNU para obtener una información más detallada.
 *
 * Debería haber recibido una copia de la Licencia Pública General Affero de
 * GNU junto a este programa.
 *
 * En caso contrario, consulte <http://www.gnu.org/licenses/agpl.html>.
 */

namespace libredte\lib\Core\Package\Billing\Component\Document\Abstract;

use Derafu\Lib\Core\Helper\Arr;
use Derafu\Lib\Core\Helper\Selector;
use Derafu\Lib\Core\Package\Prime\Component\Entity\Entity\Entity;
use Derafu\Lib\Core\Package\Prime\Component\Xml\Contract\XmlInterface;
use Derafu\Lib\Core\Package\Prime\Component\Xml\Exception\XmlException;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\DocumentInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Entity\CodigoDocumento;
use LogicException;

/**
 * Clase abstracta (base) de la representación de un documento tributario
 * electrónico.
 */
abstract class AbstractDocument extends Entity implements DocumentInterface
{
    /**
     * Código del tipo de documento tributario al que está asociada esta
     * instancia de un documento.
     *
     * Este valor está definido en cada clase que hereda de esta.
     */
    protected CodigoDocumento $tipoDocumento;

    /**
     * Instancia del documento XML asociado a los datos.
     *
     * @var XmlInterface
     */
    protected readonly XmlInterface $xmlDocument;

    /**
     * Datos del documento tributario estandarizados.
     *
     * @var array
     */
    private array $datos;

    /**
     * Constructor del documento tributario.
     *
     * @param XmlInterface $xmlDocument
     * @return void
     */
    public function __construct(XmlInterface $xmlDocument)
    {
        $this->xmlDocument = $xmlDocument;

The property xmlDocument is declared read-only in libredte\lib\Core\Package\Billing\Component\Document\Abstract\AbstractDocument.

        // Validar que el código que está en el XmlDocument sea el que la clase
        // de la estrategia espera.
        $xmlDocumentTipoDTE = (int) $xmlDocument->query('//Encabezado/IdDoc/TipoDTE');
        if ($xmlDocumentTipoDTE !== $this->getCodigo()) {
            throw new LogicException(sprintf(
                'El código %s del XmlDocument cargado en %s no corresponde con el esperado, debería ser código %d.',
                $xmlDocumentTipoDTE,
                static::class,
                $this->getCodigo()
            ));
        }
    }

    /**
     * {@inheritdoc}
     */
    public function __toString(): string
    {
        return $this->getId();
    }

    /**
     * {@inheritdoc}
     */
    public function getXmlDocument(): XmlInterface
    {
        return $this->xmlDocument;
    }

    /**
     * {@inheritdoc}
     */
    public function saveXml(): string
    {
        return $this->xmlDocument->saveXml();
    }

    /**
     * {@inheritdoc}
     */
    public function getXml(): string
    {
        return $this->xmlDocument->getXml();
    }

    /**
     * {@inheritdoc}
     */
    public function getId(): string
    {
        return sprintf(
            '%sT%dF%d',
            $this->getRutEmisor(),
            $this->getCodigo(),
            $this->getFolio()
        );
    }

    /**
     * {@inheritdoc}
     */
    public function getCodigo(): int
    {
        return $this->tipoDocumento->getCodigo();
    }

    /**
     * {@inheritdoc}
     */
    public function getFolio(): int
    {
        return (int) $this->xmlDocument->query('//Encabezado/IdDoc/Folio');
    }

    /**
     * {@inheritdoc}
     */
    public function getTipoDocumento(): CodigoDocumento
    {
        return $this->tipoDocumento;
    }

    /**
     * {@inheritdoc}
     */
    public function getEmisor(): array
    {
        return $this->xmlDocument->query('//Encabezado/Emisor');

The expression return $this->xmlDocument->query('//Encabezado/Emisor') could return the type null|string which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getRutEmisor(): string
    {
        return $this->xmlDocument->query('//Encabezado/Emisor/RUTEmisor');

The expression return $this->xmlDocument->query('//Encabezado/Emisor/RUTEmisor') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getReceptor(): array
    {
        return $this->xmlDocument->query('//Encabezado/Receptor');

The expression return $this->xmlDocument->query('//Encabezado/Receptor') could return the type null|string which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getRutReceptor(): string
    {
        return $this->xmlDocument->query('//Encabezado/Receptor/RUTRecep');

The expression return $this->xmlDocument->query('//Encabezado/Receptor/RUTRecep') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getRazonSocialReceptor(): string
    {
        return $this->xmlDocument->query('//Encabezado/Receptor/RznSocRecep');

The expression return $this->xmlDocument->query('//Encabezado/Receptor/RznSocRecep') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getFechaEmision(): string
    {
        return $this->xmlDocument->query('//Encabezado/IdDoc/FchEmis');

The expression return $this->xmlDocument->query('//Encabezado/IdDoc/FchEmis') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getTotales(): array
    {
        return $this->xmlDocument->query('//Encabezado/Totales');

The expression return $this->xmlDocument->query('//Encabezado/Totales') could return the type null|string which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getMontoTotal(): int|float
    {
        $monto = (float) $this->xmlDocument->query('//Encabezado/Totales/MntTotal');

        // Verificar si el monto es equivalente a un entero.
        if (floor($monto) == $monto) {
            return (int) $monto;
        }

        // Entregar como flotante.
        return $monto;
    }

    /**
     * {@inheritdoc}
     */
    public function getMoneda(): string
    {
        $moneda = $this->query('//Encabezado/Totales/TpoMoneda') ?? 'PESO CL';

        return (string) $moneda;
    }

    /**
     * {@inheritdoc}
     */
    public function getDetalle(?int $index = null): array
    {
        $detalle = $this->xmlDocument->query('//Detalle');
        if ($detalle === null) {
            return [];
        }

        if (!isset($detalle[0])) {
            $detalle = [$detalle];
        }

        return $index !== null ? ($detalle[$index] ?? []) : $detalle;

The expression return $index !== null ? $detalle[$index] ?? array() : $detalle could return the type string which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getDatos(): array
    {
        // Si los datos del DTE no están determinados se crean de una manera
        // estandarizada compatible con los datos de entrada normalizados.
        if (!isset($this->datos)) {
            $array = $this->xmlDocument->query('/');

            $array = $array['DTE']['Documento']
                ?? $array['DTE']['Exportaciones']
                ?? $array['DTE']['Liquidacion']
                ?? $array
            ;

            unset($array['TED'], $array['TmstFirma']);

            $arrayRequired = [
                'Detalle',
                'Encabezado.Totales.ImptoReten',
            ];
            foreach ($arrayRequired as $path) {
                Arr::ensureArrayAtPath($array, $path);
            }

            $this->datos = Arr::autoCastRecursive($array);
        }

        // Entregar los datos del DTE.
        return $this->datos;
    }

    /**
     * {@inheritdoc}
     */
    public function getTED(): ?string
    {
        try {
            return $this->getXmlDocument()->C14NWithIsoEncodingFlattened('//TED');
        } catch (XmlException $e) {
            return null;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getPlantillaTED(): array
    {
        return [
            'TED' => [
                '@attributes' => [
                    'version' => '1.0',
                ],
                'DD' => [
                    'RE' => $this->getRutEmisor(),
                    'TD' => $this->getCodigo(),
                    'F' => $this->getFolio(),
                    'FE' => $this->getFechaEmision(),
                    'RR' => $this->getRutReceptor(),
                    'RSR' => mb_substr($this->getRazonSocialReceptor(), 0, 40),
                    'MNT' => $this->getMontoTotal(),
                    'IT1' => mb_substr(
                        $this->getDetalle(0)['NmbItem'] ?? '',
                        0,
                        40
                    ),
                    'CAF' => '', // Se deberá agregar al timbrar.
                    'TSTED' => '', // Se deberá agregar al timbrar.
                ],
                'FRMT' => [
                    '@attributes' => [
                        'algoritmo' => 'SHA1withRSA',
                    ],
                    '@value' => '', // Se deberá agregar al timbrar.
                ],
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function get(string $selector): mixed
    {
        return Selector::get($this->getDatos(), $selector);
    }

    /**
     * {@inheritdoc}
     */
    public function query(string $query, array $params = []): string|array|null
    {
        return $this->xmlDocument->query($query, $params);
    }
}