Public Member Functions | |
| __construct ($version, $labelData) | |
| __destruct () | |
| getStatusCode () | |
| getStatusText () | |
| getStatusMessage () | |
| getSequenceNumber () | |
| getShipmentNumber () | |
| getLabel () | |
| getReturnLabel () | |
| getExportDoc () | |
| getCodLabel () | |
 Public Member Functions inherited from Version | |
| getVersion () | |
| getMayor () | |
| getMinor () | |
Additional Inherited Members | |
| Protected Member Functions inherited from Version | |
| __construct ($version) | |
| __destruct () | |
| setVersion ($version) | |
| getVersionClass () | |
Detailed Description
Definition at line 21 of file LabelData.php.
Constructor & Destructor Documentation
§ __construct()
| __construct | ( | $version, | |
| $labelData | |||
| ) |
LabelData constructor.
- Parameters
-
string $version - Current DHL-Version object $labelData - LabelData-Object from DHL-Response
Definition at line 100 of file LabelData.php.
§ __destruct()
| __destruct | ( | ) |
Clears Memory
Definition at line 118 of file LabelData.php.
Member Function Documentation
§ getCodLabel()
| getCodLabel | ( | ) |
Getter for Cod-Label
- Returns
- null|string - Cod-Label-URL/Base64-Data or null if not requested/set
Implements LabelResponse.
Definition at line 297 of file LabelData.php.
§ getExportDoc()
| getExportDoc | ( | ) |
Getter for Export-Document
- Returns
- null|string - Export-Document Label-URL/Base64-Label-Data or null if not requested/set
Implements LabelResponse.
Definition at line 279 of file LabelData.php.
§ getLabel()
| getLabel | ( | ) |
Getter for Label
- Returns
- null|string - Label URL/Base64-Data (Can also contain the return label) or null if not set
Implements LabelResponse.
Definition at line 243 of file LabelData.php.
§ getReturnLabel()
| getReturnLabel | ( | ) |
Getter for ReturnLabel
- Returns
- null|string - Return Label-URL/Base64-Label-Data or null if not requested/set
Implements LabelResponse.
Definition at line 261 of file LabelData.php.
§ getSequenceNumber()
| getSequenceNumber | ( | ) |
Getter for Sequence-Number
- Returns
- string|null - Sequence-Number of the Request or null if not set
Implements LabelResponse.
Definition at line 207 of file LabelData.php.
§ getShipmentNumber()
| getShipmentNumber | ( | ) |
Getter for Shipment-Number
- Returns
- null|string - Shipment-Number or null if not set
Implements LabelResponse.
Definition at line 225 of file LabelData.php.
§ getStatusCode()
| getStatusCode | ( | ) |
Getter for Status-Code
- Response::DHL_ERROR_NOT_SET (-1) -> Status-Code was not set
- Response::DHL_ERROR_NO_ERROR (0) -> No Error occurred
- Response::DHL_ERROR_WEAK_WARNING (1) -> A week warning has occurred
- Response::DHL_ERROR_SERVICE_TMP_NOT_AVAILABLE (500) -> DHL-API Service is not available
- Response::DHL_ERROR_GENERAL (1000)-> General Error
- Response::DHL_ERROR_AUTH_FAILED (1001) -> Authentication has failed
- Response::DHL_ERROR_HARD_VAL_ERROR (1101) -> A hard-validation Error has occurred
- Response::DHL_ERROR_UNKNOWN_SHIPMENT_NUMBER (2000) -> Given Shipment-Number is unknown
- Returns
- int - Status-Code
Implements LabelResponse.
Definition at line 144 of file LabelData.php.
§ getStatusMessage()
| getStatusMessage | ( | ) |
Getter for Status-Message
- Returns
- string|null - Status-Message or null if not set
Implements LabelResponse.
Definition at line 189 of file LabelData.php.
§ getStatusText()
| getStatusText | ( | ) |
Getter for Status-Text
- Returns
- string|null - Status-Text or null if not set
Implements LabelResponse.
Definition at line 171 of file LabelData.php.
The documentation for this class was generated from the following file:
- includes/LabelData.php
