Catalogo::getAllCatNumbers() - Code Metrics - Inspection of "Fix: Nombre de empresa en la parte superior del co..." - jDelta/F72X - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( c55034...101a53 )

by JAIME ELMER

created 2019-06-05 21:21 UTC

Catalogo::getAllCatNumbers() A

↳ Parent: Catalogo

Complexity

Conditions	6
Paths	32

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	12
nc	32
nop	0
dl	0
loc	18
rs	9.2222
c	0
b	0
f	0

<?php

/**
 * MÓDULO DE EMISIÓN ELECTRÓNICA F72X
 * UBL 2.1
 * Version 1.0
 * 
 * Copyright 2019, Jaime Cruz
 */

namespace F72X\Sunat;

use InvalidArgumentException;
use F72X\F72X;
use F72X\Company;
use F72X\Exception\ConfigException;

class Catalogo {

    const CAT_TAX_DOCUMENT_TYPE    = 1;
    const CAT_CURRENCY_TYPE        = 2;
    const CAT_MEASUREMENT_UNIT     = 3;
    const CAT_COUNTRY_CODE         = 4;
    const CAT_TAX_TYPE             = 5;
    const CAT_IDENT_DOCUMENT_TYPE  = 6;
    const CAT_IGV_AFFECTATION_TYPE = 7;
    const CAT_ISC_CALC_SYSTEM_TYPE = 8;
    const CAT_NOTA_CREDITO_TYPE    = 9;
    const CAT_NOTA_DEBITO_TYPE     = 10;
    const CAT_PERCEPCION_REGIME    = 22;
    const CAT_RETENCION_REGIME     = 23;
    const CAT_FACTURA_TYPE         = 51;

    /** @CAT1 Código tipo de documento */
    const DOCTYPE_FACTURA = '01';
    const DOCTYPE_BOLETA = '03';
    const DOCTYPE_NOTA_CREDITO = '07';
    const DOCTYPE_NOTA_DEBITO = '08';
    const DOCTYPE_VOUCHER = '12';
    const DOCTYPE_SC_FACTURA = 'FAC';
    const DOCTYPE_SC_BOLETA = 'BOL';
    const DOCTYPE_SC_NOTA_CREDITO = 'NCR';
    const DOCTYPE_SC_NOTA_DEBITO = 'NDE';

    /** @CAT5 Tipo de impuesto */
    const CAT5_IGV = '1000';
    const CAT5_IVAP = '1016';
    const CAT5_ISC = '2000';
    const CAT5_EXP = '9995';
    const CAT5_GRA = '9996';
    const CAT5_EXO = '9997';
    const CAT5_INA = '9998';
    const CAT5_OTROS = '9999';

    /** @CAT7 Tipo de afectación del IGV */
    const CAT7_GRA_IGV = '10';

    /** @CAT16 Tipo de precio */
    const CAT16_UNITARY_PRICE = '01';
    const CAT16_REF_VALUE = '02';

    /** @CAT6 */
    const IDENTIFICATION_DOC_DNI = '1';
    const IDENTIFICATION_DOC_RUC = '6';

    private static $_CAT = [];
    private static $_LIST = [];

    /**
     * 
     * @param string $documentType 01|03|07|08
     * @param string $affectedDocumentType 01|03
     * @return string F|B
     */
    public static function getDocumentSeriesPrefix($documentType, $affectedDocumentType = null) {
        if ($documentType == self::DOCTYPE_FACTURA) {
            return 'F';
        }
        if ($documentType == self::DOCTYPE_BOLETA) {
            return 'B';
        }
        if ($documentType == self::DOCTYPE_NOTA_CREDITO) {
            return self::getDocumentSeriesPrefix($affectedDocumentType);
        }
        if ($documentType == self::DOCTYPE_NOTA_DEBITO) {
            return self::getDocumentSeriesPrefix($affectedDocumentType);
        }
        if ($documentType == self::DOCTYPE_VOUCHER) {
            throw new InvalidArgumentException("Error: Cash register ticket isn't supported yet.");
        }
        throw new InvalidArgumentException("Error: $documentType isn't a valid document type");
    }

