ShipmentDetails.php

Go to the documentation of this file.

<?php

namespace Petschko\DHL;

use stdClass;

class ShipmentDetails {
    const PALETTE = 'PL';

    const PACKAGE = 'PK';

    const PRODUCT_TYPE_NATIONAL_PACKAGE = 'V01PAK';
    const PRODUCT_TYPE_NATIONAL_PACKAGE_PRIO = 'V01PRIO';
    const PRODUCT_TYPE_INTERNATIONAL_PACKAGE = 'V53WPAK';
    const PRODUCT_TYPE_EUROPA_PACKAGE = 'V54EPAK';
    const PRODUCT_TYPE_PACKED_CONNECT = 'V55PAK';
    const PRODUCT_TYPE_SAME_DAY_PACKAGE = 'V06PAK';
    const PRODUCT_TYPE_SAME_DAY_MESSENGER = 'V06TG';
    const PRODUCT_TYPE_WISH_TIME_MESSENGER = 'V06WZ';
    const PRODUCT_TYPE_AUSTRIA_PACKAGE = 'V86PARCEL';
    const PRODUCT_TYPE_AUSTRIA_INTERNATIONAL_PACKAGE = 'V82PARCEL';
    const PRODUCT_TYPE_CONNECT_PACKAGE = 'V87PARCEL';

    private $product = self::PRODUCT_TYPE_NATIONAL_PACKAGE;

    private $accountNumber;

    private $customerReference = null;

    private $shipmentDate = null;

    private $returnAccountNumber = null;

    private $returnReference = null;

    private $weight = 5.0;

    private $length = null;

    private $width = null;

    private $height = null;

    private $service = null;

    private $packageType = self::PACKAGE;

    private $notificationEmail = null;

    private $bank = null;

    public function __construct($accountNumber) {
        $this->setAccountNumber($accountNumber);
    }

    public function __destruct() {
        unset($this->product);
        unset($this->accountNumber);
        unset($this->customerReference);
        unset($this->shipmentDate);
        unset($this->returnAccountNumber);
        unset($this->returnReference);
        unset($this->weight);
        unset($this->length);
        unset($this->width);
        unset($this->height);
        unset($this->service);
        unset($this->packageType);
        unset($this->notificationEmail);
        unset($this->bank);
    }

    public function getProduct() {
        return $this->product;
    }

    public function setProduct($product) {
        $this->product = $product;
    }

    private function getAccountNumber() {
        return $this->accountNumber;
    }

    private function setAccountNumber($accountNumber) {
        $this->accountNumber = $accountNumber;
    }

    public function getCustomerReference() {
        return $this->customerReference;
    }

    public function setCustomerReference($customerReference) {
        $this->customerReference = $customerReference;
    }

    public function getShipmentDate() {
        if($this->shipmentDate === null)
            $this->setShipmentDate($this->createDefaultShipmentDate());

        return $this->shipmentDate;
    }

    public function setShipmentDate($shipmentDate, $useIntTime = false) {
        if($useIntTime) {
            // Convert Time-Stamp to Date
            $shipmentDate = date('Y-m-d', $shipmentDate);

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

        $this->shipmentDate = $shipmentDate;
    }

    public function getReturnAccountNumber() {
        return $this->returnAccountNumber;
    }

    public function setReturnAccountNumber($returnAccountNumber) {
        $this->returnAccountNumber = $returnAccountNumber;
    }

    public function getReturnReference() {
        return $this->returnReference;
    }

    public function setReturnReference($returnReference) {
        $this->returnReference = $returnReference;
    }

    public function getWeight() {
        return $this->weight;
    }

    public function setWeight($weight) {
        $this->weight = $weight;
    }

    public function getLength() {
        return $this->length;
    }

    public function setLength($length) {
        $this->length = $length;
    }

    public function getWidth() {
        return $this->width;
    }

    public function setWidth($width) {
        $this->width = $width;
    }

    public function getHeight() {
        return $this->height;
    }

    public function setHeight($height) {
        $this->height = $height;
    }

    public function getService() {
        return $this->service;
    }

    public function setService($service) {
        $this->service = $service;
    }

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

        return $this->packageType;
    }

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

        $this->packageType = $packageType;
    }

    public function getNotificationEmail() {
        return $this->notificationEmail;
    }

    public function setNotificationEmail($notificationEmail) {
        $this->notificationEmail = $notificationEmail;
    }

    public function getBank() {
        return $this->bank;
    }

    public function setBank($bank) {
        $this->bank = $bank;
    }

    private function createDefaultShipmentDate() {
        $now = time();
        $weekDay = date('w', $now);

        if($weekDay === 0)
            $now += 86400; // Increase Day by 1 if Sunday

        return date('Y-m-d', $now);
    }

    public function getShipmentDetailsClass_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);

        return new StdClass;
    }

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

        $class->product = $this->getProduct();
        $class->accountNumber = $this->getAccountNumber();
        if($this->getCustomerReference() !== null)
            $class->customerReference = $this->getCustomerReference();
        $class->shipmentDate = $this->getShipmentDate();
        if($this->getReturnAccountNumber() !== null)
            $class->returnShipmentAccountNumber = $this->getReturnAccountNumber();
        if($this->getReturnReference() !== null)
            $class->returnShipmentReference = $this->getReturnReference();

        $class->ShipmentItem = new StdClass;
        $class->ShipmentItem->weightInKG = $this->getWeight();
        if($this->getLength() !== null)
            $class->ShipmentItem->lengthInCM = $this->getLength();
        if($this->getWidth() !== null)
            $class->ShipmentItem->widthInCM = $this->getWidth();
        if($this->getHeight() !== null)
            $class->ShipmentItem->heightInCM = $this->getHeight();

        if($this->getService() !== null)
            $class->Service = $this->getService()->getServiceClass_v2($this->getProduct());

        if($this->getNotificationEmail() !== null) {
            $class->Notification = new StdClass;
            $class->Notification->recipientEmailAddress = $this->getNotificationEmail();
        }

        if($this->getBank() !== null)
            $class->BankData = $this->getBank()->getBankClass_v2();

        return $class;
    }
}