InvoiceDocument::getTotalFreeOperations() - Code Metrics - Inspection of "Lot of progress" - jDelta/F72X - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( d3c8d8...d4fc42 )

by JAIME ELMER

created 2018-10-05 02:18 UTC

InvoiceDocument::getTotalFreeOperations() A

↳ Parent: InvoiceDocument

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
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;

/**
 * InvoiceDocument
 * 
 * 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 InvoiceDocument {

    const BOLETA_PREFIX = 'B';
    const FACTURA_PREFIX = 'F';

    private $_rawData;
    private $invoiceType;
    private $currencyType;
    private $voucherId;
    private $voucherIdPrefix;
    private $voucherSeries;
    private $voucherNumber;

    /** @var DateTime */

    private $issueDate;

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

    /** @var InvoiceItems */
    private $_items;
    private $_rawItems;
    private $allowances;
    private $charges;

    /**
     * 
     * @param array $data
     * @param string $type Catalogo::CAT1_BOLETA|Catalogo::CAT1_FACTURA
     * @param string $currencyType
     */
    public function __construct(array $data, $type, $currencyType = 'PEN') {
        // Items
        $items = new InvoiceItems();
        $items->populate($data['items'], $currencyType);

        $this->_rawData = $data;
        $this->_rawItems = $data['items'];
        $this->addDefaults($data);
        $this->currencyType = $currencyType;
        $this->voucherSeries = $data['voucherSeries'];
        $this->voucherNumber = $data['voucherNumber'];
        // requires voucherSeries and voucherNumber
        $this->setTypeProperties($type);
        $this->issueDate = $data['issueDate'];
        $this->purchaseOrder = $data['purchaseOrder'];
        $this->operationType = $data['operationType'];
        $this->customerDocType = $data['customerDocType'];
        $this->customerDocNumber = $data['customerDocNumber'];
        $this->customerRegName = mb_strtoupper($data['customerRegName']);
        $this->_items = $items;
        $this->allowances = $data['allowances'];
        $this->charges = $data['charges'];
    }

    private function addDefaults(array &$data) {
        $data['allowances'] = isset($data['allowances']) ? $data['allowances'] : [];
        $data['charges']    = isset($data['charges']) ? $data['charges'] : [];
        $data['issueDate']  = isset($data['issueDate']) ? $data['issueDate'] : new DateTime();
        $data['purchaseOrder'] = isset($data['purchaseOrder']) ? $data['purchaseOrder'] : null;
    }

    private function setTypeProperties($type) {
        $this->invoiceType = $type;
        if ($type === Catalogo::CAT1_BOLETA) {
            $this->voucherIdPrefix = self::BOLETA_PREFIX;
        } else {
            $this->voucherIdPrefix = self::FACTURA_PREFIX;
        }
        $this->voucherId = $this->voucherIdPrefix . str_pad($this->voucherSeries, 3, '0', STR_PAD_LEFT) . '-' . str_pad($this->voucherNumber, 8, '0', STR_PAD_LEFT);
    }

    public function getVoucherId() {
        return $this->voucherId;
    }

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

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

    public function getCurrencyType() {
        return $this->currencyType;
    }

    public function getVoucherIdPrefix() {
        return $this->voucherIdPrefix;
    }

    public function getVoucherSeries() {
        return $this->voucherSeries;
    }

    public function setVoucherSeries($voucherSeries) {
        $this->voucherSeries = $voucherSeries;
        return $this;
    }

    public function getVoucherNumber() {
        return $this->voucherNumber;
    }

    public function setVoucherNumber($voucherNumber) {
        $this->voucherNumber = $voucherNumber;
        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 getPurchaseOrder() {
        return $this->purchaseOrder;
    }

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

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

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

    }

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

    public function getAllowances() {
        return $this->allowances;
    }

    public function setAllowances($allowances) {
        $this->allowances = $allowances;
        return $this;
    }

    public function getCharges() {
        return $this->charges;
    }

    public function setCharges($charges) {
        $this->charges = $charges;
        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::getTotalAllowanceCharge($totalTaxableAmountItems, $this->allowances);
        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->allowances, $this->charges);
    }

}


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			/**
14			* InvoiceDocument
15			*
16			* Esta clase es una representación interna de una factura o boleta, la cual se
17			* encarga de aplicar toda la logica de negocio en cuanto a cálculos de tributos
18			* y totales
19			*
20			*/
21			class InvoiceDocument {
22
23			const BOLETA_PREFIX = 'B';
24			const FACTURA_PREFIX = 'F';
25
26			private $_rawData;
27			private $invoiceType;
28			private $currencyType;
29			private $voucherId;
30			private $voucherIdPrefix;
31			private $voucherSeries;
32			private $voucherNumber;
33
34			/** @var DateTime */
			0 ignored issues – show Bug introduced 2018-10-05 02:20 UTC by Report Bug Copy Issue Report The type `F72X\Sunat\DateTime` was not found. Did you mean `DateTime`? If so, make sure to prefix the type with `\`. Loading history...
35			private $issueDate;
36
37			/** @var DateTime */
38			protected $DueDate;
39			private $operationType;
40			private $customerDocType;
41			private $customerDocNumber;
42			private $customerRegName;
43			private $purchaseOrder;
44
45			/** @var InvoiceItems */
46			private $_items;
47			private $_rawItems;
48			private $allowances;
49			private $charges;
50
51			/**
52			*
53			* @param array $data
54			* @param string $type Catalogo::CAT1_BOLETA\|Catalogo::CAT1_FACTURA
55			* @param string $currencyType
56			*/
57			public function __construct(array $data, $type, $currencyType = 'PEN') {
58			// Items
59			$items = new InvoiceItems();
60			$items->populate($data['items'], $currencyType);
61
62			$this->_rawData = $data;
63			$this->_rawItems = $data['items'];
64			$this->addDefaults($data);
65			$this->currencyType = $currencyType;
66			$this->voucherSeries = $data['voucherSeries'];
67			$this->voucherNumber = $data['voucherNumber'];
68			// requires voucherSeries and voucherNumber
69			$this->setTypeProperties($type);
70			$this->issueDate = $data['issueDate'];
71			$this->purchaseOrder = $data['purchaseOrder'];
72			$this->operationType = $data['operationType'];
73			$this->customerDocType = $data['customerDocType'];
74			$this->customerDocNumber = $data['customerDocNumber'];
75			$this->customerRegName = mb_strtoupper($data['customerRegName']);
76			$this->_items = $items;
77			$this->allowances = $data['allowances'];
78			$this->charges = $data['charges'];
79			}
80
81			private function addDefaults(array &$data) {
82			$data['allowances'] = isset($data['allowances']) ? $data['allowances'] : [];
83			$data['charges'] = isset($data['charges']) ? $data['charges'] : [];
84			$data['issueDate'] = isset($data['issueDate']) ? $data['issueDate'] : new DateTime();
85			$data['purchaseOrder'] = isset($data['purchaseOrder']) ? $data['purchaseOrder'] : null;
86			}
87
88			private function setTypeProperties($type) {
89			$this->invoiceType = $type;
90			if ($type === Catalogo::CAT1_BOLETA) {
91			$this->voucherIdPrefix = self::BOLETA_PREFIX;
92			} else {
93			$this->voucherIdPrefix = self::FACTURA_PREFIX;
94			}
95			$this->voucherId = $this->voucherIdPrefix . str_pad($this->voucherSeries, 3, '0', STR_PAD_LEFT) . '-' . str_pad($this->voucherNumber, 8, '0', STR_PAD_LEFT);
96			}
97
98			public function getVoucherId() {
99			return $this->voucherId;
100			}
101
102			public function getRawData() {
103			return $this->_rawData;
104			}
105
106			/**
107			* Boleta o Factura @CAT1
108			* @return string
109			*/
110			public function getInvoiceType() {
111			return $this->invoiceType;
112			}
113
114			public function getCurrencyType() {
115			return $this->currencyType;
116			}
117
118			public function getVoucherIdPrefix() {
119			return $this->voucherIdPrefix;
120			}
121
122			public function getVoucherSeries() {
123			return $this->voucherSeries;
124			}
125
126			public function setVoucherSeries($voucherSeries) {
127			$this->voucherSeries = $voucherSeries;
128			return $this;
129			}
130
131			public function getVoucherNumber() {
132			return $this->voucherNumber;
133			}
134
135			public function setVoucherNumber($voucherNumber) {
136			$this->voucherNumber = $voucherNumber;
137			return $this;
138			}
139
140			public function getIssueDate() {
141			return $this->issueDate;
142			}
143
144			public function setIssueDate(DateTime $IssueDate) {
145			$this->issueDate = $IssueDate;
146			return $this;
147			}
148
149			public function getDueDate() {
150			return $this->DueDate;
151			}
152
153			public function setDueDate(DateTime $DueDate) {
154			$this->DueDate = $DueDate;
155			return $this;
156			}
157
158			public function getOperationType() {
159			return $this->operationType;
160			}
161
162			public function setOperationType($operationType) {
163			$this->operationType = $operationType;
164			return $this;
165			}
166
167			public function getCustomerDocType() {
168			return $this->customerDocType;
169			}
170
171			public function setCustomerDocType($customerDocType) {
172			$this->customerDocType = $customerDocType;
173			return $this;
174			}
175
176			public function getCustomerDocNumber() {
177			return $this->customerDocNumber;
178			}
179
180			public function setCustomerDocNumber($customerDocNumber) {
181			$this->customerDocNumber = $customerDocNumber;
182			return $this;
183			}
184
185			public function getCustomerRegName() {
186			return $this->customerRegName;
187			}
188
189			public function setCustomerRegName($customerRegName) {
190			$this->customerRegName = $customerRegName;
191			return $this;
192			}
193
194			public function getPurchaseOrder() {
195			return $this->purchaseOrder;
196			}
197
198			public function setPurchaseOrder($purchaseOrder) {
199			$this->purchaseOrder = $purchaseOrder;
200			return $this;
201			}
202
203			/**
204			*
205			* @return InvoiceItems
206			*/
207			public function getItems() {
208			return $this->_items;
209			}
210
211			/**
212			*
213			* @return InvoiceItems
214			*/
215			public function getTotalItems() {
216			return $this->_items->getCount();
			0 ignored issues – show Bug Best Practice introduced 2018-10-05 02:20 UTC by Report Bug Copy Issue Report The expression `return $this->_items->getCount()` returns the type `integer` which is incompatible with the documented return type `F72X\Sunat\InvoiceItems`. Loading history...
217			}
218
219			public function getRawItems() {
220			return $this->_rawItems;
221			}
222
223			public function getAllowances() {
224			return $this->allowances;
225			}
226
227			public function setAllowances($allowances) {
228			$this->allowances = $allowances;
229			return $this;
230			}
231
232			public function getCharges() {
233			return $this->charges;
234			}
235
236			public function setCharges($charges) {
237			$this->charges = $charges;
238			return $this;
239			}
240
241			/**
242			* Base imponible
243			*
244			* Formula = SUM(BASE_IMPONIBLE_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
245			*
246			* @return float
247			*/
248			public function getTaxableAmount() {
249			$totalItems = $this->_items->getTotalTaxableOperations();
250			return $this->applyAllowancesAndCharges($totalItems);
251			}
252			/**
253			* Monto con impuestos
254			*
255			* Formula = BASE_IMPONIBLE + IGV
256			*
257			* @return float
258			*/
259			public function getTaxedAmount() {
260			$totalTaxableAmount = $this->getTaxableAmount();
261			$totalIgv = $this->getIGV();
262			return $totalTaxableAmount + $totalIgv;
263			}
264
265			/**
266			* Total operaciones gravadas
267			* @return float
268			*/
269			public function getTotalTaxableOperations() {
270			return $this->getTaxableAmount();
271			}
272			/**
273			* Total operaciones gratuitas
274			* @return float
275			*/
276			public function getTotalFreeOperations() {
277			return $this->_items->getTotalFreeOperations();
278			}
279
280			/**
281			* Total operationes exoneradas
282			*
283			* Formula = SUM(EXEMPTED_OPERATIONS_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
284			*
285			* @return float
286			*/
287			public function getTotalExemptedOperations() {
288			$totalItems = $this->_items->getTotalExemptedOperations();
289			return $this->applyAllowancesAndCharges($totalItems);
290			}
291
292			/**
293			* Total operaciones inafectas
294			* @return float
295			*/
296			public function getTotalUnaffectedOperations() {
297			$totalItems = $this->_items->getTotalUnaffectedOperations();
298			return $this->applyAllowancesAndCharges($totalItems);
299			}
300			/**
301			* Valor de venta
302			*
303			* Valor total de la factura sin considerar descuentos impuestos u otros tributos
304			* @return float
305			*/
306			public function getBillableValue() {
307			return $this->_items->getTotalBillableValue();
308			}
309
310			/**
311			* Total descuentos
312			*
313			* Formula: SUM(DESCUENTOS_X_ITEM) + DESCUENTOS_GLOBALES
314			* @return float
315			*/
316			public function getTotalAllowances() {
317			$totalItems = $this->_items->getTotalAllowances();
318			$totalTaxableAmountItems = $this->_items->getTotalTaxableAmount();
319			$globalAllowancesAmount = Operations::getTotalAllowanceCharge($totalTaxableAmountItems, $this->allowances);
320			return $totalItems + $globalAllowancesAmount;
321			}
322			/**
323			* Total a pagar
324			*
325			* El importe que el usuario está obligado a pagar
326			*
327			* Formula = OPERACIONES_GRAVADAS + IGV + OPERACIONES_EXONERADAS + OPERACIONES_INAFECTAS
328			*
329			* @return float
330			*/
331			public function getPayableAmount() {
332			// Totals
333			$totalTaxableOperations = $this->getTotalTaxableOperations();
334			$totalIGV = $this->getIGV();
335			$totalExemptedOperations = $this->getTotalExemptedOperations();
336			return $totalTaxableOperations + $totalIGV + $totalExemptedOperations;
337			}
338
339			/**
340			*
341			* Total impuestos
342			*
343			* Fórmula: IGV + ISC + IVAP
344			*
345			* @return float
346			*/
347			public function getTotalTaxes() {
348			$IGV = $this->getIGV();
349			$ISC = $this->getISC();
350			$IVAP = $this->getIVAP();
351			return $IGV + $ISC + $IVAP;
352			}
353
354			/**
355			* IGV
356			* @return float
357			*/
358			public function getIGV() {
359			$baseAmount = $this->getTaxableAmount();
360			return Operations::calcIGV($baseAmount);
361			}
362
363			/**
364			* ISC
365			* @IMP
366			* @return float
367			*/
368			public function getISC() {
369			return Operations::calcISC();
370			}
371			/**
372			* IVAP
373			* @IMP
374			* @return float
375			*/
376			public function getIVAP() {
377			return Operations::calcIVAP();
378			}
379			/**
380			*
381			* @param float $amount
382			* @return float
383			*/
384			private function applyAllowancesAndCharges($amount) {
385			return Operations::applyAllowancesAndCharges($amount, $this->allowances, $this->charges);
386			}
387
388			}
389

jDelta / F72X

Push — master ( d3c8d8...d4fc42 )

InvoiceDocument::getTotalFreeOperations() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like