DHL-PHP-SDK  v0.4
A wrapper for the DHL-XML-API Version 2
ExportDocument Class Reference

Public Member Functions

 __destruct ()
 
 getInvoiceNumber ()
 
 setInvoiceNumber ($invoiceNumber)
 
 getExportType ()
 
 setExportType ($exportType)
 
 getExportTypeDescription ()
 
 setExportTypeDescription ($exportTypeDescription)
 
 getTermsOfTrade ()
 
 setTermsOfTrade ($termsOfTrade)
 
 getPlaceOfCommittal ()
 
 setPlaceOfCommittal ($placeOfCommittal)
 
 getAdditionalFee ()
 
 setAdditionalFee ($additionalFee)
 
 getPermitNumber ()
 
 setPermitNumber ($permitNumber)
 
 getAttestationNumber ()
 
 setAttestationNumber ($attestationNumber)
 
 getWithElectronicExportNotification ()
 
 setWithElectronicExportNotification ($withElectronicExportNotification)
 
 getExportDocPosition ()
 
 setExportDocPosition ($exportDocPosition)
 
 addExportDocPosition ($exportDocPosition)
 
 getExportDocumentClass_v1 ()
 
 getExportDocumentClass_v2 ()
 

Data Fields

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'
 

Detailed Description

Definition at line 24 of file ExportDocument.php.

Constructor & Destructor Documentation

§ __destruct()

__destruct ( )

Clears Memory

Definition at line 164 of file ExportDocument.php.

Member Function Documentation

§ addExportDocPosition()

addExportDocPosition (   $exportDocPosition)

Adds an ExportDocPosition-Object to the current Object

If the ExportDocPosition was null before, then it will add the entry normal (backwards compatibility) If the ExportDocPosition was an array before, it just add it to the array If the ExportDocPosition was just 1 entry before, it will converted to an array with both entries

Parameters
ExportDocPosition$exportDocPosition- Object to add

Definition at line 366 of file ExportDocument.php.

§ getAdditionalFee()

getAdditionalFee ( )

Get the additional Fee

Returns
float - Additional Fee

Definition at line 272 of file ExportDocument.php.

§ getAttestationNumber()

getAttestationNumber ( )

Get the Attestation-Number

Returns
float|int|null|string - Attestation-Number or null if none

Definition at line 308 of file ExportDocument.php.

§ getExportDocPosition()

getExportDocPosition ( )

Get the ExportDocPosition(s) class(es)

Returns
ExportDocPosition|ExportDocPosition[]|null - ExportDocPosition(s) class(es) or null if none

Definition at line 344 of file ExportDocument.php.

§ getExportDocumentClass_v1()

getExportDocumentClass_v1 ( )

Returns a Class for Export-Document

Returns
StdClass - DHL-ExportDocument-Class
Deprecated:
  • DHL-API-Version 1 Method

Definition at line 384 of file ExportDocument.php.

§ getExportDocumentClass_v2()

getExportDocumentClass_v2 ( )

Returns a Class for Export-Document

Returns
StdClass - DHL-ExportDocument-Class
Exceptions
Exception- Invalid Data-Exception

Definition at line 399 of file ExportDocument.php.

§ getExportType()

getExportType ( )

Get the Export-Type

Returns
string - Export-Type

Definition at line 200 of file ExportDocument.php.

§ getExportTypeDescription()

getExportTypeDescription ( )

Get the Export-Type-Description

Returns
null|string - Export-Type-Description or null if none

Definition at line 218 of file ExportDocument.php.

§ getInvoiceNumber()

getInvoiceNumber ( )

Get the Invoice-Number

Returns
float|int|null|string - Invoice-Number or null if none

Definition at line 182 of file ExportDocument.php.

§ getPermitNumber()

getPermitNumber ( )

Get the Permit-Number

Returns
float|int|null|string - Permit-Number or null if none

Definition at line 290 of file ExportDocument.php.

§ getPlaceOfCommittal()

getPlaceOfCommittal ( )

Get the Place of Committal

Returns
string - Place of Committal

Definition at line 254 of file ExportDocument.php.

§ getTermsOfTrade()

getTermsOfTrade ( )

Get the Terms of Trade

Returns
null|string - Terms of Trade or null if none

Definition at line 236 of file ExportDocument.php.

§ getWithElectronicExportNotification()