    /**
     * 
     * @param string $documentType 01|03|07|08
     * @return string FACTURA|BOLETA|NOTA DE CRÉDITO|NOTA DE DÉBITO
     */
    public static function getOfficialDocumentName($documentType) {
        switch ($documentType) {
            case self::DOCTYPE_FACTURA : return 'FACTURA';
            case self::DOCTYPE_BOLETA : return 'BOLETA DE VENTA';
            case self::DOCTYPE_NOTA_CREDITO : return 'NOTA DE CRÉDITO';
            case self::DOCTYPE_NOTA_DEBITO : return 'NOTA DE DÉBITO';
        }
        throw new InvalidArgumentException("Error: $documentType isn't a valid document type");
    }

    /**
     * 
     * @param string $shortCode BOL|FAC|NCR|NDE
     * @return string 01|03|07|08
     */
    public static function getDocumentType($shortCode) {
        switch ($shortCode) {
            case self::DOCTYPE_SC_FACTURA: return self::DOCTYPE_FACTURA;
            case self::DOCTYPE_SC_BOLETA: return self::DOCTYPE_BOLETA;
            case self::DOCTYPE_SC_NOTA_CREDITO: return self::DOCTYPE_NOTA_CREDITO;
            case self::DOCTYPE_SC_NOTA_DEBITO: return self::DOCTYPE_NOTA_DEBITO;
        }
        throw new InvalidArgumentException("Error: $shortCode isn't valid short code use (BOL|FAC|NCR|NDE)");
    }

    /**
     * 
     * @param string $docType 01|03|07|08
     * @return string BOL|FAC|NCR|NDE
     */
    public static function getDocumentShortCode($docType) {
        switch ($docType) {
            case self::DOCTYPE_FACTURA:      return self::DOCTYPE_SC_FACTURA;
            case self::DOCTYPE_BOLETA:       return self::DOCTYPE_SC_BOLETA;
            case self::DOCTYPE_NOTA_CREDITO: return self::DOCTYPE_SC_NOTA_CREDITO;
            case self::DOCTYPE_NOTA_DEBITO:  return self::DOCTYPE_SC_NOTA_DEBITO;
        }
        throw new InvalidArgumentException("Error: $docType isn't valid document type use (01|03|07|08)");
    }

    public static function itemExist($catNumber, $itemID) {
        $items = self::getCatItems($catNumber);
        return key_exists($itemID, $items);
    }

    /**
     * Valor de item de catálogo
     * @param int $catNumber
     * @param string $itemID
     * @return string
     * @throws InvalidArgumentException cuando el item no existe en el catálogo.
     */
    public static function getCatItemValue($catNumber, $itemID) {
        $item = self::getCatItem($catNumber, $itemID);
        if ($item) {
            return $item['value'];
        }
        throw new InvalidArgumentException("Catálogo Error, no existe un item con ID='$itemID' en el cátalogo='$catNumber'");
    }

    /**
     * Valor de item de catálogo
     * @param int $catNumber
     * @param string $itemID
     * @return string
     * @throws InvalidArgumentException cuando el item no existe en el catálogo.
     */
    public static function getCatItemFieldValue($catNumber, $itemID, $field) {
        $item = self::getCatItem($catNumber, $itemID);
        if ($item) {
            if(isset($item[$field])){
                return $item[$field];
            }
            throw new InvalidArgumentException("Catálogo Error, no existe el campo '$field' en el cátalogo='$catNumber'");
        }
        throw new InvalidArgumentException("Catálogo Error, no existe un item con ID='$itemID' en el cátalogo='$catNumber'");
    }

    public static function getCatItem($catNumber, $itemID, $key = 'id') {
        $items = self::getCatItems($catNumber);
        foreach ($items as $item) {
            if ($item[$key] === strval($itemID)) {
                return $item;
            }
        }
        return null;
    }

    public static function getCatItems($catNumber, $useXmlFiles = false) {
        // returns from cache
        if (isset(self::$_CAT['CAT_' . $catNumber])) {
            return self::$_CAT['CAT_' . $catNumber];
        }
        // Load from file
        $fileName = strtoupper(self::getCatFileName($catNumber));
        $items = require F72X::getCatalogoSunatDir() . "/$fileName.php";
        self::$_CAT['CAT_' . $catNumber] = $items;
        return $items;
    }

    private static function getCatFileName($catNumeber) {
        return 'cat_' . str_pad($catNumeber, 2, '0', STR_PAD_LEFT);
    }

