Checkout
extends PlatformUtility
in package
Provides different ways to access checkout data
Tags
Table of Contents
- getCurrentStep() : array<string|int, mixed>|null
- Get the current checkout step
- getCustomerDetailsData() : array<string|int, mixed>|null
- Get customer details data from checkout session
- getDeliveryData() : array<string|int, mixed>|null
- Get delivery data from checkout session
- getNextStep() : array<string|int, mixed>|null
- Get the next enabled checkout step
- getOrderId() : int|null
- Get order id from checkout session
- getOrderTrackingScript() : string|null
- Get order tracking script
- getPaymentData() : null|array<string|int, mixed>
- Get payment data from checkout session
- getPaymentError() : null|array<string|int, mixed>
- Get payment message from checkout session.
- getRepayId() : int|null
- Get repay order id from checkout session
- getStep() : array<string|int, mixed>|null
- Get a specific checkout step
- getSteps() : array<string|int, mixed>
- Get the checkout steps that match the $requestedSteps
Methods
getCurrentStep()
Get the current checkout step
public
getCurrentStep() :
array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —getCustomerDetailsData()
Get customer details data from checkout session
public
getCustomerDetailsData() :
array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —getDeliveryData()
Get delivery data from checkout session
public
getDeliveryData() :
array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —getNextStep()
Get the next enabled checkout step
public
getNextStep() :
array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —getOrderId()
Get order id from checkout session
public
getOrderId() :
int|null
Tags
Return values
int|null —getOrderTrackingScript()
Get order tracking script
public
getOrderTrackingScript(int|null $orderId[, string $affiliateType = 'general' ]) :
string|null
Parameters
- $orderId : int|null
- $affiliateType : string = 'general'
Tags
Return values
string|null —getPaymentData()
Get payment data from checkout session
public
getPaymentData() :
null|array<string|int, mixed>
Tags
Return values
null|array<string|int, mixed> —[ 'paymentMethodId' => int, 'paymentMethodCardGroupId' => int, 'paymentError' => null|array [ 'message' => string, 'orderId' => null|int, 'paymentGateway' => string, 'paymentId' => int, 'errorCode' => int ] ]
getPaymentError()
Get payment message from checkout session.
public
static
getPaymentError() :
null|array<string|int, mixed>
The payment message will be removed from the session after the first read.
Tags
Return values
null|array<string|int, mixed> —[ 'message' => string, 'orderId' => null|int, 'paymentMethodId' => int, 'paymentMethodCardGroupId' => ?int, 'errorCode' => int ]
getRepayId()
Get repay order id from checkout session
public
getRepayId() :
int|null
Tags
Return values
int|null —getStep()
Get a specific checkout step
public
getStep(string $step) :
array<string|int, mixed>|null
Parameters
- $step : string
Tags
Return values
array<string|int, mixed>|null —getSteps()
Get the checkout steps that match the $requestedSteps
public
getSteps(array<string|int, mixed> $requestedSteps) :
array<string|int, mixed>
Parameters
- $requestedSteps : array<string|int, mixed>