ExportDocument.php

Go to the documentation of this file.

<?php

namespace Petschko\DHL;

use Exception;
use stdClass;

class ExportDocument {
    const EXPORT_TYPE_OTHER = 'OTHER';
    const EXPORT_TYPE_PRESENT = 'PRESENT';
    const EXPORT_TYPE_COMMERCIAL_SAMPLE = 'COMMERCIAL_SAMPLE';
    const EXPORT_TYPE_DOCUMENT = 'DOCUMENT';
    const EXPORT_TYPE_RETURN_OF_GOODS = 'RETURN_OF_GOODS';

    const TERMS_OF_TRADE_DDP = 'DDP';
    const TERMS_OF_TRADE_DXV = 'DXV';
    const TERMS_OF_TRADE_DDU = 'DDU';
    const TERMS_OF_TRADE_DDX = 'DDX';

    private $invoiceNumber = null;

    private $exportType;

    private $exportTypeDescription = null;

    private $termsOfTrade = null;

    private $placeOfCommittal;

    private $additionalFee;

    private $permitNumber = null;

    private $attestationNumber = null;

    private $withElectronicExportNotification = null;

    private $exportDocPosition = null;

    public function __destruct() {
        unset($this->invoiceNumber);
        unset($this->exportType);
        unset($this->exportTypeDescription);
        unset($this->termsOfTrade);
        unset($this->placeOfCommittal);
        unset($this->additionalFee);
        unset($this->permitNumber);
        unset($this->attestationNumber);
        unset($this->withElectronicExportNotification);
        unset($this->exportDocPosition);
    }

    public function getInvoiceNumber() {
        return $this->invoiceNumber;
    }

    public function setInvoiceNumber($invoiceNumber) {
        $this->invoiceNumber = $invoiceNumber;
    }

    public function getExportType() {
        return $this->exportType;
    }

    public function setExportType($exportType) {
        $this->exportType = $exportType;
    }

    public function getExportTypeDescription() {
        return $this->exportTypeDescription;
    }

    public function setExportTypeDescription($exportTypeDescription) {
        $this->exportTypeDescription = $exportTypeDescription;
    }

    public function getTermsOfTrade() {
        return $this->termsOfTrade;
    }

    public function setTermsOfTrade($termsOfTrade) {
        $this->termsOfTrade = $termsOfTrade;
    }

    public function getPlaceOfCommittal() {
        return $this->placeOfCommittal;
    }

    public function setPlaceOfCommittal($placeOfCommittal) {
        $this->placeOfCommittal = $placeOfCommittal;
    }

    public function getAdditionalFee() {
        return $this->additionalFee;
    }

    public function setAdditionalFee($additionalFee) {
        $this->additionalFee = $additionalFee;
    }

    public function getPermitNumber() {
        return $this->permitNumber;
    }

    public function setPermitNumber($permitNumber) {
        $this->permitNumber = $permitNumber;
    }

    public function getAttestationNumber() {
        return $this->attestationNumber;
    }

    public function setAttestationNumber($attestationNumber) {
        $this->attestationNumber = $attestationNumber;
    }

    public function getWithElectronicExportNotification() {
        return $this->withElectronicExportNotification;
    }

    public function setWithElectronicExportNotification($withElectronicExportNotification) {
        $this->withElectronicExportNotification = $withElectronicExportNotification;
    }

    public function getExportDocPosition() {
        return $this->exportDocPosition;
    }

    public function setExportDocPosition($exportDocPosition) {
        $this->exportDocPosition = $exportDocPosition;
    }

    public function addExportDocPosition($exportDocPosition) {
        if($this->getExportDocPosition() === null)
            $this->setExportDocPosition($exportDocPosition);
        else if(is_array($this->getExportDocPosition()))
            $this->exportDocPosition[] = $exportDocPosition;
        else {
            // Convert the first existing entry to an array
            $this->setExportDocPosition(array($this->getExportDocPosition(), $exportDocPosition));
        }
    }

    public function getExportDocumentClass_v1() {
        trigger_error('[DHL-PHP-SDK]: Version 1 Methods are deprecated and will removed soon (Called method ' . __METHOD__ . ')!', E_USER_DEPRECATED);
        trigger_error('[DHL-PHP-SDK]: Called Version 1 Method: ' . __METHOD__ . ' is incomplete (does nothing)!', E_USER_WARNING);

        $class = new StdClass;

        return $class;
    }

    public function getExportDocumentClass_v2() {
        $class = new StdClass;

        // Standard-Export-Stuff
        if($this->getInvoiceNumber() !== null)
            $class->invoiceNumber = $this->getInvoiceNumber();

        $class->exportType = $this->getExportType();

        if($this->getExportTypeDescription() !== null)
            $class->exportTypeDescription = $this->getExportTypeDescription();
        else if($this->getExportType() === self::EXPORT_TYPE_OTHER)
            throw new Exception('ExportTypeDescription must filled out if Export-Type is OTHER! - ' .
                'Export-Class will not generated now');

        if($this->getTermsOfTrade() !== null)
            $class->termsOfTrade = $this->getTermsOfTrade();

        $class->placeOfCommital = $this->getPlaceOfCommittal();
        $class->additionalFee = $this->getAdditionalFee();

        if($this->getPermitNumber() !== null)
            $class->permitNumber = $this->getPermitNumber();

        if($this->getAttestationNumber() !== null)
            $class->attestationNumber = $this->getAttestationNumber();

        // Add rest (Elements)
        if($this->getWithElectronicExportNotification() !== null) {
            $class->WithElectronicExportNtfctn = new StdClass;
            $class->WithElectronicExportNtfctn->active = (int) $this->getWithElectronicExportNotification();
        }

        // Check if child-class is being used
        if($this->getExportDocPosition() !== null) {
            // Handle non-arrays... (Backward compatibility)
            if(! is_array($this->getExportDocPosition()))
                $class->ExportDocPosition = $this->getExportDocPosition()->getExportDocPositionClass_v2();
            else {
                $pos = $this->getExportDocPosition();
                foreach($pos as $key => &$exportDoc)
                    $class->ExportDocPosition[$key] = $exportDoc->getExportDocPositionClass_v2();
            }
        }

        return $class;
    }
}