    public static function getCurrencyPlural($currencyCode) {
        $currencies = self::getCustomList('currencies');
        if (isset($currencies[$currencyCode])) {
            return $currencies[$currencyCode];
        }
        throw new ConfigException("El código de moneda $currencyCode aún no ha sido configurado para su uso.");
    }

    public static function getUnitName($unitCode) {
        return self::getCustomListItem('unitcode', $unitCode);
    }

    public static function getCustomListItem($listName, $itemId) {
        $customList = self::getCustomList($listName);
        if (isset($customList[$itemId])) {
            return $customList[$itemId];
        }
        throw new ConfigException("El codigó de item '$itemId' no existe en la lista $listName");
    }

    public static function getCustomList($listName) {
        // returns from cache
        if (isset(self::$_LIST['LIST_' . $listName])) {
            return self::$_LIST['LIST_' . $listName];
        }
        // Company customization
        $customListsPath = Company::getListsPath();
        $fileName = "$customListsPath/$listName.php";
        if (file_exists($fileName)) {
            $customListsPath = Company::getListsPath();
            $list = require $fileName;
            // Cache
            self::$_CAT['LIST_' . $listName] = $list;
            return $list;
        }
        // Defaults
        $defaultListsPath = F72X::getDefaultListsPath();
        $fileName2 = "$defaultListsPath/$listName.php";
        $list = require $fileName2;
        // Cache
        self::$_CAT['LIST_' . $listName] = $list;
        return $list;
    }

    public static function getAllCatNumbers() {
        $catNumbers = [];
        for ($i = 1; $i <= 3; $i++) {
            $catNumbers[] = $i;
        }
        for ($i = 5; $i <= 9; $i++) {
            $catNumbers[] = $i;
        }
        for ($i = 10; $i <= 11; $i++) {
            $catNumbers[] = $i;
        }
        for ($i = 13; $i <= 27; $i++) {
            $catNumbers[] = $i;
        }
        for ($i = 51; $i <= 59; $i++) {
            $catNumbers[] = $i;
        }
        return $catNumbers;
    }

}


