DHL-PHP-SDK  v0.4
A wrapper for the DHL-XML-API Version 2
Public Member Functions | Data Fields
Credentials Class Reference

Public Member Functions

 __construct ($testMode=false)
 
 __destruct ()
 
 getUser ()
 
 setUser ($user)
 
 getSignature ()
 
 setSignature ($signature)
 
 getEkp ($len=null)
 
 getEpk ($len=null)
 
 setEkp ($ekp)
 
 setEpk ($ekp)
 
 getApiUser ()
 
 setApiUser ($apiUser)
 
 getApiPassword ()
 
 getApiKey ()
 
 setApiPassword ($apiPassword)
 
 setApiKey ($apiKey)
 

Data Fields

const TEST_NORMAL = 'test'
 
const TEST_THERMO_PRINTER = 'thermo'
 
const DHL_BUSINESS_TEST_USER = '2222222222_01'
 
const DHL_BUSINESS_TEST_USER_THERMO = '2222222222_03'
 
const DHL_BUSINESS_TEST_USER_PASSWORD = 'pass'
 
const DHL_BUSINESS_TEST_EPK = '2222222222'
 
const DHL_BUSINESS_TEST_EKP = '2222222222'
 

Detailed Description

Definition at line 21 of file Credentials.php.

Constructor & Destructor Documentation

§ __construct()

__construct (   $testMode = false)

Credentials constructor.

If Test-Modus is true it will set Test-User, Test-Signature, Test-EKP for you!

Parameters
bool | string$testMode- Use a specific Test-Mode or Live Mode Test-Mode (Normal): Credentials::TEST_NORMAL, 'test', true Test-Mode (Thermo-Printer): Credentials::TEST_THERMO_PRINTER, 'thermo' Live (No-Test-Mode): false - default

Definition at line 129 of file Credentials.php.

§ __destruct()

__destruct ( )

Clears Memory

Definition at line 149 of file Credentials.php.

Member Function Documentation

§ getApiKey()

getApiKey ( )

Alias for $this->getApiPassword

Returns
string - API-Password/Key

Definition at line 271 of file Credentials.php.

§ getApiPassword()

getApiPassword ( )

Get the API-Password/Key

Returns
string - API-Password/Key

Definition at line 262 of file Credentials.php.

§ getApiUser()

getApiUser ( )

Get the API-User

Returns
string - API-User

Definition at line 244 of file Credentials.php.

§ getEkp()

getEkp (   $len = null)

Get the (x first Digits of the) EKP

Parameters
null | int$len- Max-Chars to get from this String or null for all
Returns
string - EKP-Number with x Chars

Definition at line 199 of file Credentials.php.

§ getEpk()

getEpk (   $len = null)

Alias for $this->getEkp

Parameters
null | int$len- Max-Chars to get from this String or null for all
Returns
string - EKP-Number with x Chars
Deprecated:
  • Invalid name of the function

Definition at line 211 of file Credentials.php.

§ getSignature()

getSignature ( )

Get the DHL-Intraship Password

Returns
string - DHL-Intraship Password

Definition at line 180 of file Credentials.php.

§ getUser()

getUser ( )

Get the DHL-Intraship Username

Returns
string - DHL-Intraship Username

Definition at line 162 of file Credentials.php.

§ setApiKey()

setApiKey (   $apiKey)

Alias for $this->setApiPassword

Parameters
string$apiKey- API-Password/Key

Definition at line 289 of file Credentials.php.

§ setApiPassword()

setApiPassword (   $apiPassword)

Set the API-Password/Key

Parameters
string$apiPassword- API-Password/Key

Definition at line 280 of file Credentials.php.

§ setApiUser()

setApiUser (   $apiUser)

Set the API-User

Parameters
string$apiUser- API-User

Definition at line 253 of file Credentials.php.

§ setEkp()

setEkp (   $ekp)

Set the EKP-Number

Parameters
string$ekp- EKP-Number

Definition at line 222 of file Credentials.php.

§ setEpk()

setEpk (   $ekp)

Alias for $this->setEkp

Parameters
string$ekp- EKP-Number
Deprecated:
  • Invalid name of the function

Definition at line 233 of file Credentials.php.

§ setSignature()

setSignature (   $signature)

Set the DHL-Intraship Password

Parameters
string$signature- DHL-Intraship Password

Definition at line 189 of file Credentials.php.

§ setUser()

setUser (   $user)

Sets the DHL-Intraship Username in lower case

Parameters
string$user- DHL-Intraship Username

Definition at line 171 of file Credentials.php.

Field Documentation

§ DHL_BUSINESS_TEST_EKP

const DHL_BUSINESS_TEST_EKP = '2222222222'

DHL Business-API Test-EKP

Definition at line 59 of file Credentials.php.

§ DHL_BUSINESS_TEST_EPK

const DHL_BUSINESS_TEST_EPK = '2222222222'

DHL Business-API Test-EKP

Deprecated:
  • Typo in name...

Definition at line 54 of file Credentials.php.

§ DHL_BUSINESS_TEST_USER

const DHL_BUSINESS_TEST_USER = '2222222222_01'

DHL Business-API Test-User (Normal)

Definition at line 37 of file Credentials.php.

§ DHL_BUSINESS_TEST_USER_PASSWORD

const DHL_BUSINESS_TEST_USER_PASSWORD = 'pass'

DHL Business-API Test-User-Password

Definition at line 47 of file Credentials.php.

§ DHL_BUSINESS_TEST_USER_THERMO

const DHL_BUSINESS_TEST_USER_THERMO = '2222222222_03'

DHL Business-API Test-User (Thermo)

Definition at line 42 of file Credentials.php.

§ TEST_NORMAL

const TEST_NORMAL = 'test'

DHL-Test-Mode (Normal)

Definition at line 26 of file Credentials.php.

§ TEST_THERMO_PRINTER

const TEST_THERMO_PRINTER = 'thermo'

DHL-Test-Mode (Thermo-Printer)

Definition at line 31 of file Credentials.php.

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