DataMap::__construct() - Code Metrics - Inspection of "Generates:" - jDelta/F72X - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — develop (477450)

by JAIME ELMER

created 2018-10-31 11:56 UTC

DataMap::__construct() A

↳ Parent: DataMap

Complexity

Conditions	1
Paths	1

Size

Total Lines	22
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	19
nc	1
nop	2
dl	0
loc	22
rs	9.6333
c	0
b	0
f	0

<?php

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

namespace F72X\Sunat;

use DateTime;
use F72X\Company;
use F72X\Sunat\Catalogo;
/**
 * DataMap
 * 
 * Esta clase es una representación interna de una factura o boleta, la cual se
 * encarga de aplicar toda la logica de negocio en cuanto a cálculos de tributos
 * y totales
 * 
 */
class DataMap {

    private $_rawData;
    private $documentType;
    private $currencyCode;
    private $invoiceId;
    private $documentName;
    private $documentSeries;
    private $documentNumber;

    /** @var DateTime */
    private $issueDate;

    /** @var DateTime */
    protected $DueDate;
    private $operationType;
    private $customerDocType;
    private $customerDocNumber;
    private $customerRegName;
    private $customerAddress;
    private $purchaseOrder;

    /** @var InvoiceItems */
    private $_items;
    private $_rawItems;
    private $allowancesAndCharges = [];

    /** NOTES FIELDS */
    private $noteType;
    private $noteDescription;
    private $noteAffectedDocType;
    private $noteAffectedDocId;
    /**
     * 
     * @param array $data
     * @param string $type 01|03|07|08
     */
    public function __construct(array $data, $type) {
        // Items
        $items = new InvoiceItems();
        $items->populate($data['items'], $data['currencyCode']);

        $this->_rawData  = $data;
        $this->_rawItems = $data['items'];
        $this->setDefaults($data);
        $this->currencyCode         = $data['currencyCode'];
        $this->documentType         = $type;
        $this->documentSeries       = $data['documentSeries'];
        $this->documentNumber       = str_pad($data['documentNumber'], 8, '0', STR_PAD_LEFT);
        $this->documentName         = Catalogo::getDocumentName($type);
        $this->invoiceId            = $this->documentSeries . '-' . $this->documentNumber;
        $this->issueDate            = new DateTime($data['issueDate']);
        $this->customerDocType      = $data['customerDocType'];
        $this->customerDocNumber    = $data['customerDocNumber'];
        $this->customerRegName      = mb_strtoupper($data['customerRegName']);
        $this->customerAddress      = mb_strtoupper($data['customerAddress']);
        $this->_items               = $items;
        $this->allowancesAndCharges = $data['allowancesCharges'];
        $this->setSpecificFields($data, $type);
    }

    private function setSpecificFields(array $data, $type) {
        if (in_array($type, [Catalogo::DOCTYPE_FACTURA, Catalogo::DOCTYPE_BOLETA])) {
            $this->operationType        = $data['operationType'];
            $this->purchaseOrder        = $data['purchaseOrder'];
        }else{
            
            $this->noteType            = $data['type'];
            $this->noteDescription     = $data['description'];
            $this->noteAffectedDocType = $data['affectedDocType'];
            $this->noteAffectedDocId   = $data['affectedDocId'];
        }
    }

    private function setDefaults(array &$data) {
        $data['allowancesCharges'] = isset($data['allowancesCharges']) ? $data['allowancesCharges'] : [];
        $data['purchaseOrder'] = isset($data['purchaseOrder']) ? $data['purchaseOrder'] : null;
    }
    public function getNoteType() {
        return $this->noteType;
    }

    public function getNoteDescription() {
        return $this->noteDescription;
    }

    public function getNoteAffectedDocType() {
        return $this->noteAffectedDocType;
    }

    public function getNoteAffectedDocId() {
        return $this->noteAffectedDocId;
    }

    public function getInvoiceId() {
        return $this->invoiceId;
    }

    public function getRawData() {
        return $this->_rawData;
    }

    /**
     * Boleta o Factura @CAT1
     * @return string
     */
    public function getDocumentType() {
        return $this->documentType;
    }

    public function getCurrencyCode() {
        return $this->currencyCode;
    }

    public function getDocumentName() {
        return $this->documentName;
    }

    public function getDocumentSeries() {
        return $this->documentSeries;
    }

    public function setDocumentSeries($documentSeries) {
        $this->documentSeries = $documentSeries;
        return $this;
    }

    public function getDocumentNumber() {
        return $this->documentNumber;
    }

    public function setDocumentNumber($documentNumber) {
        $this->documentNumber = $documentNumber;
        return $this;
    }

    public function getIssueDate() {
        return $this->issueDate;
    }

    public function setIssueDate(DateTime $IssueDate) {
        $this->issueDate = $IssueDate;
        return $this;
    }

    public function getDueDate() {
        return $this->DueDate;
    }

    public function setDueDate(DateTime $DueDate) {
        $this->DueDate = $DueDate;
        return $this;
    }

    public function getOperationType() {
        return $this->operationType;
    }

    public function setOperationType($operationType) {
        $this->operationType = $operationType;
        return $this;
    }

    public function getCustomerDocType() {
        return $this->customerDocType;
    }

    public function setCustomerDocType($customerDocType) {
        $this->customerDocType = $customerDocType;
        return $this;
    }

    public function getCustomerDocNumber() {
        return $this->customerDocNumber;
    }

    public function setCustomerDocNumber($customerDocNumber) {
        $this->customerDocNumber = $customerDocNumber;
        return $this;
    }

    public function getCustomerRegName() {
        return $this->customerRegName;
    }

    public function setCustomerRegName($customerRegName) {
        $this->customerRegName = $customerRegName;
        return $this;
    }
    public function getCustomerAddress() {
        return $this->customerAddress;
    }

    public function setCustomerAddress($customerAddress) {
        $this->customerAddress = $customerAddress;
        return $this;
    }

    public function getPurchaseOrder() {
        return $this->purchaseOrder;
    }

    public function setPurchaseOrder($purchaseOrder) {
        $this->purchaseOrder = $purchaseOrder;
        return $this;
    }

    /**
     * 
     * @return InvoiceItems
     */
    public function getItems() {
        return $this->_items;
    }

    /**
     * Numero de items del documento
     * @return int
     */
    public function getTotalItems() {
        return $this->_items->getCount();
    }

    public function getRawItems() {
        return $this->_rawItems;
    }

    public function getAllowancesAndCharges() {
        return $this->allowancesAndCharges;
    }

    public function setAllowancesAndCharges($allowancesAndCharges) {
        $this->allowancesAndCharges = $allowancesAndCharges;
        return $this;
    }

    /**
     * Base imponible
     * 
     * Formula = SUM(BASE_IMPONIBLE_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
     * 
     * @return float
     */
    public function getTaxableAmount() {
        $totalItems = $this->_items->getTotalTaxableOperations();
        return $this->applyAllowancesAndCharges($totalItems);
    }

    /**
     * Monto con impuestos
     * 
     * Formula = BASE_IMPONIBLE + IGV
     * 
     * @return float
     */
    public function getTaxedAmount() {
        $totalTaxableAmount = $this->getTaxableAmount();
        $totalIgv = $this->getIGV();
        return $totalTaxableAmount + $totalIgv;
    }

    /**
     * Total operaciones gravadas
     * @return float
     */
    public function getTotalTaxableOperations() {
        return $this->getTaxableAmount();
    }

    /**
     * Total operaciones gratuitas
     * @return float
     */
    public function getTotalFreeOperations() {
        return $this->_items->getTotalFreeOperations();
    }

    /**
     * Total operationes exoneradas
     * 
     * Formula = SUM(EXEMPTED_OPERATIONS_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
     * 
     * @return float
     */
    public function getTotalExemptedOperations() {
        $totalItems = $this->_items->getTotalExemptedOperations();
        return $this->applyAllowancesAndCharges($totalItems);
    }

    /**
     * Total operaciones inafectas
     * @return float
     */
    public function getTotalUnaffectedOperations() {
        $totalItems = $this->_items->getTotalUnaffectedOperations();
        return $this->applyAllowancesAndCharges($totalItems);
    }

    /**
     * Valor de venta
     * 
     * Valor total de la factura sin considerar descuentos impuestos u otros tributos
     * @return float
     */
    public function getBillableValue() {
        return $this->_items->getTotalBillableValue();
    }

    /**
     * Total descuentos
     * 
     * Formula: SUM(DESCUENTOS_X_ITEM) + DESCUENTOS_GLOBALES
     * @return float
     */
    public function getTotalAllowances() {
        $totalItems = $this->_items->getTotalAllowances();
        $totalTaxableAmountItems = $this->_items->getTotalTaxableAmount();
        $globalAllowancesAmount = Operations::getTotalAllowances($totalTaxableAmountItems, $this->allowancesAndCharges);
        return $totalItems + $globalAllowancesAmount;
    }

