Response.php

Go to the documentation of this file.

<?php

namespace Petschko\DHL;

class Response extends Version implements LabelResponse {
    const DHL_ERROR_NOT_SET = -1;
    const DHL_ERROR_NO_ERROR = 0;
    const DHL_ERROR_WEAK_WARNING = 1;
    const DHL_ERROR_SERVICE_TMP_NOT_AVAILABLE = 500;
    const DHL_ERROR_GENERAL = 1000;
    const DHL_ERROR_AUTH_FAILED = 1001;
    const DHL_ERROR_HARD_VAL_ERROR = 1101;
    const DHL_ERROR_UNKNOWN_SHIPMENT_NUMBER = 2000;

    private $manifestData = null;

    private $statusCode = self::DHL_ERROR_NOT_SET;

    private $statusText = null;

    private $statusMessage = null;

    private $labelData = array();

    public function __construct($version, $response = null) {
        parent::__construct($version);

        if($response !== null) {
            switch($this->getMayor()) {
                case 1:
                    trigger_error('[DHL-PHP-SDK]: Called Version 1 Method ' .__CLASS__ . '->' . __METHOD__ . ' is incomplete (does nothing)!', E_USER_WARNING);
                    break;
                case 2:
                default:
                    $this->loadResponse_v2($response);
            }
        }
    }

    public function __destruct() {
        parent::__destruct();
        unset($this->manifestData);
        unset($this->statusCode);
        unset($this->statusText);
        unset($this->statusMessage);
        unset($this->labelData);
    }

    public function getShipmentNumber() {
        if($this->countLabelData() > 0)
            return $this->getLabelData(0)->getShipmentNumber();

        return null;
    }

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

        return null;
    }

    public function getLabel() {
        if($this->countLabelData() > 0)
            return $this->getLabelData(0)->getLabel();

        return null;
    }

    public function getReturnLabel() {
        if($this->countLabelData() > 0)
            return $this->getLabelData(0)->getReturnLabel();

        return null;
    }

    public function getExportDoc() {
        if($this->countLabelData() > 0)
            return $this->getLabelData(0)->getExportDoc();

        return null;
    }

    public function getManifestData() {
        return $this->manifestData;
    }

    private function setManifestData($manifestData) {
        $this->manifestData = $manifestData;
    }

    public function getSequenceNumber() {
        if($this->countLabelData() > 0)
            return $this->getLabelData(0)->getSequenceNumber();

        return null;
    }

    public function getStatusCode() {
        return $this->statusCode;
    }

    private function setStatusCode($statusCode) {
        $this->statusCode = $statusCode;
    }

    public function getStatusText() {
        return $this->statusText;
    }

    private function setStatusText($statusText) {
        $this->statusText = $statusText;
    }

    public function getStatusMessage() {
        return $this->statusMessage;
    }

    private function setStatusMessage($statusMessage) {
        $this->statusMessage = $statusMessage;
    }

    public function getLabelData($index = null) {
        if($index === null)
            return $this->labelData;
        else
            return $this->labelData[$index];
    }

    private function addLabelData($labelData) {
        $this->labelData[] = $labelData;
    }

    public function countLabelData() {
        return count($this->getLabelData());
    }

    private function validateStatusCode() {
        if($this->getStatusCode() === 0 && $this->getStatusText() !== 'ok')
            $this->setStatusCode(self::DHL_ERROR_WEAK_WARNING);
    }

    public function getCodLabel() {
        if($this->countLabelData() > 0)
            return $this->getLabelData(0)->getCodLabel();

        return null;
    }

    private function handleMultiShipments($possibleMultiLabelObject) {
        if(is_array($possibleMultiLabelObject)) {
            $multiLabelArray = $possibleMultiLabelObject;

            foreach($multiLabelArray as &$singleLabel)
                $this->addLabelData(new LabelData($this->getVersion(), $singleLabel));
        } else
            $this->addLabelData(new LabelData($this->getVersion(), $possibleMultiLabelObject));
    }

    private function loadResponse_v2($response) {
        // Set global Status-Values first
        if(isset($response->Status)) {
            if(isset($response->Status->statusCode))
                $this->setStatusCode((int) $response->Status->statusCode);
            if(isset($response->Status->statusText)) {
                if(is_array($response->Status->statusText))
                    $this->setStatusText(implode(';', $response->Status->statusText));
                else
                    $this->setStatusText($response->Status->statusText);
            }
            if(isset($response->Status->statusMessage)) {
                if(is_array($response->Status->statusMessage))
                    $this->setStatusMessage(implode(';', $response->Status->statusMessage));
                else
                    $this->setStatusMessage($response->Status->statusMessage);
            }

            $this->validateStatusCode();
        }

        // Set Manifest if exists (getManifest)
        if(isset($response->manifestData)) {
            $this->setManifestData($response->manifestData);

            return;
        }

        /*
         * Handle Shipment(s) | Calls on:
         * 1 -> createShipmentOrder
         * 2 -> deleteShipmentOrder
         * 3 -> updateShipmentOrder [Only Single]
         * 3 -> getLabel
         * 4 -> validateShipment
         * 5 -> getExportDoc
         * 6 -> doManifest
         */
        if(isset($response->CreationState)) // 1
            $this->handleMultiShipments($response->CreationState);
        else if(isset($response->DeletionState)) // 2
            $this->handleMultiShipments($response->DeletionState);
        else if(isset($response->LabelData)) // 3
            $this->handleMultiShipments($response->LabelData);
        else if(isset($response->ValidationState)) // 4
            $this->handleMultiShipments($response->ValidationState);
        else if(isset($response->ExportDocData)) // 5
            $this->handleMultiShipments($response->ExportDocData);
        else if(isset($response->ManifestState)) // 6
            $this->handleMultiShipments($response->ManifestState);
    }
}