Skip to content

Latest commit

 

History

History
executable file
·
188 lines (146 loc) · 3.04 KB

definitions.md

File metadata and controls

executable file
·
188 lines (146 loc) · 3.04 KB
Raw

Definitons

The module contains several helper classes that contain most of the constants needed to work with the Balikobot API.

There are classes for country codes, currency codes, package options, shipper codes and service types:

use Inspirum\Balikobot\Definitions\Shipper;

var_dump(Shipper::CP);
/*
'cp'
*/

var_dump(Shipper::TOPTRANS);
/*
'toptrans'
*/
use Inspirum\Balikobot\Definitions\ServiceType;

var_dump(ServiceType::DHL_EXPRESS_WORLDWIDE_12);
/*
'4'
*/

var_dump(ServiceType::CP_NP);
/*
'NP'
*/

var_dump(ServiceType::DPD_PRIVATE_SATURDAY);
/*
'8'
*/
use Inspirum\Balikobot\Definitions\Option;

var_dump(Option::REAL_ORDER_ID);
/*
'real_order_id'
*/

var_dump(Option::REC_NAME);
/*
'rec_name'
*/
use Inspirum\Balikobot\Definitions\Country;

var_dump(Country::AUSTRIA);
/*
'AT'
*/
use Inspirum\Balikobot\Definitions\Currency;

var_dump(Currency::PLN);
/*
'PLN'
*/

These classes also contain static methods for accessing all constants for given type.

use Inspirum\Balikobot\Definitions\Shipper;

$shippers = Shipper::all();

/*
var_dump($shippers);
[
  0  => 'cp'
  1  => 'dhl'
  2  => 'dhlsk'
  3  => 'dpd'
  4  => 'geis'
  5  => 'gls'
  6  => 'intime'
  7  => 'pbh'
  8  => 'ppl'
  9  => 'sp'
  10 => 'toptrans'
  11 => 'ulozenka'
  12 => 'ups'
  13 => 'zasilkovna'
  14 => 'tnt'
]
*/
use Inspirum\Balikobot\Definitions\ServiceType;

$services = ServiceType::all();

/*
var_dump($services);
[
  'cp' => [
    0 => 'DR'
    1 => 'RR'
    2 => 'NP'
    3 => 'DV'
    4 => 'VL'
    ...
  ]
  'dpd' => [
    0 => '1'
    1 => '2'
    ...
  ]
  ...
]
*/
use Inspirum\Balikobot\Definitions\ServiceType;

$services = ServiceType::topTrans();

/*
var_dump($services);
[
  0 => '1'
  1 => '2'
  2 => '3'
  3 => '4'
  4 => '5'
  5 => '6'
]
*/

Other, less used available methods:

use Inspirum\Balikobot\Definitions\Country;
use Inspirum\Balikobot\Definitions\Currency;
use Inspirum\Balikobot\Definitions\ServiceType;
use Inspirum\Balikobot\Definitions\Shipper;

Country::all();
Country::validateCode('CZE');
Currency::all();
Currency::validateCode('RUB');
Shipper::validateCode('dpd');
Shipper::hasFullBranchesSupport('cp', 'NP');
ServiceType::cp();
ServiceType::intime();

// and more ...

More usage

Client

Support all options for Balikobot API described in given documentation.

Balikobot

Extension over Client that uses custom DTO classes as an input and output for its methods.