    /**
     * Total a pagar
     * 
     * El importe que el usuario está obligado a pagar
     * 
     * Formula = OPERACIONES_GRAVADAS + IGV + OPERACIONES_EXONERADAS + OPERACIONES_INAFECTAS
     * 
     * @return float
     */
    public function getPayableAmount() {
        // Totals
        $totalTaxableOperations = $this->getTotalTaxableOperations();
        $totalIGV = $this->getIGV();
        $totalExemptedOperations = $this->getTotalExemptedOperations();
        return $totalTaxableOperations + $totalIGV + $totalExemptedOperations;
    }

    /**
     * 
     * Total impuestos
     * 
     * Fórmula: IGV + ISC + IVAP
     * 
     * @return float
     */
    public function getTotalTaxes() {
        $IGV = $this->getIGV();
        $ISC = $this->getISC();
        $IVAP = $this->getIVAP();
        return $IGV + $ISC + $IVAP;
    }

    /**
     * IGV
     * @return float
     */
    public function getIGV() {
        $baseAmount = $this->getTaxableAmount();
        return Operations::calcIGV($baseAmount);
    }

    /**
     * ISC
     * @IMP
     * @return float
     */
    public function getISC() {
        return Operations::calcISC();
    }

    /**
     * IVAP
     * @IMP
     * @return float
     */
    public function getIVAP() {
        return Operations::calcIVAP();
    }

    /**
     * 
     * @param float $amount
     * @return float
     */
    private function applyAllowancesAndCharges($amount) {
        return Operations::applyAllowancesAndCharges($amount, $this->allowancesAndCharges);
    }
    public function getBillName() {
        return Company::getRUC() . '-' . $this->documentType . '-' . $this->invoiceId;
    }
}


