Service.php

Go to the documentation of this file.

<?php

namespace Petschko\DHL;

use stdClass;

class Service {
    private $dayOfDeliveryEnabled = null;

    private $dayOfDeliveryDate = null;

    private $deliveryTimeframeEnabled = null;

    private $deliveryTimeframe = null;

    private $preferredTimeEnabled = null;

    private $preferredTime = null;

    private $individualSenderRequirementsEnabled = null;

    private $individualSenderRequirementsText = null;

    private $packagingReturn = null;

    private $returnImmediatelyIfShipmentFailed = null;

    private $noticeOnNonDeliverable = null;

    private $shipmentHandlingEnabled = null;

    private $shipmentHandlingType = null;

    private $endorsementEnabled = null;

    private $endorsementType = null;

    private $visualCheckOfAgeEnabled = null;

    private $visualCheckOfAgeType = null;

    private $preferredLocationEnabled = null;

    private $preferredLocationDetails = null;

    private $preferredNeighbourEnabled = null;

    private $preferredNeighbourText = null;

    private $preferredDayEnabled = null;

    private $preferredDayText = null;

    private $goGreen = null;

    private $perishables = null;

    private $personalHandover = null;

    private $disableNeighbourDelivery = null;

    private $namedPersonOnly = null;

    private $returnReceipt = null;

    private $premium = null;

    private $cashOnDeliveryEnabled = null;

    private $cashOnDeliveryAddFee = null;

    private $cashOnDeliveryAmount = null;

    private $additionalInsuranceEnabled = null;

    private $additionalInsuranceAmount = null;

    private $bulkyGoods = null;

    private $identCheckEnabled = null;

    private $identCheckObj = null;

    public function __destruct() {
        unset($this->dayOfDeliveryEnabled);
        unset($this->dayOfDeliveryDate);
        unset($this->deliveryTimeframeEnabled);
        unset($this->deliveryTimeframe);
        unset($this->preferredTimeEnabled);
        unset($this->preferredTime);
        unset($this->individualSenderRequirementsEnabled);
        unset($this->individualSenderRequirementsText);
        unset($this->packagingReturn);
        unset($this->returnImmediatelyIfShipmentFailed);
        unset($this->noticeOnNonDeliverable);
        unset($this->shipmentHandlingEnabled);
        unset($this->shipmentHandlingType);
        unset($this->endorsementEnabled);
        unset($this->endorsementType);
        unset($this->visualCheckOfAgeEnabled);
        unset($this->visualCheckOfAgeType);
        unset($this->preferredLocationEnabled);
        unset($this->preferredLocationDetails);
        unset($this->preferredNeighbourEnabled);
        unset($this->preferredNeighbourText);
        unset($this->preferredDayEnabled);
        unset($this->preferredDayText);
        unset($this->goGreen);
        unset($this->perishables);
        unset($this->personalHandover);
        unset($this->disableNeighbourDelivery);
        unset($this->namedPersonOnly);
        unset($this->returnReceipt);
        unset($this->premium);
        unset($this->cashOnDeliveryEnabled);
        unset($this->cashOnDeliveryAddFee);
        unset($this->cashOnDeliveryAmount);
        unset($this->additionalInsuranceEnabled);
        unset($this->additionalInsuranceAmount);
        unset($this->bulkyGoods);
        unset($this->identCheckEnabled);
        unset($this->identCheckObj);
    }

    public function getDayOfDeliveryEnabled() {
        return $this->dayOfDeliveryEnabled;
    }

    public function setDayOfDeliveryEnabled($dayOfDeliveryEnabled) {
        $this->dayOfDeliveryEnabled = $dayOfDeliveryEnabled;
    }

    public function getDayOfDeliveryDate() {
        return $this->dayOfDeliveryDate;
    }

    public function setDayOfDeliveryDate($dayOfDeliveryDate, $useIntTime = false) {
        if($useIntTime) {
            $dayOfDeliveryDate = date('Y-m-d', $dayOfDeliveryDate);

            if($dayOfDeliveryDate === false)
                $dayOfDeliveryDate = null;
        }

        $this->dayOfDeliveryDate = $dayOfDeliveryDate;
    }

    public function getDeliveryTimeframeEnabled() {
        return $this->deliveryTimeframeEnabled;
    }

    public function setDeliveryTimeframeEnabled($deliveryTimeframeEnabled) {
        $this->deliveryTimeframeEnabled = $deliveryTimeframeEnabled;
    }

    public function getDeliveryTimeframe() {
        return $this->deliveryTimeframe;
    }