1			<?php
2
3			/**
4			* MÓDULO DE EMISIÓN ELECTRÓNICA F72X
5			* UBL 2.1
6			* Version 1.0
7			*
8			* Copyright 2019, Jaime Cruz
9			*/
10
11			namespace F72X\Sunat;
12
13			use InvalidArgumentException;
14			use F72X\F72X;
15			use F72X\Company;
16			use F72X\Exception\ConfigException;
17
18			class Catalogo {
19
20			const CAT_TAX_DOCUMENT_TYPE = 1;
21			const CAT_CURRENCY_TYPE = 2;
22			const CAT_MEASUREMENT_UNIT = 3;
23			const CAT_COUNTRY_CODE = 4;
24			const CAT_TAX_TYPE = 5;
25			const CAT_IDENT_DOCUMENT_TYPE = 6;
26			const CAT_IGV_AFFECTATION_TYPE = 7;
27			const CAT_ISC_CALC_SYSTEM_TYPE = 8;
28			const CAT_NOTA_CREDITO_TYPE = 9;
29			const CAT_NOTA_DEBITO_TYPE = 10;
30			const CAT_PERCEPCION_REGIME = 22;
31			const CAT_RETENCION_REGIME = 23;
32			const CAT_FACTURA_TYPE = 51;
33
34			/** @CAT1 Código tipo de documento */
35			const DOCTYPE_FACTURA = '01';
36			const DOCTYPE_BOLETA = '03';
37			const DOCTYPE_NOTA_CREDITO = '07';
38			const DOCTYPE_NOTA_DEBITO = '08';
39			const DOCTYPE_VOUCHER = '12';
40			const DOCTYPE_SC_FACTURA = 'FAC';
41			const DOCTYPE_SC_BOLETA = 'BOL';
42			const DOCTYPE_SC_NOTA_CREDITO = 'NCR';
43			const DOCTYPE_SC_NOTA_DEBITO = 'NDE';
44
45			/** @CAT5 Tipo de impuesto */
46			const CAT5_IGV = '1000';
47			const CAT5_IVAP = '1016';
48			const CAT5_ISC = '2000';
49			const CAT5_EXP = '9995';
50			const CAT5_GRA = '9996';
51			const CAT5_EXO = '9997';
52			const CAT5_INA = '9998';
53			const CAT5_OTROS = '9999';
54
55			/** @CAT7 Tipo de afectación del IGV */
56			const CAT7_GRA_IGV = '10';
57
58			/** @CAT16 Tipo de precio */
59			const CAT16_UNITARY_PRICE = '01';
60			const CAT16_REF_VALUE = '02';
61
62			/** @CAT6 */
63			const IDENTIFICATION_DOC_DNI = '1';
64			const IDENTIFICATION_DOC_RUC = '6';
65
66			private static $_CAT = [];
67			private static $_LIST = [];
68
69			/**
70			*
71			* @param string $documentType 01\|03\|07\|08
72			* @param string $affectedDocumentType 01\|03
73			* @return string F\|B
74			*/
75			public static function getDocumentSeriesPrefix($documentType, $affectedDocumentType = null) {
76			if ($documentType == self::DOCTYPE_FACTURA) {
77			return 'F';
78			}
79			if ($documentType == self::DOCTYPE_BOLETA) {
80			return 'B';
81			}
82			if ($documentType == self::DOCTYPE_NOTA_CREDITO) {
83			return self::getDocumentSeriesPrefix($affectedDocumentType);
84			}
85			if ($documentType == self::DOCTYPE_NOTA_DEBITO) {
86			return self::getDocumentSeriesPrefix($affectedDocumentType);
87			}
88			if ($documentType == self::DOCTYPE_VOUCHER) {
89			throw new InvalidArgumentException("Error: Cash register ticket isn't supported yet.");
90			}
91			throw new InvalidArgumentException("Error: $documentType isn't a valid document type");
92			}
93
94			/**
95			*
96			* @param string $documentType 01\|03\|07\|08
97			* @return string FACTURA\|BOLETA\|NOTA DE CRÉDITO\|NOTA DE DÉBITO
98			*/
99			public static function getOfficialDocumentName($documentType) {
100			switch ($documentType) {
101			case self::DOCTYPE_FACTURA : return 'FACTURA';
102			case self::DOCTYPE_BOLETA : return 'BOLETA DE VENTA';
103			case self::DOCTYPE_NOTA_CREDITO : return 'NOTA DE CRÉDITO';
104			case self::DOCTYPE_NOTA_DEBITO : return 'NOTA DE DÉBITO';
105			}
106			throw new InvalidArgumentException("Error: $documentType isn't a valid document type");
107			}
108
109			/**
110			*
111			* @param string $shortCode BOL\|FAC\|NCR\|NDE
112			* @return string 01\|03\|07\|08
113			*/
114			public static function getDocumentType($shortCode) {
115			switch ($shortCode) {
116			case self::DOCTYPE_SC_FACTURA: return self::DOCTYPE_FACTURA;
117			case self::DOCTYPE_SC_BOLETA: return self::DOCTYPE_BOLETA;
118			case self::DOCTYPE_SC_NOTA_CREDITO: return self::DOCTYPE_NOTA_CREDITO;
119			case self::DOCTYPE_SC_NOTA_DEBITO: return self::DOCTYPE_NOTA_DEBITO;
120			}
121			throw new InvalidArgumentException("Error: $shortCode isn't valid short code use (BOL\|FAC\|NCR\|NDE)");
122			}
123
124			/**
125			*
126			* @param string $docType 01\|03\|07\|08
127			* @return string BOL\|FAC\|NCR\|NDE
128			*/
129			public static function getDocumentShortCode($docType) {
130			switch ($docType) {
131			case self::DOCTYPE_FACTURA: return self::DOCTYPE_SC_FACTURA;
132			case self::DOCTYPE_BOLETA: return self::DOCTYPE_SC_BOLETA;
133			case self::DOCTYPE_NOTA_CREDITO: return self::DOCTYPE_SC_NOTA_CREDITO;
134			case self::DOCTYPE_NOTA_DEBITO: return self::DOCTYPE_SC_NOTA_DEBITO;
135			}
136			throw new InvalidArgumentException("Error: $docType isn't valid document type use (01\|03\|07\|08)");
137			}
138
139			public static function itemExist($catNumber, $itemID) {
140			$items = self::getCatItems($catNumber);
141			return key_exists($itemID, $items);
142			}
143
144			/**
145			* Valor de item de catálogo
146			* @param int $catNumber
147			* @param string $itemID
148			* @return string
149			* @throws InvalidArgumentException cuando el item no existe en el catálogo.
150			*/
151			public static function getCatItemValue($catNumber, $itemID) {
152			$item = self::getCatItem($catNumber, $itemID);
153			if ($item) {
154			return $item['value'];
155			}
156			throw new InvalidArgumentException("Catálogo Error, no existe un item con ID='$itemID' en el cátalogo='$catNumber'");
157			}
158
159			/**
160			* Valor de item de catálogo
161			* @param int $catNumber
162			* @param string $itemID
163			* @return string
164			* @throws InvalidArgumentException cuando el item no existe en el catálogo.
165			*/
166			public static function getCatItemFieldValue($catNumber, $itemID, $field) {
167			$item = self::getCatItem($catNumber, $itemID);
168			if ($item) {
169			if(isset($item[$field])){
170			return $item[$field];
171			}
172			throw new InvalidArgumentException("Catálogo Error, no existe el campo '$field' en el cátalogo='$catNumber'");
173			}
174			throw new InvalidArgumentException("Catálogo Error, no existe un item con ID='$itemID' en el cátalogo='$catNumber'");
175			}
176
177			public static function getCatItem($catNumber, $itemID, $key = 'id') {
178			$items = self::getCatItems($catNumber);
179			foreach ($items as $item) {
180			if ($item[$key] === strval($itemID)) {
181			return $item;
182			}
183			}
184			return null;
185			}
186
187			public static function getCatItems($catNumber, $useXmlFiles = false) {
188			// returns from cache
189			if (isset(self::$_CAT['CAT_' . $catNumber])) {
190			return self::$_CAT['CAT_' . $catNumber];
191			}
192			// Load from file
193			$fileName = strtoupper(self::getCatFileName($catNumber));
194			$items = require F72X::getCatalogoSunatDir() . "/$fileName.php";
195			self::$_CAT['CAT_' . $catNumber] = $items;
196			return $items;
197			}
198
199			private static function getCatFileName($catNumeber) {
200			return 'cat_' . str_pad($catNumeber, 2, '0', STR_PAD_LEFT);
201			}
202
203			public static function getCurrencyPlural($currencyCode) {
204			$currencies = self::getCustomList('currencies');
205			if (isset($currencies[$currencyCode])) {
206			return $currencies[$currencyCode];
207			}
208			throw new ConfigException("El código de moneda $currencyCode aún no ha sido configurado para su uso.");
209			}
210
211			public static function getUnitName($unitCode) {
212			return self::getCustomListItem('unitcode', $unitCode);
213			}
214
215			public static function getCustomListItem($listName, $itemId) {
216			$customList = self::getCustomList($listName);
217			if (isset($customList[$itemId])) {
218			return $customList[$itemId];
219			}
220			throw new ConfigException("El codigó de item '$itemId' no existe en la lista $listName");
221			}
222
223			public static function getCustomList($listName) {
224			// returns from cache
225			if (isset(self::$_LIST['LIST_' . $listName])) {
226			return self::$_LIST['LIST_' . $listName];
227			}
228			// Company customization
229			$customListsPath = Company::getListsPath();
230			$fileName = "$customListsPath/$listName.php";
231			if (file_exists($fileName)) {
232			$customListsPath = Company::getListsPath();
233			$list = require $fileName;
234			// Cache
235			self::$_CAT['LIST_' . $listName] = $list;
236			return $list;
237			}
238			// Defaults
239			$defaultListsPath = F72X::getDefaultListsPath();
240			$fileName2 = "$defaultListsPath/$listName.php";
241			$list = require $fileName2;
242			// Cache
243			self::$_CAT['LIST_' . $listName] = $list;
244			return $list;
245			}
246
247			public static function getAllCatNumbers() {
248			$catNumbers = [];
249			for ($i = 1; $i <= 3; $i++) {
250			$catNumbers[] = $i;
251			}
252			for ($i = 5; $i <= 9; $i++) {
253			$catNumbers[] = $i;
254			}
255			for ($i = 10; $i <= 11; $i++) {
256			$catNumbers[] = $i;
257			}
258			for ($i = 13; $i <= 27; $i++) {
259			$catNumbers[] = $i;
260			}
261			for ($i = 51; $i <= 59; $i++) {
262			$catNumbers[] = $i;
263			}
264			return $catNumbers;
265			}
266
267			}
268

jDelta / F72X

Push — master ( c55034...101a53 )

Catalogo::getAllCatNumbers() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like