danielgp\efactura\TraitHeader

Complexity

Total Complexity

32

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getHeaderCommonBasicComponents()	0	21	5
A	getLegalMonetaryTotal()	0	23	5
A	getMultipleElementsStandard()	0	12	4
A	getLegalInvoicePeriod()	0	10	3
A	getHeaderTypeCode()	0	14	3
A	getMultipleElements()	0	10	3
B	getHeader()	0	57	9

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

trait TraitHeader
{

    use TraitCompanies,
        TraitTax;

    private function getHeader(array $arrayParams): array
    {
        $arrayCBC      = explode(':', $arrayParams['DocumentNameSpaces']['cbc']);
        $strCBC        = $arrayCBC[count($arrayCBC) - 1]; // CommonBasicComponents
        $strCAC        = $arrayParams['cacName']; // CommonAggregateComponents
        $arrayDocument = [
            $strCBC => $this->getHeaderCommonBasicComponents($arrayParams['DocumentTagName'], $arrayParams['CBC']),
            $strCAC => [
                'AccountingCustomerParty' => $this->getAccountingCustomerParty($arrayParams['CAC']
                    ->AccountingCustomerParty->children('cac', true)->Party),
                'AccountingSupplierParty' => $this->getAccountingSupplierParty($arrayParams['CAC']
                    ->AccountingSupplierParty->children('cac', true)->Party),
                'LegalMonetaryTotal'      => $this->getLegalMonetaryTotal($arrayParams['CAC']->LegalMonetaryTotal),
                'TaxTotal'                => $this->getTaxTotal($arrayParams['CAC']->TaxTotal),
            ],
        ];
        // optional components =========================================================================================
        if (isset($arrayParams['CAC']->PaymentMeans)) {
            $arrayDocument[$strCAC]['PaymentMeans'] = $this->getMultipleElements($arrayParams['CAC']->PaymentMeans);
        }
        if (isset($arrayParams['CAC']->PaymentTerms)) {
            $arrayDocument[$strCAC]['PaymentTerms']['Note'] = $arrayParams['CAC']
                ->PaymentTerms->children('cbc', true)->Note->__toString();
        }
        if (isset($arrayParams['CAC']->InvoicePeriod)) {
            $arrayDocument[$strCAC]['InvoicePeriod'] = $this->getLegalInvoicePeriod($arrayParams['CAC']->InvoicePeriod);
        }
        if (isset($arrayParams['CAC']->ContractDocumentReference)) {
            $arrayDocument[$strCAC]['ContractDocumentReference']['ID'] = $arrayParams['CAC']
                ->ContractDocumentReference->children('cbc', true)->ID->__toString();
        }
        if (isset($arrayParams['CAC']->OrderReference)) {
            $arrayDocument[$strCAC]['OrderReference']['ID'] = $arrayParams['CAC']
                ->OrderReference->children('cbc', true)->ID->__toString();
        }
        if (isset($arrayParams['CAC']->AdditionalDocumentReference)) {
            $arrayDocument[$strCAC]['AdditionalDocumentReference'] = $this->getMultipleElementsStandard($arrayParams['CAC']
                ->AdditionalDocumentReference);
        }
        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 getHeaderCommonBasicComponents(string $strType, $objCommonBasicComponents): array
    {
        $arrayOutput = [
            'CustomizationID'      => $objCommonBasicComponents->CustomizationID->__toString(),
            'DocumentCurrencyCode' => $objCommonBasicComponents->DocumentCurrencyCode->__toString(),
            'ID'                   => $objCommonBasicComponents->ID->__toString(),
            'IssueDate'            => $objCommonBasicComponents->IssueDate->__toString(),
        ];
        if (isset($objCommonBasicComponents->DueDate)) {
            $arrayOutput['DueDate'] = $objCommonBasicComponents->DueDate->__toString();
        }
        if (isset($objCommonBasicComponents->Note)) {
            $arrayOutput['Note'] = $objCommonBasicComponents->Note->__toString();
        }
        if (isset($objCommonBasicComponents->TaxPointDate)) {
            $arrayOutput['TaxPointDate'] = $objCommonBasicComponents->TaxPointDate->__toString();
        }
        if (isset($objCommonBasicComponents->UBLVersionID)) {
            $arrayOutput['UBLVersionID'] = $objCommonBasicComponents->UBLVersionID->__toString();
        }
        return array_merge($arrayOutput, $this->getHeaderTypeCode($strType, $objCommonBasicComponents));
    }

    private function getHeaderTypeCode(string $strType, $objCommonBasicComponents): array
    {
        $arrayOutput = [];
        switch ($strType) {
            case 'CreditNote':
                $arrayOutput['CreditNoteTypeCode'] = (integer) $objCommonBasicComponents
                    ->CreditNoteTypeCode->__toString();
                break;
            case 'Invoice':
                $arrayOutput['InvoiceTypeCode']    = (integer) $objCommonBasicComponents
                    ->InvoiceTypeCode->__toString();
                break;
        }
        return $arrayOutput;
    }

    private function getLegalInvoicePeriod($child2): array
    {
        $arrayOutput = [];
        if (isset($child2->children('cbc', true)->StartDate)) {
            $arrayOutput['StartDate'] = $child2->children('cbc', true)->StartDate->__toString();
        }
        if (isset($child2->children('cbc', true)->EndDate)) {
            $arrayOutput['EndDate'] = $child2->children('cbc', true)->EndDate->__toString();
        }
        return $arrayOutput;
    }

    private function getLegalMonetaryTotal($child2): array
    {
        $objCBC      = $child2->children('cbc', true);
        $arrayOutput = [
            'LineExtensionAmount' => $this->getTagWithCurrencyParameter($objCBC->LineExtensionAmount),
            'TaxExclusiveAmount'  => $this->getTagWithCurrencyParameter($objCBC->TaxExclusiveAmount),
            'TaxInclusiveAmount'  => $this->getTagWithCurrencyParameter($objCBC->TaxInclusiveAmount),
            'PayableAmount'       => $this->getTagWithCurrencyParameter($objCBC->PayableAmount),
        ];
        // optional components =========================================================================================
        if (isset($child2->children('cbc', true)->AllowanceTotalAmount)) {
            $arrayOutput['AllowanceTotalAmount'] = $this->getTagWithCurrencyParameter($objCBC->AllowanceTotalAmount);
        }
        if (isset($child2->children('cbc', true)->ChargeTotalAmount)) {
            $arrayOutput['ChargeTotalAmount'] = $this->getTagWithCurrencyParameter($objCBC->ChargeTotalAmount);
        }
        if (isset($child2->children('cbc', true)->PayableRoundingAmount)) {
            $arrayOutput['PayableRoundingAmount'] = $this->getTagWithCurrencyParameter($objCBC->PayableRoundingAmount);
        }
        if (isset($child2->children('cbc', true)->PrepaidAmount)) {
            $arrayOutput['PrepaidAmount'] = $this->getTagWithCurrencyParameter($objCBC->PrepaidAmount);
        }
        return $arrayOutput;
    }

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

    private function getMultipleElementsStandard(array|\SimpleXMLElement $arrayIn): array
    {
        $arrayToReturn = [];
        $intLineNo     = 0;
        foreach ($arrayIn as $child) {
            $intLineNo++;
            $intLineStr = ($intLineNo < 10 ? '0' : '') . $intLineNo;
            foreach ($child->children('cbc', true) as $key2 => $value2) {
                $arrayToReturn[$intLineStr][$key2] = $value2;
            }
        }
        return $arrayToReturn;
    }
}