HubCallbackHandlerInterface
in
Interface HubCallbackHandlerInterface
Table of Contents
- proceedClientKeyCallback() : array<string|int, mixed>
- Stores the hub client key and the shop key, sends a http response code header and returns a json response array.
- proceedCreateOrderStatusCallback() : array<string|int, mixed>
- Inserts a new order status name, sends a http response code header and returns a json response array.
- proceedGetConfiguration() : array<string|int, mixed>
- Reads from gm_configuration with given key, sends a http response code header and returns a json response array.
- proceedSessionKeyCallback() : array<string|int, mixed>
- Stores the hub session key, sends a http response code header and returns a json response array.
- proceedUpdateConfiguration() : array<string|int, mixed>
- Inserts into gm_configuration or updates gm_configuration with given key and value, sends a http response code header and returns a json response array.
- proceedUpdateOrderStatusCallback() : array<string|int, mixed>
- Updates the status of an order, sends a http response code header and returns a json response array.
Methods
proceedClientKeyCallback()
Stores the hub client key and the shop key, sends a http response code header and returns a json response array.
public
proceedClientKeyCallback(string $authHash, string $clientKey, string $shopKey) : array<string|int, mixed>
Parameters
- $authHash : string
- $clientKey : string
- $shopKey : string
Return values
array<string|int, mixed> —Json Response Array
proceedCreateOrderStatusCallback()
Inserts a new order status name, sends a http response code header and returns a json response array.
public
proceedCreateOrderStatusCallback(string $clientKey, array<string|int, mixed> $orderStatusArray) : array<string|int, mixed>
Parameters
- $clientKey : string
-
Client key.
- $orderStatusArray : array<string|int, mixed>
-
Order status array.
Return values
array<string|int, mixed> —Json Response Array
proceedGetConfiguration()
Reads from gm_configuration with given key, sends a http response code header and returns a json response array.
public
proceedGetConfiguration(string $clientKey, string $configurationKey) : array<string|int, mixed>
Parameters
- $clientKey : string
-
HubClientKey
- $configurationKey : string
-
Determines which gm_configuration key should be retrieved
Return values
array<string|int, mixed> —Json Response Array
proceedSessionKeyCallback()
Stores the hub session key, sends a http response code header and returns a json response array.
public
proceedSessionKeyCallback(string $authHash, string $sessionKey) : array<string|int, mixed>
Parameters
- $authHash : string
- $sessionKey : string
Return values
array<string|int, mixed> —Json Response Array
proceedUpdateConfiguration()
Inserts into gm_configuration or updates gm_configuration with given key and value, sends a http response code header and returns a json response array.
public
proceedUpdateConfiguration(string $configurationKey, string $configurationValue, string $clientKey) : array<string|int, mixed>
Parameters
- $configurationKey : string
-
Determines which gm_configuration key should be updated
- $configurationValue : string
-
Determines to which value the key should be set
- $clientKey : string
-
HubClientKey
Return values
array<string|int, mixed> —Json Response Array
proceedUpdateOrderStatusCallback()
Updates the status of an order, sends a http response code header and returns a json response array.
public
proceedUpdateOrderStatusCallback(string $clientKey, int $orderId, int $orderStatusId) : array<string|int, mixed>
Parameters
- $clientKey : string
-
Client key.
- $orderId : int
-
Order Id.
- $orderStatusId : int
-
Order status Id.
Return values
array<string|int, mixed> —Json Response Array