ShipEngineConfig
in package
implements
JsonSerializable
Interfaces, Classes and Traits
- JsonSerializable
Table of Contents
- DEFAULT_BASE_URI = ShipEngineUtilConstantsEndpoints::SHIPENGINE_REST_URL
- DEFAULT_PAGE_SIZE = 50
- DEFAULT_RETRIES = 1
- DEFAULT_TIMEOUT = 'PT5S'
- $apiKey : string
- $baseUrl : string
- $eventListener : mixed
- $pageSize : int
- $retries : int
- $timeout : DateInterval
- __construct() : mixed
- ShipEngineConfig constructor.
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- merge() : ShipEngineConfig
Constants
DEFAULT_BASE_URI
public
mixed
DEFAULT_BASE_URI
= ShipEngineUtilConstantsEndpoints::SHIPENGINE_REST_URL
DEFAULT_PAGE_SIZE
public
mixed
DEFAULT_PAGE_SIZE
= 50
DEFAULT_RETRIES
public
mixed
DEFAULT_RETRIES
= 1
DEFAULT_TIMEOUT
public
mixed
DEFAULT_TIMEOUT
= 'PT5S'
Properties
$apiKey
public
string
$apiKey
$baseUrl
public
string
$baseUrl
$eventListener
public
mixed
$eventListener
$pageSize
public
int
$pageSize
$retries
public
int
$retries
$timeout
public
DateInterval
$timeout
Methods
__construct()
ShipEngineConfig constructor.
public
__construct([array<string|int, mixed> $config = array() ]) : mixed
Parameters
- $config : array<string|int, mixed> = array()
-
{apiKey:string, baseUrl:string, pageSize:int, retries:int, timeout:DateInterval, eventListener:object}
Return values
mixed —jsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —merge()
public
merge([array<string|int, mixed>|null $newConfig = null ]) : ShipEngineConfig
Parameters
- $newConfig : array<string|int, mixed>|null = null