1			<?php
2
3			/**
4			* MÓDULO DE EMISIÓN ELECTRÓNICA F72X
5			* UBL 2.1
6			* Version 1.1
7			*
8			* Copyright 2018, Jaime Cruz
9			*/
10
11			namespace F72X\Sunat;
12
13			use DateTime;
14			use F72X\Company;
15			use F72X\Sunat\Catalogo;
16			/**
17			* DataMap
18			*
19			* Esta clase es una representación interna de una factura o boleta, la cual se
20			* encarga de aplicar toda la logica de negocio en cuanto a cálculos de tributos
21			* y totales
22			*
23			*/
24			class DataMap {
25
26			private $_rawData;
27			private $documentType;
28			private $currencyCode;
29			private $invoiceId;
30			private $documentName;
31			private $documentSeries;
32			private $documentNumber;
33
34			/** @var DateTime */
35			private $issueDate;
36
37			/** @var DateTime */
38			protected $DueDate;
39			private $operationType;
40			private $customerDocType;
41			private $customerDocNumber;
42			private $customerRegName;
43			private $customerAddress;
44			private $purchaseOrder;
45
46			/** @var InvoiceItems */
47			private $_items;
48			private $_rawItems;
49			private $allowancesAndCharges = [];
50
51			/** NOTES FIELDS */
52			private $noteType;
53			private $noteDescription;
54			private $noteAffectedDocType;
55			private $noteAffectedDocId;
56			/**
57			*
58			* @param array $data
59			* @param string $type 01\|03\|07\|08
60			*/
61			public function __construct(array $data, $type) {
62			// Items
63			$items = new InvoiceItems();
64			$items->populate($data['items'], $data['currencyCode']);
65
66			$this->_rawData = $data;
67			$this->_rawItems = $data['items'];
68			$this->setDefaults($data);
69			$this->currencyCode = $data['currencyCode'];
70			$this->documentType = $type;
71			$this->documentSeries = $data['documentSeries'];
72			$this->documentNumber = str_pad($data['documentNumber'], 8, '0', STR_PAD_LEFT);
73			$this->documentName = Catalogo::getDocumentName($type);
74			$this->invoiceId = $this->documentSeries . '-' . $this->documentNumber;
75			$this->issueDate = new DateTime($data['issueDate']);
76			$this->customerDocType = $data['customerDocType'];
77			$this->customerDocNumber = $data['customerDocNumber'];
78			$this->customerRegName = mb_strtoupper($data['customerRegName']);
79			$this->customerAddress = mb_strtoupper($data['customerAddress']);
80			$this->_items = $items;
81			$this->allowancesAndCharges = $data['allowancesCharges'];
82			$this->setSpecificFields($data, $type);
83			}
84
85			private function setSpecificFields(array $data, $type) {
86			if (in_array($type, [Catalogo::DOCTYPE_FACTURA, Catalogo::DOCTYPE_BOLETA])) {
87			$this->operationType = $data['operationType'];
88			$this->purchaseOrder = $data['purchaseOrder'];
89			}else{
90
91			$this->noteType = $data['type'];
92			$this->noteDescription = $data['description'];
93			$this->noteAffectedDocType = $data['affectedDocType'];
94			$this->noteAffectedDocId = $data['affectedDocId'];
95			}
96			}
97
98			private function setDefaults(array &$data) {
99			$data['allowancesCharges'] = isset($data['allowancesCharges']) ? $data['allowancesCharges'] : [];
100			$data['purchaseOrder'] = isset($data['purchaseOrder']) ? $data['purchaseOrder'] : null;
101			}
102			public function getNoteType() {
103			return $this->noteType;
104			}
105
106			public function getNoteDescription() {
107			return $this->noteDescription;
108			}
109
110			public function getNoteAffectedDocType() {
111			return $this->noteAffectedDocType;
112			}
113
114			public function getNoteAffectedDocId() {
115			return $this->noteAffectedDocId;
116			}
117
118			public function getInvoiceId() {
119			return $this->invoiceId;
120			}
121
122			public function getRawData() {
123			return $this->_rawData;
124			}
125
126			/**
127			* Boleta o Factura @CAT1
128			* @return string
129			*/
130			public function getDocumentType() {
131			return $this->documentType;
132			}
133
134			public function getCurrencyCode() {
135			return $this->currencyCode;
136			}
137
138			public function getDocumentName() {
139			return $this->documentName;
140			}
141
142			public function getDocumentSeries() {
143			return $this->documentSeries;
144			}
145
146			public function setDocumentSeries($documentSeries) {
147			$this->documentSeries = $documentSeries;
148			return $this;
149			}
150
151			public function getDocumentNumber() {
152			return $this->documentNumber;
153			}
154
155			public function setDocumentNumber($documentNumber) {
156			$this->documentNumber = $documentNumber;
157			return $this;
158			}
159
160			public function getIssueDate() {
161			return $this->issueDate;
162			}
163
164			public function setIssueDate(DateTime $IssueDate) {
165			$this->issueDate = $IssueDate;
166			return $this;
167			}
168
169			public function getDueDate() {
170			return $this->DueDate;
171			}
172
173			public function setDueDate(DateTime $DueDate) {
174			$this->DueDate = $DueDate;
175			return $this;
176			}
177
178			public function getOperationType() {
179			return $this->operationType;
180			}
181
182			public function setOperationType($operationType) {
183			$this->operationType = $operationType;
184			return $this;
185			}
186
187			public function getCustomerDocType() {
188			return $this->customerDocType;
189			}
190
191			public function setCustomerDocType($customerDocType) {
192			$this->customerDocType = $customerDocType;
193			return $this;
194			}
195
196			public function getCustomerDocNumber() {
197			return $this->customerDocNumber;
198			}
199
200			public function setCustomerDocNumber($customerDocNumber) {
201			$this->customerDocNumber = $customerDocNumber;
202			return $this;
203			}
204
205			public function getCustomerRegName() {
206			return $this->customerRegName;
207			}
208
209			public function setCustomerRegName($customerRegName) {
210			$this->customerRegName = $customerRegName;
211			return $this;
212			}
213			public function getCustomerAddress() {
214			return $this->customerAddress;
215			}
216
217			public function setCustomerAddress($customerAddress) {
218			$this->customerAddress = $customerAddress;
219			return $this;
220			}
221
222			public function getPurchaseOrder() {
223			return $this->purchaseOrder;
224			}
225
226			public function setPurchaseOrder($purchaseOrder) {
227			$this->purchaseOrder = $purchaseOrder;
228			return $this;
229			}
230
231			/**
232			*
233			* @return InvoiceItems
234			*/
235			public function getItems() {
236			return $this->_items;
237			}
238
239			/**
240			* Numero de items del documento
241			* @return int
242			*/
243			public function getTotalItems() {
244			return $this->_items->getCount();
245			}
246
247			public function getRawItems() {
248			return $this->_rawItems;
249			}
250
251			public function getAllowancesAndCharges() {
252			return $this->allowancesAndCharges;
253			}
254
255			public function setAllowancesAndCharges($allowancesAndCharges) {
256			$this->allowancesAndCharges = $allowancesAndCharges;
257			return $this;
258			}
259
260			/**
261			* Base imponible
262			*
263			* Formula = SUM(BASE_IMPONIBLE_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
264			*
265			* @return float
266			*/
267			public function getTaxableAmount() {
268			$totalItems = $this->_items->getTotalTaxableOperations();
269			return $this->applyAllowancesAndCharges($totalItems);
270			}
271
272			/**
273			* Monto con impuestos
274			*
275			* Formula = BASE_IMPONIBLE + IGV
276			*
277			* @return float
278			*/
279			public function getTaxedAmount() {
280			$totalTaxableAmount = $this->getTaxableAmount();
281			$totalIgv = $this->getIGV();
282			return $totalTaxableAmount + $totalIgv;
283			}
284
285			/**
286			* Total operaciones gravadas
287			* @return float
288			*/
289			public function getTotalTaxableOperations() {
290			return $this->getTaxableAmount();
291			}
292
293			/**
294			* Total operaciones gratuitas
295			* @return float
296			*/
297			public function getTotalFreeOperations() {
298			return $this->_items->getTotalFreeOperations();
299			}
300
301			/**
302			* Total operationes exoneradas
303			*
304			* Formula = SUM(EXEMPTED_OPERATIONS_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
305			*
306			* @return float
307			*/
308			public function getTotalExemptedOperations() {
309			$totalItems = $this->_items->getTotalExemptedOperations();
310			return $this->applyAllowancesAndCharges($totalItems);
311			}
312
313			/**
314			* Total operaciones inafectas
315			* @return float
316			*/
317			public function getTotalUnaffectedOperations() {
318			$totalItems = $this->_items->getTotalUnaffectedOperations();
319			return $this->applyAllowancesAndCharges($totalItems);
320			}
321
322			/**
323			* Valor de venta
324			*
325			* Valor total de la factura sin considerar descuentos impuestos u otros tributos
326			* @return float
327			*/
328			public function getBillableValue() {
329			return $this->_items->getTotalBillableValue();
330			}
331
332			/**
333			* Total descuentos
334			*
335			* Formula: SUM(DESCUENTOS_X_ITEM) + DESCUENTOS_GLOBALES
336			* @return float
337			*/
338			public function getTotalAllowances() {
339			$totalItems = $this->_items->getTotalAllowances();
340			$totalTaxableAmountItems = $this->_items->getTotalTaxableAmount();
341			$globalAllowancesAmount = Operations::getTotalAllowances($totalTaxableAmountItems, $this->allowancesAndCharges);
342			return $totalItems + $globalAllowancesAmount;
343			}
344
345			/**
346			* Total a pagar
347			*
348			* El importe que el usuario está obligado a pagar
349			*
350			* Formula = OPERACIONES_GRAVADAS + IGV + OPERACIONES_EXONERADAS + OPERACIONES_INAFECTAS
351			*
352			* @return float
353			*/
354			public function getPayableAmount() {
355			// Totals
356			$totalTaxableOperations = $this->getTotalTaxableOperations();
357			$totalIGV = $this->getIGV();
358			$totalExemptedOperations = $this->getTotalExemptedOperations();
359			return $totalTaxableOperations + $totalIGV + $totalExemptedOperations;
360			}
361
362			/**
363			*
364			* Total impuestos
365			*
366			* Fórmula: IGV + ISC + IVAP
367			*
368			* @return float
369			*/
370			public function getTotalTaxes() {
371			$IGV = $this->getIGV();
372			$ISC = $this->getISC();
373			$IVAP = $this->getIVAP();
374			return $IGV + $ISC + $IVAP;
375			}
376
377			/**
378			* IGV
379			* @return float
380			*/
381			public function getIGV() {
382			$baseAmount = $this->getTaxableAmount();
383			return Operations::calcIGV($baseAmount);
384			}
385
386			/**
387			* ISC
388			* @IMP
389			* @return float
390			*/
391			public function getISC() {
392			return Operations::calcISC();
393			}
394
395			/**
396			* IVAP
397			* @IMP
398			* @return float
399			*/
400			public function getIVAP() {
401			return Operations::calcIVAP();
402			}
403
404			/**
405			*
406			* @param float $amount
407			* @return float
408			*/
409			private function applyAllowancesAndCharges($amount) {
410			return Operations::applyAllowancesAndCharges($amount, $this->allowancesAndCharges);
411			}
412			public function getBillName() {
413			return Company::getRUC() . '-' . $this->documentType . '-' . $this->invoiceId;
414			}
415			}
416

jDelta / F72X

Branch — develop (477450)

DataMap::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like