CodigoDocumento::getNombreCorto() - Code Metrics - Inspection of "Se separan enum de las entidades a su propio names..." - libredte/libredte-lib-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 72075e...fe7ce5 )

by Esteban De La Fuente

created 2025-01-15 14:35 UTC

CodigoDocumento::getNombreCorto() A

↳ Parent: CodigoDocumento

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?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\Enum;

use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\BoletaAfectaInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\BoletaExentaInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaAfectaInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaCompraInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaExentaInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaExportacionInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\GuiaDespachoInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\LiquidacionFacturaInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaCreditoExportacionInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaCreditoInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaDebitoExportacionInterface;
use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaDebitoInterface;

/**
 * Enum del código de los documentos tributarios electrónicos.
 */
enum CodigoDocumento: int
{
    case FACTURA_AFECTA = 33;
    case FACTURA_EXENTA = 34;
    case BOLETA_AFECTA = 39;
    case BOLETA_EXENTA = 41;
    case LIQUIDACION_FACTURA = 43;
    case FACTURA_COMPRA = 46;
    case GUIA_DESPACHO = 52;
    case NOTA_DEBITO = 56;
    case NOTA_CREDITO = 61;
    case FACTURA_EXPORTACION = 110;
    case NOTA_DEBITO_EXPORTACION = 111;
    case NOTA_CREDITO_EXPORTACION = 112;

    /**
     * Mapa con los códigos de documento y su nombre.
     */
    private const NOMBRES = [
        self::FACTURA_AFECTA->value => 'Factura electrónica',
        self::FACTURA_EXENTA->value => 'Factura no afecta o exenta electrónica',
        self::BOLETA_AFECTA->value => 'Boleta electrónica',
        self::BOLETA_EXENTA->value => 'Boleta no afecta o exenta electrónica',
        self::LIQUIDACION_FACTURA->value => 'Liquidación factura electrónica',
        self::FACTURA_COMPRA->value => 'Factura de compra electrónica',
        self::GUIA_DESPACHO->value => 'Guía de despacho electrónica',
        self::NOTA_DEBITO->value => 'Nota de débito electrónica',
        self::NOTA_CREDITO->value => 'Nota de crédito electrónica',
        self::FACTURA_EXPORTACION->value => 'Factura de exportación electrónica',
        self::NOTA_DEBITO_EXPORTACION->value => 'Nota de débito de exportación electrónica',
        self::NOTA_CREDITO_EXPORTACION->value => 'Nota de crédito de exportación electrónica',
    ];

    /**
     * Mapa con los códigos de documento y su alias.
     */
    private const ALIASES = [
        self::FACTURA_AFECTA->value => 'factura_afecta',
        self::FACTURA_EXENTA->value => 'factura_exenta',
        self::BOLETA_AFECTA->value => 'boleta_afecta',
        self::BOLETA_EXENTA->value => 'boleta_exenta',
        self::LIQUIDACION_FACTURA->value => 'liquidacion_factura',
        self::FACTURA_COMPRA->value => 'factura_compra',
        self::GUIA_DESPACHO->value => 'guia_despacho',
        self::NOTA_DEBITO->value => 'nota_debito',
        self::NOTA_CREDITO->value => 'nota_credito',
        self::FACTURA_EXPORTACION->value => 'factura_exportacion',
        self::NOTA_DEBITO_EXPORTACION->value => 'nota_debito_exportacion',
        self::NOTA_CREDITO_EXPORTACION->value => 'nota_credito_exportacion',
    ];

    /**
     * Mapa con los códigos de documento y su interfaz.
     */
    private const INTERFACES = [
        self::FACTURA_AFECTA->value => FacturaAfectaInterface::class,
        self::FACTURA_EXENTA->value => FacturaExentaInterface::class,
        self::BOLETA_AFECTA->value => BoletaAfectaInterface::class,
        self::BOLETA_EXENTA->value => BoletaExentaInterface::class,
        self::LIQUIDACION_FACTURA->value => LiquidacionFacturaInterface::class,
        self::FACTURA_COMPRA->value => FacturaCompraInterface::class,
        self::GUIA_DESPACHO->value => GuiaDespachoInterface::class,
        self::NOTA_DEBITO->value => NotaDebitoInterface::class,
        self::NOTA_CREDITO->value => NotaCreditoInterface::class,
        self::FACTURA_EXPORTACION->value => FacturaExportacionInterface::class,
        self::NOTA_DEBITO_EXPORTACION->value => NotaDebitoExportacionInterface::class,
        self::NOTA_CREDITO_EXPORTACION->value => NotaCreditoExportacionInterface::class,
    ];

