danielgp\efactura\ElectornicInvoiceRead

Complexity

Total Complexity

18

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	readElectronicInvoice()	0	16	1
A	getMultiplePaymentMeansElements()	0	10	3
B	getHeader()	0	48	8
A	getDocumentRoot()	0	12	3
A	getElementsOrdered()	0	9	3

<?php

/**
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2024 Daniel Popiniuc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

namespace danielgp\efactura;

class ElectornicInvoiceRead
{

    use TraitBasic,

The trait danielgp\efactura\TraitTax requires some properties which are not provided by danielgp\efactura\ElectornicInvoiceRead: $ID, $currencyID, $unitCode, $TaxExemptionReason, $TaxCategory, $TaxableAmount, $TaxSubtotal, $TaxAmount, $TaxScheme, $Percent

The trait danielgp\efactura\TraitBasic requires some properties which are not provided by danielgp\efactura\ElectornicInvoiceRead: $currencyID, $unitCode

The trait danielgp\efactura\TraitCompanies requires some properties which are not provided by danielgp\efactura\ElectornicInvoiceRead: $ID, $EndpointID, $PartyLegalEntity, $currencyID, $PostalAddress, $Name, $unitCode, $Contact, $RegistrationName, $PartyIdentification, $CompanyLegalForm, $ElectronicMail, $CompanyID, $Telephone, $schemeID, $PartyTaxScheme, $TaxScheme, $PartyName

The trait danielgp\efactura\TraitLines requires some properties which are not provided by danielgp\efactura\ElectornicInvoiceRead: $AllowanceCharge, $ID, $currencyID, $CreditedQuantity, $Name, $unitCode, $TaxExemptionReason, $OrderLineReference, $TaxCategory, $ChargeIndicator, $MultiplierFactorNumeric, $DocumentReference, $AllowanceChargeReasonCode, $TaxableAmount, $Price, $Value, $Amount, $AllowanceChargeReason, $TaxSubtotal, $TaxAmount, $Item, $InvoicedQuantity, $BaseAmount, $TaxScheme, $LineID, $LineExtensionAmount, $Percent

        TraitCompanies,
        TraitTax,
        TraitLines;

    private function getDocumentRoot(object $objFile): array
    {
        $arrayDocument = [
            'DocumentTagName'    => $objFile->getName(),
            'DocumentNameSpaces' => $objFile->getDocNamespaces(true),
        ];
        if (array_key_exists('xsi', $arrayDocument['DocumentNameSpaces'])) {
            if (isset($objFile->attributes('xsi', true)->schemaLocation)) {
                $arrayDocument['SchemaLocation'] = $objFile->attributes('xsi', true)->schemaLocation;
            }
        }
        return $arrayDocument;
    }

    private function getElementsOrdered(string $strKeyOrderedElements, \SimpleXMLElement $arrayDataIn): array
    {
        $arrayOutput = [];
        foreach ($this->arraySettings['CustomOrder'][$strKeyOrderedElements] as $value) {
            if (isset($arrayDataIn->$value)) {
                $arrayOutput[$value] = $arrayDataIn->$value->__toString();
            }
        }
        return $arrayOutput;
    }

    private function getHeader(array $arrayParams): array
    {
        $arrayCBC               = explode(':', $arrayParams['DocumentNameSpaces']['cbc']);
        $strCBC                 = $arrayCBC[(count($arrayCBC) - 1)]; // CommonBasicComponents
        $arrayDocument[$strCBC] = $this->getElementsOrdered('Header_CBC', $arrayParams['CBC']);

$arrayDocument was never initialized. Although not strictly required by PHP, it is generally a good practice to add $arrayDocument = array(); before regardless.

        $strCAC                 = $arrayParams['cacName']; // CommonAggregateComponents
        $arrayDocument[$strCAC] = [
            'AccountingCustomerParty' => $this->getAccountingCustomerParty($arrayParams['CAC']
                ->AccountingCustomerParty->children('cac', true)->Party),
            'AccountingSupplierParty' => $this->getAccountingSupplierParty($arrayParams['CAC']
                ->AccountingSupplierParty->children('cac', true)->Party),
            'TaxTotal'                => $this->getTaxTotal($arrayParams['CAC']->TaxTotal),
        ];
        // optional components =========================================================================================
        foreach ($this->arraySettings['CustomOrder']['Header_CAC'] as $key => $value) {
            if (isset($arrayParams['CAC']->$key)) {
                switch ($value) {
                    case 'Single':
                        $arrayDocument[$strCAC][$key] = $this->getElements($arrayParams['CAC']->$key);
                        break;
                    case 'Multiple':
                        $arrayDocument[$strCAC][$key] = $this->getMultiplePaymentMeansElements($arrayParams['CAC']->$key);
                        break;
                    case 'MultipleStandard':
                        $arrayDocument[$strCAC][$key] = $this->getMultipleElementsStandard($arrayParams['CAC']->$key);
                        break;
                }
            }
        }
        if (isset($arrayParams['CAC']->Delivery)) {
            $strEl                                                             = $arrayParams['CAC']->Delivery;
            $strElement                                                        = $strEl->children('cac', true)
                ->DeliveryLocation->children('cac', true)->Address;
            $arrayDocument[$strCAC]['Delivery']['DeliveryLocation']['Address'] = [
                'StreetName' => $strElement->children('cbc', true)->StreetName->__toString(),
                'CityName'   => $strElement->children('cbc', true)->CityName->__toString(),
                'PostalZone' => $strElement->children('cbc', true)->PostalZone->__toString(),
                'Country'    => [
                    'IdentificationCode' => $strElement->children('cac', true)->Country->children('cbc', true)
                    ->IdentificationCode->__toString(),
                ],
            ];
            if (isset($strEl->children('cbc', true)->ActualDeliveryDate)) {
                $arrayDocument[$strCAC]['Delivery']['ActualDeliveryDate'] = $strEl
                        ->children('cbc', true)->ActualDeliveryDate->__toString();
            }
        }
        return $arrayDocument;
    }

    private function getMultiplePaymentMeansElements(array|\SimpleXMLElement $arrayIn): array
    {
        $arrayToReturn = [];
        $intLineNo     = 0;
        foreach ($arrayIn as $child) {
            $intLineNo++;
            $intLineStr                 = ($intLineNo < 10 ? '0' : '') . $intLineNo;
            $arrayToReturn[$intLineStr] = $this->getElements($child);
        }
        return $arrayToReturn;
    }

    public function readElectronicInvoice(string $strFile): array
    {
        $this->getHierarchyTagOrder();
        $objFile                 = new \SimpleXMLElement($strFile, NULL, TRUE);
        $arrayDocument           = $this->getDocumentRoot($objFile);
        $arrayCAC                = explode(':', $arrayDocument['DocumentNameSpaces']['cac']);
        $strElementA             = $arrayCAC[count($arrayCAC) - 1]; // CommonAggregateComponents
        $arrayDocument['Header'] = $this->getHeader([
            'CAC'                => $objFile->children('cac', true),
            'cacName'            => $strElementA,
            'CBC'                => $objFile->children('cbc', true),
            'DocumentNameSpaces' => $arrayDocument['DocumentNameSpaces'],
            'DocumentTagName'    => $arrayDocument['DocumentTagName'],
        ]);
        $arrayDocument['Lines']  = $this->getDocumentLines($objFile, $arrayDocument['DocumentTagName']);
        return $arrayDocument;
    }
}