    public function setDeliveryTimeframe($deliveryTimeframe) {
        $this->deliveryTimeframe = $deliveryTimeframe;
    }

    public function getPreferredTimeEnabled() {
        return $this->preferredTimeEnabled;
    }

    public function setPreferredTimeEnabled($preferredTimeEnabled) {
        $this->preferredTimeEnabled = $preferredTimeEnabled;
    }

    public function getPreferredTime() {
        return $this->preferredTime;
    }

    public function setPreferredTime($preferredTime) {
        $this->preferredTime = $preferredTime;
    }

    public function getIndividualSenderRequiredmentsEnabled() {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use getIndividualSenderRequirementsEnabled() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );

        return $this->getIndividualSenderRequirementsEnabled();
    }

    public function setIndividualSenderRequiredmentsEnabled($individualSenderRequirementsEnabled) {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use setIndividualSenderRequirementsEnabled() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );

        $this->setIndividualSenderRequirementsEnabled($individualSenderRequirementsEnabled);
    }

    public function getIndividualSenderRequiredmentsText() {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use getIndividualSenderRequirementsText() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );

        return $this->getIndividualSenderRequirementsText();
    }

    public function setIndividualSenderRequiredmentsText($individualSenderRequirementsText) {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use setIndividualSenderRequirementsText() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );

        $this->setIndividualSenderRequirementsText($individualSenderRequirementsText);
    }

    public function getIndividualSenderRequirementsEnabled() {
        return $this->individualSenderRequirementsEnabled;
    }

    public function setIndividualSenderRequirementsEnabled($individualSenderRequirementsEnabled) {
        $this->individualSenderRequirementsEnabled = $individualSenderRequirementsEnabled;
    }

    public function getIndividualSenderRequirementsText() {
        return $this->individualSenderRequirementsText;
    }

    public function setIndividualSenderRequirementsText($individualSenderRequirementsText) {
        $this->individualSenderRequirementsText = $individualSenderRequirementsText;
    }

    public function getPackagingReturn() {
        return $this->packagingReturn;
    }

    public function setPackagingReturn($packagingReturn) {
        $this->packagingReturn = $packagingReturn;
    }

    public function getReturnImmediatlyIfShipmentFailed() {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use getReturnImmediatelyIfShipmentFailed() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );
        
        return $this->getReturnImmediatelyIfShipmentFailed();
    }

    public function setReturnImmediatlyIfShipmentFailed($returnImmediatelyIfShipmentFailed) {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use setReturnImmediatelyIfShipmentFailed() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );
        
        $this->setReturnImmediatelyIfShipmentFailed($returnImmediatelyIfShipmentFailed);
    }
    
    public function getReturnImmediatelyIfShipmentFailed() {
        return $this->returnImmediatelyIfShipmentFailed;
    }

    public function setReturnImmediatelyIfShipmentFailed($returnImmediatelyIfShipmentFailed) {
        $this->returnImmediatelyIfShipmentFailed = $returnImmediatelyIfShipmentFailed;
    }

    public function getNoticeNonDeliverability() {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use getNoticeOnNonDeliverable() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );

        return $this->getNoticeOnNonDeliverable();
    }

    public function setNoticeNonDeliverability($noticeOnNonDeliverable) {
        trigger_error(
            'Called deprecated method ' . __METHOD__ . ': Use setNoticeOnNonDeliverable() instead, this method will removed in the future!',
            E_USER_DEPRECATED
        );

        $this->setNoticeOnNonDeliverable($noticeOnNonDeliverable);
    }

    public function getNoticeOnNonDeliverable() {
        return $this->noticeOnNonDeliverable;
    }

    public function setNoticeOnNonDeliverable($noticeOnNonDeliverable) {
        $this->noticeOnNonDeliverable = $noticeOnNonDeliverable;
    }

    public function getShipmentHandlingEnabled() {
        return $this->shipmentHandlingEnabled;
    }

    public function setShipmentHandlingEnabled($shipmentHandlingEnabled) {
        $this->shipmentHandlingEnabled = $shipmentHandlingEnabled;
    }

    public function getShipmentHandlingType() {
        return $this->shipmentHandlingType;
    }

    public function setShipmentHandlingType($shipmentHandlingType) {
        $this->shipmentHandlingType = $shipmentHandlingType;
    }

    public function getEndorsementEnabled() {
        return $this->endorsementEnabled;
    }

    public function setEndorsementEnabled($endorsementEnabled) {
        $this->endorsementEnabled = $endorsementEnabled;
    }

    public function getEndorsementType() {
        return $this->endorsementType;
    }

    public function setEndorsementType($endorsementType) {
        $this->endorsementType = $endorsementType;
    }

    public function getVisualCheckOfAgeEnabled() {
        return $this->visualCheckOfAgeEnabled;
    }

    public function setVisualCheckOfAgeEnabled($visualCheckOfAgeEnabled) {
        $this->visualCheckOfAgeEnabled = $visualCheckOfAgeEnabled;
    }

    public function getVisualCheckOfAgeType() {
        return $this->visualCheckOfAgeType;
    }

    public function setVisualCheckOfAgeType($visualCheckOfAgeType) {
        $this->visualCheckOfAgeType = $visualCheckOfAgeType;
    }

    public function getPreferredLocationEnabled() {
        return $this->preferredLocationEnabled;
    }

    public function setPreferredLocationEnabled($preferredLocationEnabled) {
        $this->preferredLocationEnabled = $preferredLocationEnabled;
    }

    public function getPreferredLocationDetails() {
        return $this->preferredLocationDetails;
    }

    public function setPreferredLocationDetails($preferredLocationDetails) {
        $this->preferredLocationDetails = $preferredLocationDetails;
    }

    public function getPreferredNeighbourEnabled() {
        return $this->preferredNeighbourEnabled;
    }

    public function setPreferredNeighbourEnabled($preferredNeighbourEnabled) {
        $this->preferredNeighbourEnabled = $preferredNeighbourEnabled;
    }

    public function getPreferredNeighbourText() {
        return $this->preferredNeighbourText;
    }

    public function setPreferredNeighbourText($preferredNeighbourText) {
        $this->preferredNeighbourText = $preferredNeighbourText;
    }

    public function getPreferredDayEnabled() {
        return $this->preferredDayEnabled;
    }

    public function setPreferredDayEnabled($preferredDayEnabled) {
        $this->preferredDayEnabled = $preferredDayEnabled;
    }

    public function getPreferredDayText() {
        return $this->preferredDayText;
    }

    public function setPreferredDayText($preferredDayText) {
        $this->preferredDayText = $preferredDayText;
    }

    public function getGoGreen() {
        trigger_error('[DHL-PHP-SDK]: Version 1 Methods are deprecated and will removed soon (Called method ' . __METHOD__ . ')!', E_USER_DEPRECATED);

        return $this->goGreen;
    }

    public function setGoGreen($goGreen) {
        trigger_error('[DHL-PHP-SDK]: Version 1 Methods are deprecated and will removed soon (Called method ' . __METHOD__ . ')!', E_USER_DEPRECATED);

        $this->goGreen = $goGreen;
    }

    public function getPerishables() {
        return $this->perishables;
    }

    public function setPerishables($perishables) {
        $this->perishables = $perishables;
    }

    public function getPersonalHandover() {
        trigger_error(
            '[DHL-PHP-SDK]: Version 1 Methods are deprecated and will removed soon ( Called method ' . __METHOD__ .
            ' - Version 2 Function: getNamedPersonOnly() )!',
            E_USER_DEPRECATED
        );

        return $this->personalHandover;
    }

    public function setPersonalHandover($personalHandover) {
        trigger_error(
            '[DHL-PHP-SDK]: Version 1 Methods are deprecated and will removed soon ( Called method ' . __METHOD__ .
            ' - Version2 Function: setNamedPersonOnly($name) )!',
            E_USER_DEPRECATED
        );

        $this->personalHandover = $personalHandover;
    }

    public function getDisableNeighbourDelivery() {
        return $this->disableNeighbourDelivery;
    }

    public function setDisableNeighbourDelivery($disableNeighbourDelivery) {
        $this->disableNeighbourDelivery = $disableNeighbourDelivery;
    }

    public function getNamedPersonOnly() {
        return $this->namedPersonOnly;
    }

    public function setNamedPersonOnly($namedPersonOnly) {
        $this->namedPersonOnly = $namedPersonOnly;
    }

    public function getReturnReceipt() {
        return $this->returnReceipt;
    }

    public function setReturnReceipt($returnReceipt) {
        $this->returnReceipt = $returnReceipt;
    }

    public function getPremium() {
        return $this->premium;
    }

    public function setPremium($premium) {
        $this->premium = $premium;
    }

    public function getCashOnDeliveryEnabled() {
        return $this->cashOnDeliveryEnabled;
    }

    public function setCashOnDeliveryEnabled($cashOnDeliveryEnabled) {
        $this->cashOnDeliveryEnabled = $cashOnDeliveryEnabled;
    }

    public function getCashOnDeliveryAddFee() {
        return $this->cashOnDeliveryAddFee;
    }

    public function setCashOnDeliveryAddFee($cashOnDeliveryAddFee) {
        $this->cashOnDeliveryAddFee = $cashOnDeliveryAddFee;
    }

    public function getCashOnDeliveryAmount() {
        return $this->cashOnDeliveryAmount;
    }

    public function setCashOnDeliveryAmount($cashOnDeliveryAmount) {
        $this->cashOnDeliveryAmount = $cashOnDeliveryAmount;
    }

    public function getAdditionalInsuranceEnabled() {
        return $this->additionalInsuranceEnabled;
    }

    public function setAdditionalInsuranceEnabled($additionalInsuranceEnabled) {
        $this->additionalInsuranceEnabled = $additionalInsuranceEnabled;
    }

    public function getAdditionalInsuranceAmount() {
        return $this->additionalInsuranceAmount;
    }

    public function setAdditionalInsuranceAmount($additionalInsuranceAmount) {
        $this->additionalInsuranceAmount = $additionalInsuranceAmount;
    }

    public function getBulkyGoods() {
        return $this->bulkyGoods;
    }

    public function setBulkyGoods($bulkyGoods) {
        $this->bulkyGoods = $bulkyGoods;
    }

    public function getIdentCheckEnabled() {
        return $this->identCheckEnabled;
    }

    public function setIdentCheckEnabled($identCheckEnabled) {
        $this->identCheckEnabled = $identCheckEnabled;
    }

    public function getIdentCheckObj() {
        return $this->identCheckObj;
    }

    public function setIdentCheckObj($identCheckObj) {
        $this->identCheckObj = $identCheckObj;
    }

    public function getServiceClass_v1($productType) {
        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);

        return new StdClass;
    }

    public function getServiceClass_v2($productType) {
        $class = new StdClass;

        if($this->getDayOfDeliveryEnabled() !== null && in_array(
            $productType,
            array(
                ShipmentDetails::PRODUCT_TYPE_SAME_DAY_MESSENGER,
                ShipmentDetails::PRODUCT_TYPE_WISH_TIME_MESSENGER
            ))) {
            $class->DayOfDelivery = new StdClass;
            $class->DayOfDelivery->active = (int) $this->getDayOfDeliveryEnabled();
            $class->DayOfDelivery->details = $this->getDayOfDeliveryDate();
        }
        if($this->getDeliveryTimeframeEnabled() !== null && in_array(
                $productType,
                array(
                    ShipmentDetails::PRODUCT_TYPE_SAME_DAY_MESSENGER,
                    ShipmentDetails::PRODUCT_TYPE_WISH_TIME_MESSENGER
                ))) {
            $class->DeliveryTimeframe = new StdClass;
            $class->DeliveryTimeframe->active = (int) $this->getDeliveryTimeframeEnabled();
            $class->DeliveryTimeframe->type = $this->getDeliveryTimeframe();
        }
        if($this->getPreferredTimeEnabled() !== null && in_array(
                $productType,
                array(
                    ShipmentDetails::PRODUCT_TYPE_NATIONAL_PACKAGE,
                    ShipmentDetails::PRODUCT_TYPE_SAME_DAY_PACKAGE
                ))) {
            $class->PreferredTime = new StdClass;
            $class->PreferredTime->active = (int) $this->getPreferredTimeEnabled();
            $class->PreferredTime->type = $this->getPreferredTime();
        }
        if($this->getIndividualSenderRequirementsEnabled() !== null && in_array(
                $productType,
                array(
                    ShipmentDetails::PRODUCT_TYPE_SAME_DAY_MESSENGER,
                    ShipmentDetails::PRODUCT_TYPE_WISH_TIME_MESSENGER
                ))) {
            $class->IndividualSenderRequirement = new StdClass;
            $class->IndividualSenderRequirement->active = (int) $this->getIndividualSenderRequirementsEnabled();
            $class->IndividualSenderRequirement->details = $this->getIndividualSenderRequirementsText();
        }
        if($this->getPackagingReturn() !== null) {
            $class->PackagingReturn = new StdClass;
            $class->PackagingReturn->active = (int) $this->getPackagingReturn();
        }
        if($this->getReturnImmediatelyIfShipmentFailed() !== null && in_array(
                $productType,
                array(
                    ShipmentDetails::PRODUCT_TYPE_SAME_DAY_PACKAGE
                ))) {
            $class->ReturnImmediately = new StdClass;
            $class->ReturnImmediately->active = (int) $this->getReturnImmediatelyIfShipmentFailed();
        }
        if($this->getNoticeOnNonDeliverable() !== null) {
            $class->NoticeOfNonDeliverability = new StdClass;
            $class->NoticeOfNonDeliverability->active = (int) $this->getNoticeOnNonDeliverable();
        }
        if($this->getShipmentHandlingEnabled() !== null && in_array(
                $productType,
                array(
                    ShipmentDetails::PRODUCT_TYPE_SAME_DAY_MESSENGER,
                    ShipmentDetails::PRODUCT_TYPE_WISH_TIME_MESSENGER
                ))) {
            $class->ShipmentHandling = new StdClass;
            $class->ShipmentHandling->active = (int) $this->getShipmentHandlingEnabled();
            $class->ShipmentHandling->type = $this->getShipmentHandlingType();
        }
        if($this->getEndorsementEnabled() !== null) {
            $class->Endorsement = new StdClass;
            $class->Endorsement->active = (int) $this->getEndorsementEnabled();
            $class->Endorsement->type = $this->getEndorsementType();
        }
        if($this->getVisualCheckOfAgeEnabled() !== null) {
            $class->VisualCheckOfAge = new StdClass;
            $class->VisualCheckOfAge->active = (int) $this->getVisualCheckOfAgeEnabled();
            $class->VisualCheckOfAge->type = $this->getVisualCheckOfAgeType();
        }
        if($this->getPreferredLocationEnabled() !== null) {
            $class->PreferredLocation = new StdClass;
            $class->PreferredLocation->active = (int) $this->getPreferredLocationEnabled();
            $class->PreferredLocation->details = $this->getPreferredLocationDetails();
        }
        if($this->getPreferredNeighbourEnabled() !== null) {
            $class->PreferredNeighbour = new StdClass;
            $class->PreferredNeighbour->active = (int) $this->getPreferredNeighbourEnabled();
            $class->PreferredNeighbour->details = $this->getPreferredNeighbourText();
        }
        if($this->getPreferredDayEnabled() !== null) {
            $class->PreferredDay = new StdClass;
            $class->PreferredDay->active = (int) $this->getPreferredDayEnabled();
            $class->PreferredDay->details = $this->getPreferredDayText();
        }
        if($this->getPerishables() !== null) {
            $class->Perishables = new StdClass;
            $class->Perishables->active = (int) $this->getPerishables();
        }
        if($this->getDisableNeighbourDelivery() !== null) {
            $class->NoNeighbourDelivery = new StdClass;
            $class->NoNeighbourDelivery->active = (int) $this->getDisableNeighbourDelivery();
        }
        if($this->getNamedPersonOnly() !== null) {
            $class->NamedPersonOnly = new StdClass;
            $class->NamedPersonOnly->active = (int) $this->getNamedPersonOnly();
        }
        if($this->getReturnReceipt() !== null) {
            $class->ReturnReceipt = new StdClass;
            $class->ReturnReceipt->active = (int) $this->getReturnReceipt();
        }
        if($this->getPremium() !== null) {
            $class->Premium = new StdClass;
            $class->Premium->active = (int) $this->getPremium();
        }
        if($this->getCashOnDeliveryEnabled() !== null) {
            $class->CashOnDelivery = new StdClass;
            $class->CashOnDelivery->active = (int) $this->getCashOnDeliveryEnabled();
            if($this->getCashOnDeliveryAddFee() !== null)
                $class->CashOnDelivery->addFee = $this->getCashOnDeliveryAddFee();
            $class->CashOnDelivery->codAmount = $this->getCashOnDeliveryAmount();
        }
        if($this->getAdditionalInsuranceEnabled() !== null) {
            $class->AdditionalInsurance = new StdClass;
            $class->AdditionalInsurance->active = (int) $this->getAdditionalInsuranceEnabled();
            $class->AdditionalInsurance->insuranceAmount = $this->getAdditionalInsuranceAmount();
        }
        if($this->getBulkyGoods() !== null) {
            $class->BulkyGoods = new StdClass;
            $class->BulkyGoods->active = (int) $this->getBulkyGoods();
        }
        if($this->getIdentCheckEnabled() !== null) {
            $class->IdentCheck = new StdClass;
            $class->IdentCheck->active = (int) $this->getIdentCheckEnabled();
            $class->IdentCheck->Ident = $this->getIdentCheckObj()->getIdentClass_v2();
        }

        return $class;
    }
}