    /**
     * Entrega el código del documento oficial del SII.
     *
     * @return int
     */
    public function getCodigo(): int
    {
        return $this->value;
    }

    /**
     * Entrega el nombre del tipo de documento.
     *
     * @return string
     */
    public function getNombre(): string
    {
        return self::NOMBRES[$this->value];

    }

    /**
     * Entrega el nombre corto del tipo de documento.
     *
     * @return string
     */
    public function getNombreCorto(): string
    {
        return str_replace(' electrónica', '', self::NOMBRES[$this->value]);

    }

    /**
     * Entrega el alias del documento.
     *
     * @return string
     */
    public function getAlias(): string
    {
        return self::ALIASES[$this->value];

    }

    /**
     * Entrega la interfaz PHP asociada al tipo de documento.
     *
     * @return string
     */
    public function getInterface(): string
    {
        return self::INTERFACES[$this->value];

    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/**
6		* LibreDTE: Biblioteca PHP (Núcleo).
7		* Copyright (C) LibreDTE <https://www.libredte.cl>
8		*
9		* Este programa es software libre: usted puede redistribuirlo y/o modificarlo
10		* bajo los términos de la Licencia Pública General Affero de GNU publicada por
11		* la Fundación para el Software Libre, ya sea la versión 3 de la Licencia, o
12		* (a su elección) cualquier versión posterior de la misma.
13		*
14		* Este programa se distribuye con la esperanza de que sea útil, pero SIN
15		* GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
16		* PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la Licencia Pública
17		* General Affero de GNU para obtener una información más detallada.
18		*
19		* Debería haber recibido una copia de la Licencia Pública General Affero de
20		* GNU junto a este programa.
21		*
22		* En caso contrario, consulte <http://www.gnu.org/licenses/agpl.html>.
23		*/
24
25		namespace libredte\lib\Core\Package\Billing\Component\Document\Enum;
26
27		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\BoletaAfectaInterface;
28		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\BoletaExentaInterface;
29		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaAfectaInterface;
30		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaCompraInterface;
31		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaExentaInterface;
32		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\FacturaExportacionInterface;
33		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\GuiaDespachoInterface;
34		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\LiquidacionFacturaInterface;
35		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaCreditoExportacionInterface;
36		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaCreditoInterface;
37		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaDebitoExportacionInterface;
38		use libredte\lib\Core\Package\Billing\Component\Document\Contract\Document\NotaDebitoInterface;
39
40		/**
41		* Enum del código de los documentos tributarios electrónicos.
42		*/
43		enum CodigoDocumento: int
44		{
45		case FACTURA_AFECTA = 33;
46		case FACTURA_EXENTA = 34;
47		case BOLETA_AFECTA = 39;
48		case BOLETA_EXENTA = 41;
49		case LIQUIDACION_FACTURA = 43;
50		case FACTURA_COMPRA = 46;
51		case GUIA_DESPACHO = 52;
52		case NOTA_DEBITO = 56;
53		case NOTA_CREDITO = 61;
54		case FACTURA_EXPORTACION = 110;
55		case NOTA_DEBITO_EXPORTACION = 111;
56		case NOTA_CREDITO_EXPORTACION = 112;
57
58		/**
59		* Mapa con los códigos de documento y su nombre.
60		*/
61		private const NOMBRES = [
62		self::FACTURA_AFECTA->value => 'Factura electrónica',
63		self::FACTURA_EXENTA->value => 'Factura no afecta o exenta electrónica',
64		self::BOLETA_AFECTA->value => 'Boleta electrónica',
65		self::BOLETA_EXENTA->value => 'Boleta no afecta o exenta electrónica',
66		self::LIQUIDACION_FACTURA->value => 'Liquidación factura electrónica',
67		self::FACTURA_COMPRA->value => 'Factura de compra electrónica',
68		self::GUIA_DESPACHO->value => 'Guía de despacho electrónica',
69		self::NOTA_DEBITO->value => 'Nota de débito electrónica',
70		self::NOTA_CREDITO->value => 'Nota de crédito electrónica',
71		self::FACTURA_EXPORTACION->value => 'Factura de exportación electrónica',
72		self::NOTA_DEBITO_EXPORTACION->value => 'Nota de débito de exportación electrónica',
73		self::NOTA_CREDITO_EXPORTACION->value => 'Nota de crédito de exportación electrónica',
74		];
75
76		/**
77		* Mapa con los códigos de documento y su alias.
78		*/
79		private const ALIASES = [
80		self::FACTURA_AFECTA->value => 'factura_afecta',
81		self::FACTURA_EXENTA->value => 'factura_exenta',
82		self::BOLETA_AFECTA->value => 'boleta_afecta',
83		self::BOLETA_EXENTA->value => 'boleta_exenta',
84		self::LIQUIDACION_FACTURA->value => 'liquidacion_factura',
85		self::FACTURA_COMPRA->value => 'factura_compra',
86		self::GUIA_DESPACHO->value => 'guia_despacho',
87		self::NOTA_DEBITO->value => 'nota_debito',
88		self::NOTA_CREDITO->value => 'nota_credito',
89		self::FACTURA_EXPORTACION->value => 'factura_exportacion',
90		self::NOTA_DEBITO_EXPORTACION->value => 'nota_debito_exportacion',
91		self::NOTA_CREDITO_EXPORTACION->value => 'nota_credito_exportacion',
92		];
93
94		/**
95		* Mapa con los códigos de documento y su interfaz.
96		*/
97		private const INTERFACES = [
98		self::FACTURA_AFECTA->value => FacturaAfectaInterface::class,
99		self::FACTURA_EXENTA->value => FacturaExentaInterface::class,
100		self::BOLETA_AFECTA->value => BoletaAfectaInterface::class,
101		self::BOLETA_EXENTA->value => BoletaExentaInterface::class,
102		self::LIQUIDACION_FACTURA->value => LiquidacionFacturaInterface::class,
103		self::FACTURA_COMPRA->value => FacturaCompraInterface::class,
104		self::GUIA_DESPACHO->value => GuiaDespachoInterface::class,
105		self::NOTA_DEBITO->value => NotaDebitoInterface::class,
106		self::NOTA_CREDITO->value => NotaCreditoInterface::class,
107		self::FACTURA_EXPORTACION->value => FacturaExportacionInterface::class,
108		self::NOTA_DEBITO_EXPORTACION->value => NotaDebitoExportacionInterface::class,
109		self::NOTA_CREDITO_EXPORTACION->value => NotaCreditoExportacionInterface::class,
110		];
111
112		/**
113		* Entrega el código del documento oficial del SII.
114		*
115		* @return int
116		*/
117	67	public function getCodigo(): int
118		{
119	67	return $this->value;
120		}
121
122		/**
123		* Entrega el nombre del tipo de documento.
124		*
125		* @return string
126		*/
127	74	public function getNombre(): string
128		{
129	74	return self::NOMBRES[$this->value];
		0 ignored issues – show Bug introduced 2025-01-15 14:41 UTC by Report Bug Copy Issue Report The constant `libredte\lib\Core\Packag...odigoDocumento::NOMBRES` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
130		}
131
132		/**
133		* Entrega el nombre corto del tipo de documento.
134		*
135		* @return string
136		*/
137	74	public function getNombreCorto(): string
138		{
139	74	return str_replace(' electrónica', '', self::NOMBRES[$this->value]);
		0 ignored issues – show Bug introduced 2025-01-15 14:41 UTC by Report Bug Copy Issue Report The constant `libredte\lib\Core\Packag...odigoDocumento::NOMBRES` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
140		}
141
142		/**
143		* Entrega el alias del documento.
144		*
145		* @return string
146		*/
147	74	public function getAlias(): string
148		{
149	74	return self::ALIASES[$this->value];
		0 ignored issues – show Bug introduced 2025-01-15 14:41 UTC by Report Bug Copy Issue Report The constant `libredte\lib\Core\Packag...odigoDocumento::ALIASES` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
150		}
151
152		/**
153		* Entrega la interfaz PHP asociada al tipo de documento.
154		*
155		* @return string
156		*/
157	74	public function getInterface(): string
158		{
159	74	return self::INTERFACES[$this->value];
		0 ignored issues – show Bug introduced 2025-01-15 14:41 UTC by Report Bug Copy Issue Report The constant `libredte\lib\Core\Packag...goDocumento::INTERFACES` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
160		}
161		}
162

libredte / libredte-lib-core

Push — master ( 72075e...fe7ce5 )

CodigoDocumento::getNombreCorto() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like