getWithElectronicExportNotification ( )

Get if it is with Electronic Export Notifications

Returns
bool|null - Is it with Electronic Export Notifications or null if default

Definition at line 326 of file ExportDocument.php.

§ setAdditionalFee()

setAdditionalFee (   $additionalFee)

Sets the additional Fee

Parameters
float$additionalFee- Additional Fee

Definition at line 281 of file ExportDocument.php.

§ setAttestationNumber()

setAttestationNumber (   $attestationNumber)

Set the Attestation-Number

Parameters
float | int | null | string$attestationNumber- Attestation-Number or null for none

Definition at line 317 of file ExportDocument.php.

§ setExportDocPosition()

setExportDocPosition (   $exportDocPosition)

Set the ExportDocPosition(s) class(es)

Parameters
ExportDocPosition|ExportDocPosition[]|null$exportDocPosition - ExportDocPosition(s) class(es) or null for none

Definition at line 353 of file ExportDocument.php.

§ setExportType()

setExportType (   $exportType)

Set the Export-Type

Parameters
string$exportType- Export-Type

Definition at line 209 of file ExportDocument.php.

§ setExportTypeDescription()

setExportTypeDescription (   $exportTypeDescription)

Set the Export-Type-Description

Parameters
null | string$exportTypeDescription- Export-Type-Description or null for none

Definition at line 227 of file ExportDocument.php.

§ setInvoiceNumber()

setInvoiceNumber (   $invoiceNumber)

Set the Invoice-Number

Parameters
float | int | null | string$invoiceNumber- Invoice-Number or null for none

Definition at line 191 of file ExportDocument.php.

§ setPermitNumber()

setPermitNumber (   $permitNumber)

Set the Permit-Number

Parameters
float | int | null | string$permitNumber- Permit-Number or null for none

Definition at line 299 of file ExportDocument.php.

§ setPlaceOfCommittal()

setPlaceOfCommittal (   $placeOfCommittal)

Set the Place of Committal

Parameters
string$placeOfCommittal- Place of Committal

Definition at line 263 of file ExportDocument.php.

§ setTermsOfTrade()

setTermsOfTrade (   $termsOfTrade)

Set the Terms of Trade

Parameters
null | string$termsOfTrade- Terms of Trade or null for none

Definition at line 245 of file ExportDocument.php.

§ setWithElectronicExportNotification()

setWithElectronicExportNotification (   $withElectronicExportNotification)

Set if it is with Electronic Export Notifications

Parameters
bool | null$withElectronicExportNotification- Is it with Electronic Export Notifications or null for default

Definition at line 335 of file ExportDocument.php.

Field Documentation

§ EXPORT_TYPE_COMMERCIAL_SAMPLE

const EXPORT_TYPE_COMMERCIAL_SAMPLE = 'COMMERCIAL_SAMPLE'

Definition at line 30 of file ExportDocument.php.

§ EXPORT_TYPE_DOCUMENT

const EXPORT_TYPE_DOCUMENT = 'DOCUMENT'

Definition at line 31 of file ExportDocument.php.

§ EXPORT_TYPE_OTHER

const EXPORT_TYPE_OTHER = 'OTHER'

Constants for Export-Type

Definition at line 28 of file ExportDocument.php.

§ EXPORT_TYPE_PRESENT

const EXPORT_TYPE_PRESENT = 'PRESENT'

Definition at line 29 of file ExportDocument.php.

§ EXPORT_TYPE_RETURN_OF_GOODS

const EXPORT_TYPE_RETURN_OF_GOODS = 'RETURN_OF_GOODS'

Definition at line 32 of file ExportDocument.php.

§ TERMS_OF_TRADE_DDP

const TERMS_OF_TRADE_DDP = 'DDP'

Constants for Terms of Trade

Definition at line 37 of file ExportDocument.php.

§ TERMS_OF_TRADE_DDU

const TERMS_OF_TRADE_DDU = 'DDU'

Definition at line 39 of file ExportDocument.php.

§ TERMS_OF_TRADE_DDX

const TERMS_OF_TRADE_DDX = 'DDX'

Definition at line 40 of file ExportDocument.php.

§ TERMS_OF_TRADE_DXV

const TERMS_OF_TRADE_DXV = 'DXV'

Definition at line 38 of file ExportDocument.php.


The documentation for this class was generated from the following file: